TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference

TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
TIBCO ActiveMatrix BusinessWorks™ Express
Palette Reference
Software Release 1.0.0
November 2013
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.
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 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.
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 © 2010-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
3
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Changing Help Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
File Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Copy File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Create File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
File Poller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
List Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Read File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Remove File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Wait for File Change . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Write File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
FTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
FTP Change Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
FTP Delete File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
FTP Dir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
FTP Get . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
FTP Get Default Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
FTP Make Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
FTP Put . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
FTP Quote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
FTP Remove Remote Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
FTP Rename File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
FTP SYS Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
General Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Call Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Checkpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
External Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Get Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Milestone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
On Notification Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Receive Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
4
Set Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Wait . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
HTTP Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
SSL Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
HTTP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
SSL Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
HTTP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Send HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Sending Data in the HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Send HTTP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Wait for HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
JAVA Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Java Global Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Java Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Java Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Java Process Starter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Java To XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
XML To Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
JDBC Call Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
JDBC Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
JDBC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
SQL Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
Get JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
JMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
JMS Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Receive JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Send JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Reply to JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Wait for JMS Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Mail Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
SMTP Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Receive Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Send Mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
5
Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Parsing a Large Number of Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Parse Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Render Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
REST and JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Parse JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Render JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
TCP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Using the TCP Palette Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
TCP Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Read TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
TCP Close Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
TCP Open Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
TCP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Wait for TCP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Write TCP Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
XML Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Parse XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Render XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Transform XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
6
Figures
Parsing a Text String into a Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
7
TIBCO Documentation and Support Services
All TIBCO documentation is available in the TIBCO Documentation Library, which can be found here:
https://docs.tibco.com
Product-Specific Documentation
The following documents for this product can be found in the TIBCO Documentation Library:
●
Concepts
●
Installation
●
Application Development
●
Administration
●
Palette Reference
●
Getting Started
●
Samples
The following documents provide additional information and can found in the TIBCO Documentation
Library:
●
TIBCO Enterprise Administrator User's Guide
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact TIBCO Support as
follows:
●
For an overview of TIBCO Support, and information about getting started with TIBCO Support,
visit this site:
http://www.tibco.com/services/support
●
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you can
request one.
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a
place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers
forums, blogs, and access to a variety of resources. To register, go to:
http://www.tibcommunity.com
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
8
Changing Help Preferences
By default, in TIBCO Business Studio online help is accessed online from docs.tibco.com. If you can't
connect to the Internet when using TIBCO Business Studio, use a computer that has Internet access to
download the documentation and then enable local access to the documentation. Local access is
preferred if your network connection is slow to respond to page requests from docs.tibco.com.
This procedure explains how to change your help preferences in TIBCO Business Studio to access help
from a local directory on your machine or from an internal web server, if you have placed the
documents under it.
Prerequisites
Before changing help preferences you must download the documentation from https://docs.tibco.com/.
1. Click https://docs.tibco.com/.
2. In the search field, type ActiveMatrix
BusinessWorks Express
and press return.
3. Select the product from the list.
4. Scroll to the bottom of the page and click the Download All button.
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 then unzip the file.
Procedure
1. In TIBCO Business Studio, click Window > Preferences.
2. In the Preferences dialog, click BusinessWorks > Help.
3. Select Custom Location and click Browse to select the directory where you unzipped the
documentation, or provide the URL to your internal web server.
4. Click Apply and then click OK.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
9
File Palette
The File palette is used to read, write, delete, or create files. This palette also has a process starter that
allows you to poll for files and start a process based on the available file.
Copy File
The Copy File activity allows you to copy files and directories to a new location.
General
Literal Value/
Process
Property/
Module
Property
Description
Name
Process
Property
The name to be displayed as label of the activity in the
process.
From Filename
Process
Property
The path and name of the file or directory to copy.
Field
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.
Wildcard characters cannot be used in this element.
Overwrite
Process
Property
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
Process
Property
When this check box is selected, the activity creates all
directories in the specified path, if they do not already exist.
If this field is not selected with non-existing one or more
directories in the specified path, it throws an exception.
Include SubDirectories
Process
Property
Select this check box to monitor the events occurring in the
subdirectories of the specified directory.
If this check box is not selected, only the directory is
monitored. The subdirectories are ignored.
Description
Provide a short description for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
10
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:
●
●
To copy a directory, specify c:\myDirectory.
To copy all text files in a directory, specify c:
\myDirectory\*.txt.
toFilename
string
The destination for the copy operation. This must be an
absolute path and wildcards cannot be used in this
element.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
checkbox 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, the fromFileName is a
directory and the toFileName is a file.
FileAlreadyExistsException
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.
Create File
The Create File activity creates a new file or directory with the specified name. When creating a file,
you can also provide the file contents.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
11
Field
Literal
Value/
Process
Property/
Module
Property?
Name
No
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
No
Overwrites the existing file with the same name, if it exists.
The activity throws an exception, if the specified file exists
and this checkbox is not selected.
Is a Directory
No
When this check box is selected, the activity creates a
directory instead of a file.
Create NonExisting Directories
No
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.
Input Item
Datatype
Description
fileName
string
The path and name of the file to create.
Select the Is a Directory field 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
Element containing the fileName, location, type, readProtected,
writeProtected, and size data.
fullName
string
The name of the file or directory, including the path information.
fileName
string
The name of the file or directory without the path information.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
12
Output Item
Datatype
Description
location
string
The path to the file or directory.
configuredFileNa
me?
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
FileAlreadyExistsException
File already exists at the destination, where you are
attempting to copy the file and 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.
File Poller
The File Poller process starter polls for files or directories with the specified name and starts a process,
when the specified 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
13
Field
Literal
Value/
Process
Property/
Module
Property?
Description
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
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 start.
●
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.
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 will be executed sequentially in the order the process
instance was created.
Custome Job Id
This field can contain an XPath expression that specifies a custom ID for
the process instance.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
14
Field
Description
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.
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 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, you must specify Max Jobs = 1 and
enable the Activatation Limit field when you deploy your
project.
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
multiple conversartions.
button to initiate
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
15
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
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
Whether the file is read-protected.
writeProtected
boolean
Whether the file is write-protected.
size
integer
The size of the file in bytes.
lastModified
string
Time stamp indicating when the file was last modified.
fileContent
complex
Element containing the textContent and binaryContent data.
textContent
string
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.
encoding
string
The character encoding for the file.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
16
List Files
The List Files activity 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 directory with files or subdirectories to
list.
Mode
None
The type of listing you want to retrieve. You can select from the
following options:
Description
●
Only Files
●
Only Directories
●
Files and Directories
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 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
17
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.
configuredFileN
ame
string
The path to the file.
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 time stamp indicating when the file was last modified. You
can compare values in this element using the compare-dateTime()
XPath function. For example, compare-dateTime($List-Files/
ListFilesActivityOutput/files/
fileInfo[fileName="myFile.txt"]/lastModified,currentdateTime())
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
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 used to read a file and place its contents into the activity's output.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
18
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 this activity's
output.
If selected, the contents of this file are not available to the
subsequant activities in the process.
Read as
Literal Value
This field is available only if 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.
Output
The following is the output of the activity.
Output Item
Datatyp
e
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.
Description
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
19
Output Item
Datatyp
e
Description
location
string
The path to the file.
configuredFile
Name
string
Optional element. It is not populated by this activity.
type
string
The file type.
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
Time stamp 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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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.
Remove File
The Remove File activity 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™ Express Palette Reference
20
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
Optional element. This element is not populated by this activity.
type
string
The file type.
readProtected
boolean
Specifies whether the file (or empty directory) is read-protected.
writeProtected
boolean
Specifies whether the file (or empty directory) is write-protected.
size
integer
The size of file in bytes.
lastModified
string
The time stamp indicating when the file was last modified.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
21
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
FileIOException
An Input/Output exception occurrs, when trying to
remove the file or empty directory.
Rename File
The Rename File activity 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
Literal Value
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
Literal Value
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
22
Input
The following is the input for the activity.
Input Item
Datatype
Description
fromFileNa
me
string
The path and name of the file to rename or move, or the path and
name of the directory to rename.
The value in this element must be an absolute path.
toFileName
string
The new name and location of the file or directory. 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, and size data.
fullName
string
The name of the file (or directory) including the path information.
fileName
string
The name of the file (or directory) without the path information.
location
string
The path to the file or the directory.
configuredFile
Name
string
Optional element. This element is not populated by this activity.
type
string
The file type.
readProtected
boolean
Specifies whether the file is read-protected.
writeProtected
boolean
Specifies whether the file is write-protected.
size
integer
The size of 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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
23
Fault
Thrown When..
IllegalRenameException
The destination file exists and its type is different than the
type of the source file.
FileAlreadyExistsException
The file already exists.
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 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
Polling interval (in seconds) to verify the changes in the specified
file.
Include
Existing Files
None
Select this checkbox to check the file among the files that existed
prior to the start of process engine running.
●
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
24
Field
Exclude File
Content
Literal Value/
Process
Property/
Module
Property?
None
Description
Specifies not to load the data from the file into this activity’s
output.
If this field is selected, the contents of the file are not available to
the subsequent activities in the process.
Content as
Process
Property
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 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 join the Conversation here. Click the Join Existing Conversation
conversartions.
button to join multiple
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
Output
The following is the output for this activity.
Output Item
Datatype
Description
fullName
string
The name of the file, including the path information.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
25
Output Item
Datatype
Description
fileName
string
The file name without the path information.
location
string
The path to the file.
configuredFileNa
me
string
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 time stamp 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 was not selected on the General tab.
binaryContent
binary
Contents of the file (binary files), if the Exclude File
Contents check box was 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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
The timeout is attained.
Write File
The Write File activity writes content to the specified file.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
26
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
checkbox overwrites the file.
Write as
Process
Property
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).
addLineSeparat
or
boolean
This specifies whether to add a carriage return after each input
line.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
27
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
the 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.
configuredFileN
ame
string
Optional element. This element is not populated by this activity.
type
string
The file type.
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 time stamp indicating when the file was last modified.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
FileNotFoundException
The file does not exist.
UnsupportedEncodingExcepti
The encoding is not valid.
on
FileIOException
An Input/Output exception occurrs when trying to write to the
file.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
28
FTP Palette
The FTP palette is used to issue FTP commands.
FTP Change Default Directory
The FTP Change Default Directory activity 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
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.
This allows all the FTP activities that specify the same FTP session
(that is, the same host, port, username, and password), to 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
Name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
Port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
Username
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
29
Input Item
Datatype
Description
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
NewDefaultDi
r
string
Path to the new default directory on the FTP server.
Timeout
integer
The amount of time to wait for the FTP server to respond. This
timeout is used, when the FTP server places the FTP connection
used by this activity into a waiting state.
This overrides the value specified in the FTP Connection property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
The FTP Delete File activity issues an FTP delete or mdelete command to delete one or more files from
the remote server.
General
Field
Literal
Value/
Module
Property?
Description
Name
None
Name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
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.
This allows all the FTP activities that specify the same FTP session
(that is, the same host, port, username, and password), to share the
FTP session until the connection is closed.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
30
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
Name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
Port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
RemoteDirecto
ry
string
Optional element. Path to the directory containing the file(s) to be
deleted.
This element is concatenated with the RemoteFileName element to
provide the complete path to the file(s) to be deleted.
RemoteFileNa
me
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occured when executing the FTP command.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
31
Fault
Thrown When..
ConnectionErrorException
An error occured when connecting to the FTP server.
FTP Dir
The FTP Dir activity 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
Name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
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.
This allows all the FTP activities that specify the same FTP session
(that is, the same host, port, username, and password), to share the
FTP session until the connection is closed.
NLST
None
When selected, 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 filenames.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
Host
string
Name of the FTP server.
This overrides the value specified in the FTP Connection property.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
32
Input Item
Datatype
Description
Port
integer
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
DirParamete
rs
string
The command parameters to pass to the DIR or NLST command.
Directory
string
Optional parameter. 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 for the activity.
Output Item
Datatype
Description
ItemCount
integer
The number of entries returned from the remote directory listing.
DirectoryIte
ms
string
A repeating element containing the list of items returned.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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 Get
The FTP Get activity issues an FTP get or mget command to the specified server. The content of the
remote files can be placed in the activity’s output or written directly to the local storage. If you select to
place the contents of a remote file into the activity’s output, you can only retrieve one remote file (FTP
get command) and the file’s content will be stored in memory as part of the activity’s output. If you
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
33
select to write the contents of the retrieved files to 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?
Description
Name
None
Name to be displayed as the label for the activity in the process.
FTP
Connection
Yes
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.
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 activity’s output includes an element that contains the remote
file’s contents, and the data can be used by subsequent activities in
the process.
Caution: Do not use this option if you are retrieving multiple files.
You can only write one files's contents to this activity’s output.
Selecting this check box with wildcards specified in the
RemoteFileName input element, returns an error.
Binary
None
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
34
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
RemoteFileNa
me
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 the 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.
Host
string
Name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
Port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
Username
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTO 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
35
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP server to respond.
This timeout is used when the FTP server places the FTP connection
used by this activity into a waiting state.
Output
The following is the output for this activity.
Output
Item
FileTransfe
rred
Datatype
Description
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 occurrs 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
Name of the retrieved remote file.
NumOfByt
es
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
The FTP Get Default Directory activity retrieves the name of the current remote directory. The default
remote directory is operating system dependent and determined by the remote FTP server. On UNIX
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
36
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
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.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
Port number for incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
37
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP server to respond.
This timeout is used when the FTP server places the FTP connection
used by this activity into a waiting state.
This overrides the value specified in the FTP Connection property.
Output
The following is the output for the activity.
Output Item
Datatype
Description
CurrentDirecto
ry
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
The FTP Make Remote Directory activity creates the specified directory on the remote server.
General
The General tab consists of 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
Path to the shared configuration resource containing the user
information such as host name, username, and password.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
38
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 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.
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection
property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
RemoteSITECo
mmand
string
Optional element. This is a system-specific command to execute
before creating the directory.
ParentRemoteD
irectory
string
Optional element. Path to the remote directory to create.
RemoteDirNam
e
string
This element is concatenated with the RemoteDirName element
to provide the complete path to the directory to create.
Name of the remote directory to create.
You can optionally include the complete path of the directory to
create.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
39
Input Item
Datatype
Description
Timeout
integer
The amount of time to wait for the FTP server to respond.
This timeout is used when the FTP server places the FTP
connection used by this activity into a waiting state.
This overrides the value specified in the FTP Connection
property.
Output
This activity produces no output.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective actions to take.
Fault
Thrown When..
CommandExecutionException
An error occured when executing the FTP command.
ConnectionErrorException
An error occured when connecting to the FTP server.
FTP Put
The FTP Put activity 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
The name to be displayed as the label for the activity in the
process.
FTP Connection
Yes
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
40
Field
Use Process
Data
Literal
Value/
Module
Property/
Process
Property?
None
Description
Specifies to use 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 check box is available only when the Overwrite Existing
File check box is not selected.
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.
Description
Provide a short description for the activity.
Input
The following is the input for the activity.
Input Item
Datatype
Description
RemoteFileNa
me
string
The path and name of the file to place onto the remote server.
Wildcards are not permitted in this field.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
41
Input Item
Datatype
Description
LocalFileNam
e
string
The path and name of the local file to use in the FTP Put command.
Host
string
This element is available only if the Use Process Data field is not
selected.
The name of the FTP server.
This overrides the value specified in the FTP Connection property.
Port
integer
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
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.
Output
Item
FileTransfe
rred
Datatype
Description
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 occurred 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
Name of the retrieved remote file.
NumOfByt
es
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective actions to take.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
42
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
The FTP Quote activity sends an arbitrary command to the FTP server. FTP commands vary by
operating system, FTP version, and configuration. Before using this activity, check for the availabilty 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
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
43
Input Item
Datatype
Description
Host
string
The name of the FTP server.
This overrides the value specified in the FTP Connection
property.
Port
integer
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection
property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
Password for logging into the FTP Server.
This overrides the value specified in the FTP Connection
property.
RemoteSITECom
mand
string
Optional. System-specific command to be executed before the
executing the specified command.
ValidReturnCod
es
string
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.
RemoteComman
d
string
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
CommandItem
s
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective actions to take.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
44
Fault
Thrown When..
CommandExecutionExceptio
An error occurred when executing the FTP command.
n
ConnectionErrorException
An error occurred when connecting to the FTP server.
FTP Remove Remote Directory
The FTP Remove Remote Directory deletes the specified directory from 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
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.
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
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection
property.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
45
Input Item
Datatype
Description
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
ParentRemoteDi
rectory
string
Optional element. 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.
RemoteDirNam
e
string
Timeout
integer
Name of the remote directory you want to remove.
You can optionally include the complete path of the directory to
remove.
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
The FTP Rename File renames the specified file on the remote FTP server.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
46
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
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. 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
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection
property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
Password
string
Password for logging into the FTP server.
This overrides the value specified in the FTP Connection
property.
OldRemoteDirec
tory
string
Optional element. 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
47
Input Item
Datatype
Description
OldRemoteFileN
ame
string
Name of the remote file you want to rename.
NewRemoteDire
ctory
string
NewRemoteFile
Name
string
Timeout
integer
You can optionally include the complete path of the file to
rename.
Optional element. 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.
New name for the remote file.
You can optionally include the complete path of the file.
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and 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
The FTP Sys Type activity 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
48
Field
Literal
Value/
Module
Property/
Process
Property?
Description
FTP
Connection
Yes
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.
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
Port number for the incoming FTP requests on the FTP server.
This overrides the value specified in the FTP Connection property.
UserName
string
Username for logging into the FTP server.
This overrides the value specified in the FTP Connection property.
Password
string
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
49
Output Item
Datatype
Description
SystemType
string
The FTP server type.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
CommandExecutionExcepti
An error occurred when executing the FTP command.
on
ConnectionErrorExceptio
An error occurred when connecting to the FTP server.
n
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
50
General Activities
The 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
The Assign activity allows you to assign a value to a process-defined variable. When the Assign activity
is executed, the entire schema for the selected process variable is replaced with the specified values.
Elements with no value specified in the Input tab, are set to null. 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
This activity produces no output.
Call Process
The Call Process activity calls and executes an existing 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
51
Field
Description
Service
The endpoint of the service.
You can either use concrete WSDL resources with port bindings or you can
specify local service resources with Local specified in the endpoint
binding.
Description
Provide a short description for the activity.
Conversations
Conversations are initialized at the activity or process level. For a successful evaluation, the correlations
keys must either match the activity message input/output or process data (Correlation ID). You can
configure the Correlation Key:
●
based on the variables or messages
●
based on the process data
Add the Correlation Key to a conversation at the process level or activity level. To attach a conversation
to an activity, atleast one correlation key must match the correlation ID (activity message input/output
or process data).
Input
This activity has no input.
Output
This activity has no output.
Checkpoint
The Checkpoint activity 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, if it fails due to an unhandled exception or manual termination.
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™ Express Palette Reference
52
Confirm
The Confirm activity 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.
Important: It is recommended not to use the Confirm Activity with in the Service Resource process.
The new message will still flow on that thread eventhough the TIBCO BusinessWorks process
execution continues for the previous message.
Description
Provide a short description for the activity.
External Command
Use the External Command activity to execute the command on the operating system. This activity
waits for the command to complete before transitioning 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
Description
The name to be displayed as a label for the activity in a
process.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
53
Field
Command To
Execute
Literal Value/
Process
Property/
Module
Property?
Description
None
The command line to execute. You can also specify any
input and command-line arguments to the command in
this field.
You cannot specify more than one command by piping
output from one command to another (for example, ls |
more is not allowed).
Provide
Command
Output
Process Property
Selecting this checkbox specifies that the output sent to the
standard output and standard error by command is
available in the output schema of this activity.
Caution: Do not select for the commands that produce a
large amount of output. Instead, write the output to a file.
This saves memory and allows you to use other activities,
such as Read File and Parse Data, to handle the output file
more efficiently.
Remove
Parameter Quotes
Process Property
If this checkbox is selected, the quotes surrounding the
parameters are removed. The quotes are removed even if
the parameter contains space(s).
Be default, this checkbox is not selected.
Output Filename
Process Property
Name and location of the file for storing any output or
errors produced by the command. If this field is blank, no
output file is created.
Output Line
Splitting
Process Property
Controls whether the command output and errors are split
into multiple strings.
Select from the following available options:
●
None — The activity produces a single string
containing the command’s output or errors. This string
includes line end characters.
●
At Operating System Line End — The activity
produces a repeating string element with one string
element per output line. The lines are split by default on
the carriage return/line feed character, depending on
the operating system. The line end characters are not
included in the output.
●
At Specified Token — The lines are split wherever the
specified token occurs. The token is specified as an
activity input element, and the token is not included in
the output.
Description
Provide a short description of the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
54
Input
The following is input for this activity.
Input Item
Datatype
Description
command
string
The command to execute, including any input or command-line
arguments.
Specifying this input item overrides the command specified on the
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 in input without specifying
a carriage return.
outputFile
string
The file containing the output produced by the command for sending
it to stdout.
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.
workingDire
ctory
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
55
Output Item
Datatype
Description
output
string
Any output produced by the command and sent to stdout. This
output item is available only when the Provide Command
Output checkbox is selected 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 the Provide Command Output
checkbox is selected 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.
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 BW 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
The Get Shared Variable activity retrieves the current value of a Module Shared Variable or Job Shared
Variable resource. For using this activity to retrieve the value of a Shared Variable resource, use a
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.
Inline
Specify the type of shared variable (Module Shared Variable or Job Shared
Variable).
Shared Variable
The Module Shared Variable or Job Shared Variable whose value you want
to retrieve.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
56
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.
Log
This activity writes a message to the log. For each process engine there is one log file.
General
The General 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 logger-name is casesensitive 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 - to log error conditions and messages.
●
Warning - for warning message of an unexpected error in the process.
●
Info - to log informational messages highlighting the application/engine
progress.
●
Debug - for debug-level messages.
If selected, no additional information is added to the log entry.
If not selected, each log message prepends job number, process name, and
activity name to the message text.
Description
Provide a short description of the activity.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
57
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
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.
Output
This activity produces no output.
Mapper
The Mapper activity adds a new process variable to the process. This process 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 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 Input Editor tab.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
58
Milestone
The Milestone activity is used to define a point in a process, where a defined milestone must be
readched to enable a specific activity. Achieving the milestone executes the activity. However, not
meeting the milestone stalls the process themilestone is reached.
General
The General tab has the following field.
Field
Description
Name
The name of the milestone appearing as label in the process.
Description
Provide a short description for the activity.
Notify
The Notify activity allows a process instance to send data to a corresponding process instance
containing a Wait activity or Receive Notification process starter. The Shared Configuration resource
and the key specified on the General tab, create the relationship between the Notify activity and the
corresponding Wait or Receive Notification.
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.
Key
The key that coordinates a Notify activity with the corresponding Wait or
Receive Notification.
Timeout
The timeout (number of milliseconds) to keep the information for this Notify
activity.
Shared
Configuration
The notifyConfigurationProperty shared configuration resource, that defines a
data schema for this activity.
The Notify 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
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
59
Input Item
Datatype
Description
key
string
The key that coordinates a Notify activity with the corresponding
Wait or Receive Notification.
For example, in a transaction handling process, the transaction ID
might be the key that Wait and Notify use to determine which Wait
activity corresponds to the Notify activity.
The key can be an XPath expression, but it must evaluate to a string.
timeout
integer
The timeout (number of milliseconds) to keep the information for this
Notify activity. The activity executes immediately and transitions to
the next activity, but the engine retains the Notify information till a
corresponding Receive Notification or Wait occurs.
The Notify information is removed, if the corresponding activity
does not occur before this timeout is reached.
Output
This activity produces no output.
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 Notify Timeout process for a specific Shared Configuration. The process with
the On Notification Timeout process starter executes, when a Notify activity with a matching Shared
Configuration undergoes a timeout. You can specify one or more On Notify Timeout processes for
specific Shared Configurations.
Do not create more than one process for the same Shared Configuration. If a Notify activity experiences
a timeout of its stored notification information, that timeout can only apply to one On Notification
Timeout process.
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 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.
Any Notify Config
Specify for the process starter to execute, when any Notify activity
experiences a timeout, and there is no On Notify Timeout process specified
for the Shared Configuration for the activity.
Selecting this checkbox disables the Shared Configuration field.
Do not select this checkbox, if you want to specify a process for a specific
Shared Configuration.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
60
Field
Description
Shared
Configuration
This field is enabled only when the Any Notify Config checkbox 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. That is, you cannot create multiple processes using the same
Shared Configuration.
Description
Provide a short description for 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.
Conversations
Conversations are initialized at the activity or process level. For a successful evaluation, the correlations
keys must either match the activity message input/output or process data (Correlation ID). You can
configure the Correlation Key:
●
based on the variables or messages
●
based on the process data
Add the Correlation Key to a conversation at the process level or activity level. To attach a conversation
to an activity, atleast one correlation key must match the correlation ID (activity message input/output
or process data).
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
61
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 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 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.
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.
The Shared Configuration resource is required, but the schema can be empty
if you do not want to pass data between processes.
Key
The key that coordinates a Receive Notification process starter with the
corresponding Notify activity.
For example, in an transaction process, the transaction ID might be the key
that Receive Notification uses to determine which Notify activity corresponds
to this process starter.
The key must be a fixed string. You may use global variables, but XPath
expressions cannot be used.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
62
Conversations
Conversations are initialized at the activity or process level. For a successful evaluation, the correlations
keys must either match the activity message input/output or process data (Correlation ID). You can
configure the Correlation Key:
●
based on the variables or messages
●
based on the process data
Add the Correlation Key to a conversation at the process level or activity level. To attach a conversation
to an activity, atleast one correlation key must match the correlation ID (activity message input/output
or process data).
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.
Set Shared Variable
The Set Shared Variable activity allows you 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.
Inline
Specify the type of shared variable (Module Shared Variable or Job Shared
Variable).
Shared Variable
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
63
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
The Sleep activity 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.
Input
The following is the input for the activity.
Input Item
Datatype
Description
IntervalInMilli
sec
integer
The amount of time interval, in milliseconds, to suspend the
current branch of the process.
Timer
The Timer is a process starter activity that starts a process at a specific time. You can also specify the
processes to be started periodically.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
64
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
Process
Property
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
Run Once
None
Indicates this process should be run only once at the day and time
indicated by the Start Time field.
Not selecting this checkbox displays the Time Interval and
Interval Unit fields that allow you to specify the frequency of the
process.
Time
Interval
Process
Property
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 global variable in this field, specifies the time
interval in milliseconds and the Interval Unit field is
not displayed.
Interval Unit
None
Unit of time to use with the Time Interval field to determine how
often to start a new process. The units can be: Millisecond,
Second, Minute, Hour, Day, Week, Month, Year.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
65
Field
Literal Value/
Module
Property/
Process
Property?
End After
None
Description
Specify the number of occurences or the end time here. Select
from the following available options:
●
Never - Click the Never radio button if you want 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 will execute every 5 seconds
●
Occurences - Clicking the Occurrences radio button displays
the Occurences field. Specify the number of occurences of the
process instance execution.
●
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.
Description
Provide a sshort 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.
Conversations
Conversations are initialized at the activity or process level. For a successful evaluation, the correlations
keys must either match the activity message input/output or process data (Correlation ID). You can
configure the Correlation Key:
●
based on the variables or messages
●
based on the process data
Add the Correlation Key to a conversation at the process level or activity level. To attach a conversation
to an activity, atleast one correlation key must match the correlation ID (activity message input/output
or process data).
Output
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
66
Output Item
Description
TimerOutputSchem
a
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 use the appropriate datatype.
Wait
The Wait activity suspends execution of the process instance and waits for a Notify activity with a
matching key to be executed in another process instance. The key specified in the Shared Configuration
resource of the General tab and the Key field of the Input tab, creates a relationship between the Wait
activity and the corresponding Notify activity. Specify the same notifyConfigurationProperty in the
Shared Configuration resource, by corresponding the Wait and Notify activities to pass the data from
the process instance containing the Notify activity to this process instance.
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.
Key
The key to coordinate a Wait activity with the corresponding Notify activity.
Timeout
The timeout (number of milliseconds) for this Wait activity.
Shared
Configuration
The Shared Configuration resource that defines a data schema for this 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
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
67
Input Item
Datatype
Description
key
string
The key to coordinate a Wait activity with the corresponding
Notify activity.
For example, in a transaction process, the transaction ID is the
key that Wait and Notify use to determine which Wait activity
corresponds to the Notify activity.
The key can be an XPath expression evaluating to a string.
timeout
integer
The timeout (number of milliseconds) for this Wait activity.
If a Notify activity with a matching key is not executed in this
specified number of seconds, the Wait activity times out and
transitions to the next activity.
If no value or if zero is specified in this field, this activity waits
indefinitely.
Output
The following is the output for the activity.
Output Item
Datatype
Description
schema
complex
The schema specified by the Shared Configuration on the General
tab.
This schema is used to pass data from the process instance
containing the Notify activity into this process instance.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
ActivityTimedOutException
A timeout has been reached.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
68
HTTP Palette
HTTP Connector
The HTTP Connector resource descrbes the characteristics of the connection used to receive incoming
HTTP requests. This resource is used when TIBCO ActiveMatris BusinessWorks requires an HTTP
request on a specific port whether a process engine is running. For example, the process starter HTTP
Receiver and the signal-in activity Wait for HTTP Request receive HTTP requests.
There can be only one process with an HTTP Receiver or Wait for HTTP Request 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
Literal Value/
Module
Property?
Description
Name
None
The name to be displayed as the label for the resource.
Description
None
Short description of the activity.
Basic Configuration
The Basic Configuration section has the following fields.
Field
Literal Value/
Module
Property?
Host
Yes
Description
Specifies the name of the host that accepts the incoming
requests. For machines that have only one network card, the
default value localhost specifies the current machine. For
machines that have more than one network card, this field
specifies the host name of the card that will be used to accept
incoming HTTP requests.
If there is more than one network card on the machine, and
you specify localhost in this field, all network cards on the
machine will listen for incoming HTTP requests on the
specified port.
You can start only one HTTP server on each port.
Therefore, if you have a machine with multiple
network cards, ensure that all HTTP Connector
resources using the same host name specify
different port numbers.
Port
Yes
Port number on which to listen for incoming HTTP requests.
Accept Queue
Size
Yes
The number of connection requests to be queued before the
operating system starts sending rejections.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
69
Field
Acceptor
Threads
Literal Value/
Module
Property?
Yes
Description
The number of acceptor threads specified to accept the
incoming connections.
Advanced Configuration
The Advanced Configuration section has the following fields.
Field
Literal Value/
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.
Default is 6K.
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. Default is 8K.
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. Default is 32K.
Low Resource Max
Idle Time (ms)
Yes
Specify to set the period in ms for the connection to be idle,
when there are more than lowResourcesConnections
connections.
This allows the server to rapidly close idle connections to
gracefully handle high load situations.
Max Idle Time
(ms)
Yes
Specify to set the maximum Idle time for a connection. The
Max Idle Time is applied:
●
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.
Linger Time (ms)
Yes
Specify to sets the LINGER_TIME on the connection socket.
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 a many connections with
idle periods.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
70
Field
Literal Value/
Module
Property?
Use Direct Buffers
Yes
Specify to determine whether direct byte buffers will be used
or not. The default is true.
URI Encoding
Yes
Specifies the character encoding used to decode the URI
bytes.
Description
If you do not set any value for uriEncoding, the default
encoding set in HTTP Receiver is used.
Enable DNS
Lookups
None
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
throughput. This check box is not selected as default. Select
this check box only when required.
Compression
Yes
Specifies if the output of the HTTP Connection is
compressed using HTTP/1.1 GZIP compression.
The acceptable values for this field are ●
off: By default, the compression is disabled.
●
on: Allows compression for text data.
●
force: Forces compression in all cases.
Note that if the content length is not known and
compression is enabled, the output will still be compressed.
any numerical integer value: Any numerical value
equivalent to "on", and specifies the minimum amount of
data before the output can be compressed.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
71
Field
Literal Value/
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.
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 is text/html, text/xml, text/plain.
Security
Selecting the Confidentiality check box displays the SSL Server Configuration field.
SSL Server Configuration
Use this field to specify the SSL parameters for the HTTP Connector. For details, refer to SSL Server
Configuration
SSL Server Configuration
You can specify SSL parameters for the HTTP connection here.
The following are the fields in the SSL Server Configuration for HTTP Connector.
General
The General field has the following fields.
Field
Description
Name
The name to be displayed as the label for the HTTP connector shared
resource.
Description
Short description of the HTTP connector shared resource
Basic SSL Server Configuration
This contains the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
72
Field
Literal Value/
Module
Property?
Description
Identity Store
Provider
None
The name to be displayed as the label for the HTTP
connector shared resource.
Key Alias Name
Yes
Name of the alias used to access the identity.
Key Alias Password
Yes
Password for the alias.
Enable Mutual
Authentication
None
Indicates whether the client in the SSL connection will
authenticate to the server. Selecting this check box displays
the identity fields.
Client Auth Type
None
Select the type of client authentication from the drop-down
list. The available types are:
1. none
2. optional
3. required
Keystore Provider
as Trustore
None
The name of a Keystore Provider resource instance that
maintains a keystore that confirms an identity.
Advanced SSL Server Configuration
Use the following fields for advanced SSlL server configuration.
Literal
Value/
Module
Property?
Description
SSL Security
Provider
None
Optional. The SSL security provider.
SSL Protocol
Yes
The SSL protocol to use in the SSL connection. Select from
the following options:
Field
●
SSLv3
●
TLSv1
Default: TLSv1
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
73
Field
Literal
Value/
Module
Property?
Description
SSL Cipher Class
Yes
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
None
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
None
Indicates whether the name on the server's certificate must
be verified against the server's hostname.
If the server's hostname 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.
Expected Remote
Hostname
None
Optional. The expected name of the remote host.
Default: None
HTTP Client
The HTTP Client resource template represents an outgoing HTTP connection.
General
The General section has the following fields.
Field
Description
Name
The name to be displayed as the label for the resource.
Description
Short description of the shared resource.
HTTP Client
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
74
Field
Literal
Value/
Module
Property?
Description
Host
Yes
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
with more than one network card, this field specifies the host
name of the card used to accept the incoming HTTP requests.
Default is localhost.
Port
Yes
The port number on which to invoke outgoing HTTP requests.
Advanced
This section has the following fields.
Field
Literal
Value/
Module
Property?
Accept Redirect
Yes
Description
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.
Default - This check box is clear.
Disable
Connection
Pooling
Yes
When selected - indicates whether to use the single or multithreaded connection manager.
Connection
Timeout(ms)
Yes
Time (in milliseconds) to wait for a successful HTTP connection.
Maximum Total
Connections
Yes
Controls the maximum number of simultaneous active
connection that this resource instance allows. Increase the value
for the application that creates a lot of long-lived connections.
Default value is 200.
Stale Check
Yes
When selected, 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
75
Field
Maximum Total
Connections Per
Host
Literal
Value/
Module
Property?
Yes
Description
Controls the maximum number of simultaneous active
connections to a same host that this resource instance allows.
This number cannot be greater than MaximumTotal
Connections.
Default value is 20.
Thread Pool
Yes
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 and provide a means of bounding and
managing the resources consumed when executing a collection
of tasks.
Security
The security can include any combination of the following characteristics:
●
Authentication
●
Confidentiality
Field
Description
Authentication
To be included when the messages must be authenticated. Authentication
can be performed with usernames and passwords.
Identity Provider — Provide username and password credentials
encapsulated in an identity provider resource. When selected, the Identity
Provider field is activated.
Confidentiality
To be included when encrypting or decrypting the messages.
Selecting this check box displays the SSL Client Configuration field. For
details, refer to SSL Client Configuration.
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
Short description of the SSL client resource.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
76
Basic SSL Client Configuration
This section has the following fields.
Field
Description
Keystore Provider
As Trust Store
The name of a Keystore Provider resource instance that maintains a keystore
that confirms an identity.
Enable Mutual
Authentication
Indicates whether the client in the SSL connection will authenticate to the
server. When this check box is selected, the identity fields are enabled.
Identity Store
Provider
Name of Keystore Provider resource that maintains a keystore used to assert
an identity.
Key Alias Name
Name of the alias used to access the identity.
Key Alias Password
Password for the alias.
Advanced Client SSL Configuration
This section contains the following fields.
Field
Description
SSL Security
Provider
Optional. The SSL security provider.
SSL Protocol
The SSL protocol to use in the SSL connection:
●
SSLv3
●
TLSv1
Default: TLSv1
SSL Cipher Class
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 would take to break the encryption.
Default: At Least 128 Bit
Explicit Cipher List
A list of ciphers. Enabled when SSL Cipher Class is set to Explicit Ciphers.
Use the JSSE format for ciphers names.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
77
Field
Description
Verify Remote Host
name
Indicates whether the name on the server's certificate must be verified
against the server's hostname. If the server's hostname is different than the
name on the certificate, the SSL connection will fail. 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
Optional. The expected name of the remote host.
Default: None
HTTP Receiver
The HTTP Receiver activity starts a process based on the receipt of a HTTP request.
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
None
The HTTP Connection resource describes the characteristics
of the connection used to receive incoming HTTP requests.
Description
See HTTP Connection 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
context(s) 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 will display
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
Type of output. It can be either String or Binary.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
78
Field
Parse Post
Method Data
Literal Value/
Module
Property/
Process
property?
None
Description
Specifies to parse the message body of the HTTP request into
a schema for the activity’s output.
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.
Parameters
None
The parameters of the incoming HTTP request.
Specifying parameters in this table allows the incoming
request to be parsed and represented as a schema in this
activity’s output. For each parameter, you must provide a
name, datatype, and whether the field is Optional, Required,
or Repeating.
Use the + and x buttons to the right of the parameter table 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.
HTTP
Authentication
None
Specifies that the client sending the HTTP request must be
authenticated. The user name and password specified in the
incoming request must exist in the domain.
Expose Security
Context
None
Places the information from the user’s security context (either
authentication or SSL certificate information) into the
Context/SecurityContext output element.
This is a fairly expensive operation and SSL certificates can
consume memory resources. 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
79
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Process
Property/
Module
Property?
Write to File
None
Description
Selecting this check box specifies 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
Create Non-Existing Directories.
Create NonExisting
Directories
Yes
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
80
Field
Threshold Data
Size(bytes)
Process
Property/
Module
Property?
Description
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.
Sequence Key
None
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
None
This field can contain an XPath expression that specifies a
custom ID for the process instance.
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 into the PostData output element, and that
element would appear as follows:
name=John Smith&address=500 1/2 Main Street
The order of the parameters may not be the same in the PostData output element as the order in the
original HTTP request sent by the client when the message body is parsed.
The PostData output element can contain different data and be a different length depending upon
whether the message body is parsed. Hence, it is recommended 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
81
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, then it is assumed that the
client accepts all media types.
Accept-Charset
string
This field specifies the character sets that are acceptable for
response messages for the incoming request. For example,
iso-8859-5, unicode-1-1. Character sets are described in the
HTTP specification.
If no Accept-Charset header is present, then it is assumed that
the client accepts any character set.
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
This field allows the requestor to 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
conversartions.
button to initiate multiple
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
82
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.
RequestURI
string
The address portion of the request. This is the portion before
the question mark (?).
HTTPVersion
string
Version field of the HTTP request.
PostData
string
The 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.
See Special Characters in HTTP Requests for more
information.
If the Write to File field is selected on the Advanced tab PostData field can also contain the file name of the file
containing the message, if the incoming message exceeds the
specified threshold size.
QueryString
string
The query string portion of the request. This is the portion
after the question mark (?).
Header
string
The header of the HTTP request.
Protocol
string
Can be either HTTP or HTTPS depending upon the protocol
used by the request.
Port
string
Port number on which the request was received. This is the
port number configured in the HTTP 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
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 only include the query string of the incoming
request.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
83
Output 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 Output Editor tab. Dynamic
header consists of the following information:
●
Name — name of the header.
●
Value — 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 non-Repeating
Header in Input Headers. This header cannot
have multiple occurences in DynamicHeaders."
exception.
●
If it is repeating element, add the respective name value
pairs under dynamic headers, which will be added to the
existing list maintained for this element.
●
For a repeating element, if the new header name is not
found under Headers section declared via 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.
mimeEnvelopeEleme
nt
complex
This element containing the message attachments.
This element contains a repeating element named mimePart
that contains each mime attachment.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
84
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 choose to 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.
Send HTTP Request
The Send HTTP Request activity sends an HTTP request to a web server. This activity sends a request
to a server that is compliant with either the HTTP 1.1 or 1.0 specification. TIBCO ActiveMatrix
BusinessWorks automatically sends the request using the correct version based on the version
supported by the HTTP server. So do not specify the HTTP version of the server you are sending the
request to.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
85
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.
Use Proxy
Settings
Specifies to use a proxy server to gain access outside of a firewall. The Proxy
Configuration Resource specifies the configuration of the proxy server. For
details, refer to Proxy Configuration.
Parameters
The parameters of the HTTP request. For each parameter, you must provide a
Parameter Name, Parameter Type (must be type string), and whether the
Parameter Cardinality is Optional, Required, or Repeating.
These parameters are specified in the parameters element on the General tab.
Description
Provides 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 specify writing 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 the 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 file when
they are no longer in use.
Directory
Yes
Create Non-Existing Directories
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
86
Field
Creating NonExisting
Directories
Literal Value/
Module
Property?
Yes
Description
When this check box is selected, all directories in the path
specified in the Directory field are created, 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.
Threshold Data
Size(bytes)
Yes
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
The 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, then 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. Character sets are described in the HTTP
specification.
If no Accept-Charset header is specified, then 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 the HTTP specification 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
87
Input Header
Datatype
Description
Cookie
string
A name/value pair (also known as a cookie) containing
information that the HTTP server may be expecting. You can
set the Cardinality field for this element to Repeating (*) to
specify more than one cookie. You can also specify multiple
name/value pairs in a single non-repeating element by
separating each pair with a comma (for example,
"name1=value1, name2=value2").
Pragma
string
This field is used to include implementation-specific
directives that might apply to the receiver. See the HTTP
specification for more information about using this field.
Output Editor
The 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.
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.
Output Header
Datatype
Description
Allow
string
This field Lists the set of methods supported by the resource
identified by the Request-URI.
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
encodings have been applied to the entity-body. Also, what
decoding mechanisms must be applied to obtain the mediatype 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 the Request-URI for completion of the request or for
identification of a new resource.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
88
Output Header
Datatype
Description
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.
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 TIBCO 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
89
Input Item
Datatype
Description
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.
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. The dynamic header
consists of the following information:
●
Name: name of the header
●
Value: 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 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.
●
If it is repeating element, add the respective name value
pairs under dynamic headers, which will be added to the
existing list maintained for this element.
●
For a repeating element, if the new header name is not
found under Headers section declared via TIBCO
Business Studio, the following is added into the HTTP
Headers.
—
Shows only one value, if found once in
DynamicHeaders.
—
Shows an array of values, if found repeating in
DynamicHeaders.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective actions to take.
Fault
Thrown When..
HttpClientException
The HTTP server responds with a message containing the 4XX
status code.
HttpServerException
The HTTP server responds with a message containing the 5XX
status code.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
90
Fault
Thrown When..
HttpCommunicationException
An HTTP exception occurred while executing the specified
method, or when trying to read the response.
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 Request URI to pass
parameter/value pairs. Other methods use the HTTP message body to send data in the request.
The Send HTTP Request has 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 Request URI. You can use this input element to
dynamically construct the query string using an XPath expression when you do not know the
names or number of input parameters for the request until the activity executes.
●
Parameters: corresponds to 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 Request URI. 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 parameters are specified 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. Typically, 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 all parameters on the General tab
are specified as Optional, you can use the QueryString input element instead of the parameters input
element. But 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 is expected to decode 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 Configuration tab, encoding is done automatically.
For example, if you want to specify the following PostData:
name=John Smith&address=500 1/2 Main Street,
your PostData input element should result in the following string:
name=John%20Smith&address=500%201%2F2%20Main%20Street
For more information about the URL specification, see http://www.rfc-editor.org/rfc/rfc1738.txt.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
91
Send HTTP Response
Send HTTP Response activity sends a response to a previously received HTTP request. This activity is
used in conjunction with the HTTP Receiver process starter aor Wait for HTTP Request activity. The
default status line returned by this activity is "200 OK"
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.
Reply For
The Wait for HTTP Request activity or HTTP Receiver process starter that
received the request. This is a selection list of available activities that can
receive HTTP requests.
Flush Response
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 activity in
a process, each activity sending a portion of the response to the client. All
Send HTTP Response activities in a process should have this chevk box clear,
except the last Send HTTP Response activity. Select this check box in 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
The 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
92
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.
Content-Type
string
This field indicates the media type of the entity body sent to
the receiver. Media types are described in the HTTP
specification. An example of the media type is text/html;
charset=ISO-8850-4.
By default this item is set to text/html. If you are using this
activity and the Retrieve Resources activity to retrieve a
WSDL file, you should set the type to text/xml when
specifying values on the Input tab.
Set-Cookie
string
See the HTTP specification for more information about this
field.
Pragma
string
This field is used to include implementation-specific
directives that might apply to the receiver. See the HTTP
specification for more information about using this field.
Location
string
This field is used to redirect the receiver to a location other
than the Request-URI for completion of the request or for
identification of a new resource.
Conversations
button to initiate multiple
You can initiate the Conversation here. Click the Add New Conversation
conversartions. For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application
Design.
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
ignores for all subsequent activities.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
93
Input Item
Datatype
Description
DynamicHeade
rs
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. Dynamic header consists of the
following information:
●
Name: Name of the header
●
Value: 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 non-repeating
header. If more than one occurance of this hheader is found
under DynamicHeaders, it throws the following exception:
The header [ headerName ] is defined as nonRepeating 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 Dynamic Headers. This will be 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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
HttpCommunicationExceptio
An HTTP exception occurred when sending the response.
n
Wait for HTTP Request
Wait for HTTP Request activity 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
94
Field
Description
Name
The name to be displayed as the label for the activity in the process.
HTTP Connection
The 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
The Context Resource path of the schema you want to use. The schema of this
resource should include elements for each data element you want to provide
to the output Undescribed Headers for the message
Path Spec
Output Style
The Output message format. You can select either Text or Binary format for
the output messages.
Parse Post Method
Data
Specifies whether the message body of the HTTP request should be parsed
into a schema for the activity’s output.
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, so this field
has no effect on incoming GET message body requests.
Parameters
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 activity’s output. For each parameter, you must provide a name,
datatype, and whether the field is Required, Optional, or Repeating.
Use the + and x buttons to the right of the parameter table to add and remove
parameters. Use the up and down arrows to move parameters to new
positions in the table.
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 here is
required to parse the message body along with the query string of
the request.
HTTP
Authentication
Specifies that the client sending the HTTP request must be authenticated. The
user name and password specified in the incoming request must exist in the
domain.
Expose Security
Context
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
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
95
Description
Provide a short description for the activity here.
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
immediately, unless this activity has already been reached.
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.
Field
Description
Write to File
Selecting this check box specifies that 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 Non-Existing Directories, and Threshold
Size fields. Leave 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
The directory to write messages that are above the specified threshold. The
process engine does not attempt to create the directory if the specified
directory does not exist. Therefore, create the directory before starting the
process engine.
Create Non-Existing
Directories
When 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)
The maximum size (in bytes) of an incoming message that can be kept in
memory. Messages larger than the specified size are written to a file in the
specified directory. The file’s name is output so that subsequent activities in
the process can access the file and read its contents.
Specifying zero (0) in this field causes all incoming messages to be saved to a
file.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
96
Output Editor
The 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. Media types are described
in the HTTP specification.
If no Accept header field is present, then the client
accepts all media types.
Accept-Charset
string
This field specifies the character sets that are acceptable
for response messages for the incoming request. For
example, iso-8859-5, unicode-1-1. Character sets are
described in the HTTP specification.
If no Accept-Charset header is present, then the client
accepts any character set.
Accept-Encoding
string
This field specifies the content-coding values that are
acceptable for response messages. For example,
compress, gzip. See the HTTP specification for more
information about this header field.
Content-Type
string
This field indicates the media type of the entity body
sent to the receiver. Media types are described in the
HTTP specification. An example of the media type is
text/html; charset=ISO-8850-4.
Content-Length
string
This field indicates the size of the entity body (in decimal
number of OCTETs) sent to the receiver.It also takes into
account the encoding ofthe message body, see Special
Characters in HTTP Requests for more information on
when the message body is URL encoded.
Connection
string
This field allows the ruser to specify options required for
this connection. For example, the option close specifies
that the user would like the connection to be closed
when the request is complete.
Cookie
string
See the HTTP specification for more information about
this field.
Pragma
string
This field is used to include implementation-specific
directives that might apply to the receiver. See the HTTP
specification for more information about using this field.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
97
Conversations
You can join the Conversation here. Click the Joining existing conversation
button to join
multiple conversartions. For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks
Application Design.
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
Version field of the HTTP request.
PostData
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
98
Output 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. Dynamic
header consists of the following information:
●
Name: name of the header
●
Value: 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 Dynamic Headers. This will be
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 via
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
ActivityTimedOutException
The timeout for the activity is attained.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
99
JAVA Palette
Java Global Instance
The java Global Instance shared configuration resource allows you to specify a Java object to be shared
across all process instances in a Java Virtual Machine (JVM).
When the process engine is started, an instance of the specified Java class is constructed. When the
process engine is shut down, if specified, a cleanup method is invoked on the object. 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 Code activity can access the shared Java
Global Instance by invoking the static methods of the configured Java class.
If multiple process instances access the shared Java Global Instance, you may 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. Refer to TIBCO
ActiveMatrix BusinessWorks Application Design for more information about using critical section groups.
Java Schema
The Java Schema shared configuration resource allows you to specify a Java class that is used to
configure a Java To XML or XML To Java.
The Java Class is converted to an XML schema using the following rules:
●
Only the public data members of the Java class are mapped to XML elements. Private and protected
members are not included.
●
The Java class member public variable name is mapped to an XML element with the same name. For
example, a Java class member variable declared as public int ZipCode is mapped to an XML
element named ZipCode.
●
Java Bean accessors and modifiers are mapped to appropriate XML element names. For example, a
Java class method public int getBalance() or public void setBalance(int Balance) are mapped to an
XML element named Balance.
●
Only one XML element is created regardless of how many members of the Java class share the same
name. For example, there may be an attribute named MySalary and accessors named getMySalary()
and setMySalary(). This translates to one element named MySalary in the resulting XML document.
●
Conversion is case-sensitive. For example, if you have a data member declared as public int zipCode
and an accessor method declared public void setZipCode(int NewZipCode), there will be two
elements in the resulting XML schema, zipCode (for the data member) and ZipCode (for the
accessor). Make sure to use the correct element when using the resulting XML in input mappings of
the subsequent activities.
●
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.
●
The datatype java.util.Map or any types that extend java.util.Map are not supported. For example,
HashMap is not supported.
Java Invoke
The Java Invoke activity allows you to invoke a Java class method. You can construct an instance of the
specified Java class, if you select to invoke the constructor for the class.
General
The General tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
100
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.
Specifying a resource in this field automatically populates the
Library and the Class Name field with the correct values from
the Java Global Instance resource. This disables the options on
the Advanced tab. You can select the method to execute in the
drop-down list in the Method field.
If the configuration of the Java Global Instance
resource changes, you must 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 and method,
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.
This field is automatically populated when you use the
Browse a Class button.
You can use the drop-down list to select a different method in
the selected Java class, if required.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
101
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 parameters that are
required for the Java method. This element is not available
when the selected method has no parameters.
Each input parameter has the following fields:
●
Field Type - It can be either
●
Field Name - Name of the parameter. The available
options in the drop-down list are - csvFile, name, or value.
●
Type - Datatype of the parameter. It is string.
●
Occurance - Specify whether the parameter is Required,
Optional, or Repeating.
In
or Out.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
Field
Instantiate the
referenced class
Literal Value/
Module
Property
Description
None
This field controls whether:
●
the referenced class must be constructed when the activity
is executed, or
●
an object reference must be supplied in the activity’s input
schema.
When this check box is selected, the referenced class is
constructed using the default constructor when the activity
executes. In this case, the referenced class is not included in
the activity’s input schema.
When this check box is not selected, you must 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
102
Field
Literal Value/
Module
Property
Cache the object
None
Description
This option is available only when the Instantiate the
referenced class check box is checked.
When selected, this specifies that all instances of this Java
Invoke activity will share the instance of the instantiated
referenced class. A cached referenced object is kept in the
memory until the process engine terminates.
If this check box is not selected, each instance of this Java
Invoke activity creates 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 the memory, when the
process engine terminates. This allows you to 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.
This field allows you to specify the name of the method to
invoke before the cached class in memory is released.
The selected method cannot contain any parameters, therefore
only methods with no parameters are listed in this field. Any
values returned by the selected method are ignored, but
exceptions raised by the selected method are sent to the log.
Input
The following is the input for the activity.
Input Item
Datatype
Description
referenced class
Java Object
An object reference to the Java Class specified on the General
tab. This element is not shown when the referenced java class
you want to invoke is static.
This element is only available, when the Instantiate the
referenced class field on the Advanced tab is not selected.
Output
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
103
Output Item
Datatype
Description
referenced class
Java Object
An object reference to the Java Class specified on the General
tab. This element is not visible when the referenced java
class to be invoked is static.
This element is only available, when the Instantiate the
referenced class field on the Advanced tab is not selected.
Fault
The Fault tab lists the exceptions thrown by this activity. A method to invoke when selected, lists the
exceptions thrown by the method on the Fault tab.
Error Schema Element
Datatype
Description
msg
string
The TIBCO ActiveMatrix BusinessWorks error
message. Refer to TIBCO ActiveMatrix BusinessWorks
Error Codes for details.
msgCode
string
The TIBCO ActiveMatrix BusinessWorks error code.
Refer to TIBCO ActiveMatrix BusinessWorks Error
Codes for details.
methodName
string
The name of the Java method that raised the
exception.
exceptionClassName
string
The exception class name.
The value of this element is obtained by calling the
<exception>.getClass().getName() method.
string
exceptionMessage
The exception message.
The value of this element is obtained by calling the
<exception>.getMessage() method.
Java Process Starter
The Java Process Starter allows you to create a custom starter written in Java. Your custom process
starter observes the database for insert event and then calls the onEvent() method with the required
data as input, when an insert occurs. The Java Process Starter creates a process when the onEvent()
method is invoked and the object passed to the method is passed to the process. This process starter
uses an abstract class to define the interface.
General
The General tab has the following fields.
Field
Process
Property
Name
No
Description
The name to be displayed as the label for the activity in
the process.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
104
Field
Process
Property
Class Name
No
Description
The name of the compiled Java class that implements the
JavaProcessStarter abstract class.
Use the Browse a Class
button to select the class from
the specified Class Library.
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.
The init() method for the class. This field is
automatically populated when you use the Browse a
Class
button.
You can use the drop-down list, if required, to select a
different method in the selected Java class.
Init Parameters
No
This table allows you to specify default values for the
input parameters of the init() method. Each input
parameter has three fields:
●
Parameter Name — Name of the parameter.
●
Parameter Type — Datatype of the parameter.
●
Parameter Value — Specify a default value for the
parameter.
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 order. Process instances with sequencing keys that evaluate
to the same value will be executed sequentially in the order 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
105
Conversations
You can initiate the Conversation here. Click the Add New Conversation
multiple conversartions.
button to initiate
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
Output
The following is the output for the activity.
Output Item
Dataty
pe
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Error Schema
Element
Datatype
Description
msg
string
The TIBCO ActiveMatrix BusinessWorks error message.
Refer to TIBCO ActiveMatrix BusinessWorks Error Codes
for details.
msgCode
string
The TIBCO ActiveMatrix BusinessWorks error code.
Refer to TIBCO ActiveMatrix BusinessWorks Error Codes
for details.
Java To XML
The Java to XML activity allows you to convert Java object's data members in to 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, there will
be an element named ID in this activity’s output schema, but that element has no value because there is
no public mechanism for getting the data.
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™ Express Palette Reference
106
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 for the activity.
Advanced
The Advanced tab has the following fields.
Field
Description
Instantiate the
referenced class
This field controls whether:
●
the referenced class must be constructed when the activity is
executed, or
●
an object reference must be supplied in the activity’s input schema.
When this check box is selected, the referenced class is constructed using
the default constructor when the activity executes. In this case, the
referenced class is not included in the activity’s input schema.
When this check box is not selected, you must 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.
In this case, the referenced class is included in the activity’s input
schema.
Cache the object
This option is available only when the Instantiate the referenced class
check box is checked.
When selected, this specifies that all instances of this Java Invoke activity
will share the instance of the instantiated referenced class. A cached
referenced object is kept in the memory until the process engine
terminates.
If this check box is not selected, each instance of this Java To XML
activity creates its own copy of the referenced class.
Input
The following is the input for the activity.
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 the
Instantiate the referenced class check box is not selected on
the Advanced tab.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
107
Output
The following is the output for 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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and possible corrective actions.
Fault
Thrown When..
JavaToXMLConversionExceptio
An error occurred when converting the Java object to XML.
n
XML To Java
The XML to Java activity allows you to create an instance of a Java object based on data from an XML
document. The XML schema for providing the input to the Java object or Jaca 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 serializable (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, there is an element
named ID in this activity’s input schema, but mapping a value to the element does not result in setting
the ID member of the output Java object. 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
108
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 for 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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and possible corrective actions.
Fault
Thrown When..
XMLToJavaConversionExceptio
An error occurred when converting the XML schema to a Java
object.
n
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
109
JDBC Palette
The JDBC palette contains activities and shared resources for querying, updating, or calling stored
procedures in the database.
JDBC Call Procedure
The JDBC Call Procedure activity calls a database procedure using the specified JDBC connection. id
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, 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/
Process
Property/
Module
Property?
Name
None
The name to be displayed as the label for the activity in the
process.
JDBC Shared
Resource
Yes
Path to the shared resource containing the JDBC connection
information.
Description
See JMS Connection for more information about JDBC
resources.
Timeout
Yes
Time to wait for the procedure call to complete. If the call does
not complete in the specified time limit, it returns and 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.
Procedure
The Procedure tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
110
Field
Description
Schema
The schema in which the procedure resides. This name is used to resolve
naming conflicts, if more than one schema in the database has the selected
procedure with the same name.
Catalog or Package
The catalog or package in which the procedure resides. This name is used to
resolve naming conflicts if more than one catalog or package in the database
has the selected procedure with the same name.
This field is only applicable to databases that have more than one catalog and
package. See your database documentation for more information about
catalogs and packages.
Procedure/
Function
Name of the database procedure or user-defined function to call. Click Select
button to query the database for available procedures or functions after
specifying the JDBC Connection field.
The list of available procedures and functions will be limited by the values
supplied in the Schema and Catalog or Package fields.
Parameters
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.
Advanced
The Advanced tab has the following fields.
Field
Description
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 this check box is selected, 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.
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled. When the check box is selected, nulls are sent 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 field 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.
Input
The input for this activity is dependent upon the input parameters of the database procedure.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
111
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.
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
Time (in seconds) to wait for the procedure call to complete.
If the call 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.
Output
The output for the activity is dependent upon the output parameters of the database procedure.
Output Item
Datatype
Description
outputSet
complex
The output of the database procedure. The datatype
contained in this element varies depending upon what the
database procedure returns.
unknownResultSe
ts
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, 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.
Fault
Thrown When..
JDBCDriverLoadingExcept
An error occurred when loading the specified JDBC driver.
ion
xception
An error occurred when attempting to connect to the specified
database.
InvalidTimeZoneExceptio
An invalid timezone was specified.
JDBCConnectionNotFoundE
n
JDBCSQLException
An SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
112
JDBC Connection
The 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
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
None
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
User name to use when connecting to the database.
Password to use when connecting to the database.
JDBC Drivers
This section has the following fields.
Field
Literal
Value/
Module
Property?
JDBC Driver
Yes
Description
The name of the JDBC driver class. You can select from a list
of supported drivers.
If you select a supported driver, the Database URL field is
populated with a template for the URL of the driver.
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 (<>).
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
113
Field
Literal
Value/
Module
Property?
Login Timeout
Yes
Description
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.
JDBC Query
The JDBC Query activity performs the specified SQL SELECT statement. if this activity is not part of a
transaction group, the SQL statement is committed after the activity completes.
If this activity is part of a transaction group, the SQL statement is committed or rolled back with the
other JDBC activities in the group at the end of the transaction.
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?
Description
Name
None
The name to appear as the label for the activity in the process.
JDBC Shared
Resource
Yes
Path to the shared configuration resource containing the
JDBC connection information. For details, refer to JDBC
Connection
Timeout
Yes
Time (in seconds) to wait for the query to complete. If the
query does not complete in the given time limit, an error is
returned.
Maximum Rows
Yes
The maximum number of rows to retrieve. To retrieve all
rows, specify 0.
Description
Provide a short description for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
114
Advanced
The Advanced tab has the following fields.
Field
Description
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 this check box is selected, 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.
Use Nil
Specifies whether NULLs are represented as optional schema elements or
whether each item that can contain a NULL has sub-items.
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled. When the check box is selected, nulls are sent 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 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 will not affect how the database interprets empty strings.
Process In Subsets
Selecting this check box specifies that you would like 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 appears to allow you
to specify the size of each batch of records you want to process. Also, the
lastSubset output element appears and is set to true when the last batch of
records is being processed.
When this check box is not selected, the entire result set is returned.
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
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.
Output
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
115
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
complexs
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.
Fault
Thrown When..
JDBCDriverLoadingExcept
An error occurred when loading the specified JDBC driver.
ion
xception
An error occurred when attempting to connect to the specified
database.
InvalidTimeZoneExceptio
An invalid timezone was specified.
JDBCConnectionNotFoundE
n
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
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.
DuplicatedFieldNameExce
A duplicate field name was specified.
ption
JDBC Update
The JDBC Update activity performs the specified SQL INSERT, UPDATE, or DELETE statement.
If this activity is not part of a transaction group, the SQL statement is committed after the activity
completes. If this activity is part of a transaction group, the SQL statement is committed or rolled back
with the other JDBC activities in the group at the end of the transaction.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
116
Field
Literal
Value/
Module
Property?
Description
Name
None
The name to appear as the label for the activity in the process.
JDBC Shared
Resource
Yes
Path to the shared configuration resource containing the JDBC
connection information. For details, refer to JDBC Connection
Timeout
Yes
Time (in seconds) to wait for the query to complete. If the query
does not complete in the given time limit, an error is returned.
Description
Provide a short description for the activity.
Advanced
Field
Description
Insert if the record
doesn't exist
Select this check box to insert the record of 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 this check box is selected, 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.
Interpret Empty
String as Null
Specifies how empty strings in the activity’s input elements should be
handled. When the check box is selected, nulls are sent 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 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 will not affect how the database interprets empty strings.
Batch Update
Selecting this check box signifies 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 this check box is not selected, 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
117
Input Item
Datatype
Description
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
Time (in seconds) to wait for the query to complete. If the query
does not complete in the given time limit, an error is returned.
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 Configuration tab.
This element can also return -2 that indicates, in the event of a
batch update, that the updates were successful, but it is
unknown how many updates were performed.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JDBCDriverLoadingExcept
An error occurred when loading the specified JDBC driver.
ion
xception
An error occurred when attempting to connect to the specified
database.
InvalidTimeZoneExceptio
An invalid timezone was specified.
JDBCConnectionNotFoundE
n
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
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.
SQL Direct
The SQL Direct activity executed an SQL statement that you provide. Use this activity to build an SQL
statemet dynamically (usning other activities,), then pass the SQL statement into this activity's input.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
118
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Description
Name
None
The name to appear as the label for the activity in the process.
JDBC Shared
Resource
Yes
Path to the shared configuration resource containing the JDBC
connection information. For details, refer to JDBC Connection
Timeout
Yes
Time (in seconds) to wait for the query to complete. If the query
does not complete in the given time limit, an error is returned.
Maximum Rows
Yes
The maximum number of rows to retrieve. To retrieve all rows,
specify 0.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following field.
Field
Description
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 this check box is selected, 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.
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 desired.
ServerTimeZone
string
Specifies the time zone for the database server.
timeout
number
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
119
Input Item
Datatype
Description
maxRows
number
The maximum number of rows to retrieve. To retrieve all rows,
specify 0.
Output
The following is the output for the activity.
Output Item
Datatype
Description
noOfUpdates
string
The number of updates performed by the statement specified
on the Configuration tab.
This element can also return -2 that indicates, in the event of a
batch update, that the updates were successful, but it is
unknown how many updates were performed.
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 could be multiple result sets
returned by the statements executed by this activity.
Because of this, this output item is a repeatable list of result sets.
The first item in the list of result sets corresponds to the result
set returned by the first statement executed by this activity. The
second item in the list of result sets corresponds to the result set
returned by the second statement executed by this activity, and
so on.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JDBCDriverLoadingExcept
An error occurred when loading the specified JDBC driver.
ion
xception
An error occurred when attempting to connect to the specified
database.
InvalidTimeZoneExceptio
An invalid timezone was specified.
JDBCConnectionNotFoundE
n
JDBCSQLException
A SQL error occurred.
JDBCTimedOutException
The operation has timed out.
LoginTimedOutException
A timeout has occurred while attempting to connect to the database.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
120
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 your JMS provider or the JMS specifications for more information about
JMS and its message models.
Get JMS Queue Message
The Get JMS Queue Message activity 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 or the JMS Queue Receiver process starter.
You can use the Message Selector field on the Advanced tab to retrieve a specific queue message from
the queue.
The Get JMS Queue Message activity is different from the Wait for JMS Queue Message activity in the
following ways:
●
This activity starts listening for the incoming messages on the specified queue from the time the
activity is triggered. This is different than the Wait for JMS Request actuvity, which starts listening
for the messages when the BusinessWorks engine starts.
●
This activity can receive only one message from the specified queue at a time, when the Message
Selector is not used.
●
This activity after triggering, can either get a message from the specified destination queuename
before the timeout and proceeds or it throws a timeout error and exits.
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
None
The JMS connection.
Destination
Yes
Name of the destination from which to retrieve the message.
Description
The syntax of the destination name is specific to the JMS
provider you are using. See your JMS provider documentation
for more information about queue names.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
121
Field
Literal
Value/
Process
Property/
Module
Property?
Description
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 serializable Java object.
●
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™ Express Palette Reference
122
Field
Acknowledgeme
nt Mode
Literal
Value/
Process
Property/
Module
Property?
Yes
Description
The acknowledge mode for incoming messages. It can be one of
the following:
●
Auto: the message is automatically acknowledged, when it
is received.
●
Client: the message will be acknowledged at a later point
by using the Confirm activity. If the message is not
confirmed before the process instance ends, the message is
redelivered and a new process instance is created to handle
the new incoming message. Ensure that your process
confirms the message when using this acknowledge mode.
●
Dups Ok: the message is acknowledged automatically
when it is received. JMS provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix BusinessWorks
acknowledges messages upon receipt.
●
TIBCO EMS Explicit Client: (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 DupsOk
●
TIBCO EMS Explicit 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, would be lazily
acknowledged.
●
TIBCO EMS No Acknowledge: messages delivered using
this mode do not require acknowledgement. Therefore
messages in this mode will not be redelivered regardless of
whether the delivery was successful.
Description
Provide a short description for the activity here.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
123
Field
Message
Selector
Literal
Value/
Process
Property?
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 your JMS provider documentation for more information and
syntax for a message selector string.
Application
Property Type
None
The type of application-specific message properties that will be
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/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.
Input
The following is the input for the activity.
Input Item
Datatype
Description
destinationQu
eue
string
The queue to which to send the request. This input item overrides
the Destination field on the General tab.
timeout
integer
Specifies how long the message can remain active (in seconds). 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 your JMS provider documentation for more information and
syntax for a message selector string.
Output
The following is the output for the activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See JMS Headers for
more information about message header fields.
Only properties applicable to this type of message are displayed.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
124
Output Item
Datatype
Description
JMSProperties
complex
The message properties for the message. See JMS Propertiesfor
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JMSInvalidInputExceptio
Input to the activity is not valid.
n
JMSSessionCreateExcepti
The JMS session could not be created.
on
JMSReceiveException
The JMS receive operation failed.
ActivityTimedOutExcepti
The specified timeout has been attained and the activity has not
completed its execution.
on
JMS Connection
The 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
This name displays as the label for the resource.
Description
Short description of the shared resource.
Basic Configuration
This section has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
125
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:
Queue Connection
Factory
●
JNDI: Select for the JNDI to look up the Connection Factory object.
Selecting this option displays the Queue Connection Factory and Topic
Connection Factory.
●
Direct: Select if you want to connect to the JMS server using a URL.
Selecting this option displays Provider URL and Supports XA
Transactions fields.
This field is available when you select JNDI option in the Connection Factory
Type field and Queue/Topic option in the Message Style field.
The QueueConnectionFactory object stored in JNDI. This object is used to
create a queue connection with a JMS application.
See your JNDI provider documentation for more information about creating
and storing QueueConnectionFactory objects.
Topic Connection
Factory
This field is only available when you select the JNDI option in the Connection
Factory Type field and Queue/Topic option 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 your JNDI provider documentation for more information about creating
and storing TopicConnectionFactory objects.
Messaging Style
Select from one of the following available options:
●
Generic
●
Queue/Topic
Connection
Factory JNDI
Name
The JNDI name of the JMS connection factory. If a name has not been
specified, the default JMS Connection Factory is used.
JNDI
Configuration
A JNDI Configuration shared configuration object that specifies the JNDI
connection information.
Provider URL
This field is only available when you select Direct option in the Connection
Factory Type field.
The URL to the JNDI service provider, for example,tcp://<host>:<port>.
Supports XA
Transactions
This field is only available when you select Direct option in the Connection
Factory Type field.
Selecting this check box specifies that an XA connection factory is to be used.
This is useful if you want activities that use this connection, to participate in
an XA transaction.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
126
Test Connection
Click the Test Connection button to test the connection specified in the configuration of this resource.
Security
The 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
will display 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 and a value is specified in the Client ID field,
an attempt is made to use the specified value. However, if the specified value
is already in use, a new client ID is generated.
When an automatically generated client ID is required, the following format is
used for the client ID:
BW-<projectName>-<topic or queue>-<engineName>-<timestamp>
If this check box is not selected, then the value specified in the Client ID field
is used. If no value is specified in the Client ID field, then no client ID is set. If
the value specified in the Client ID field is already in use, it throws an
exception.
Client ID
Client ID for the connection. The JMS providers have a provider-specific
format for client IDs.
See your JMS provider’s documentation for more information about client IDs.
Each connection must use a unique Client ID. If you do not specify a value in
this field, TIBCO ActiveMatrix BusinessWorks ensures the uniqueness of the
client ID for each connection.
SSL
Select the Confidentiality check box to configure the SSL connection parameters.
JMS Properties
JMS Properties are comprise message headers and message properties. MessageHeader properties are
set by the JMS application sending the message. These are available to view after the message is
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
127
received. You can set the 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
Destination where the message is sent.
JMSReplyTo
string
The JMS application where the reply message should
be sent.
JMSDeliveryMode
string
The delivery mode of the message. Can be one of the
following:
●
PERSISTENT: signifies the messages are stored and
forwarded.
●
NON_PERSISTENT: messages are not stored and
may be lost due to failures in transmission.
JMSMessageID
string
The unique ID of the message.
JMSTimestamp
long
The time a message was handed off to a JMS provider
to be sent. The time is expressed as the amount of time,
in milliseconds, since midnight, January 1, 1970, UTC.
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.
JMSPriority
integer
The priority of the message. Priority is a value from 0-9.
Higher numbers signify a higher priority (that is, 9 is a
higher priority than 8).
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
your JMS provider documentation for more
information about the use of this field.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
128
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.
JMSXDeliveryCount
integer
The number of delivery attempts for this message.
JMSXGroupID
string
The identity of the message group this message is a
part of.
You can set this property on outgoing messages to
group messages into a numbered sequence.
JMSXGroupSeq
integer
The sequence number of this message in its group.
You can set this property on outgoing messages to
group messages into a numbered sequence.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
129
Receive JMS Message
Starts a process based on the receipt of a message for the specified JMS Queue.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to ato 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 object 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:
Durable Subscriber
Yes
●
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 serializable Java object.
●
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
130
Field
Literal Value/
Process
Property/
Module
Property?
Subscription Name
Yes
Description
The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
the Durable Subscription 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 your 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 checkbox 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™ Express Palette Reference
131
Field
Literal Value/
Process
Property/
Module
Property?
Acknowledge Mode
Yes
Description
The acknowledge mode for incoming messages. It can be
one of the following:
●
Auto: the message is automatically acknowledged,
when it is received.
●
Client: the message will be acknowledged at a later
point by using the Confirm activity. If the message is
not confirmed before the process instance ends, the
message is redelivered and a new process instance is
created to handle the new incoming message. Ensure
that your process confirms the message when using this
acknowledge mode.
●
Dups Ok: the message is acknowledged automatically
when it is received. JMS provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix
BusinessWorks acknowledges messages upon receipt.
●
TIBCO EMS Explicit Client: (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 DupsOk
●
TIBCO EMS Explicit 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, would be
lazily acknowledged.
●
TIBCO EMS No Acknowledge: messages delivered
using this mode do not require acknowledgement.
Therefore messages in this mode will not be redelivered
regardless of whether the delivery was successful.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
132
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 your JMS provider documentation for more
information and syntax for a message selector string.
Application
Properties Type
Yes
Any application-specific message properties that will be
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 one second.
Set a value in this field to specify the polling interval (in
seconds) for this activity. The value in this field overrides
the default polling interval.
Sequence Key
None
This field can contain an XPath expression that specifies
which processes should run in order. Process instances
with sequencing keys that evaluate to the same value are
executed sequentially in the order the process instances
were created.
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/value pairs, and the schema allows you 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.
Conversations
You can initiate the Conversation here. Click the Add New Conversation
multiple conversartions.
button to initiate
Output
The following is the output for this activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See JMS Headers for
more information about message header fields.
Only properties applicable to this type of message are displayed.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
133
Output Item
Datatype
Description
JMSProperties
complex
The message properties for the message. See JMS Propertiesfor
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.
Request Reply
The Request Reply activity is used to send a request to a JMS queue and receive 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.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to ato 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
Name of the Destination queue of the outgoing and
incoming message.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
134
Field
Literal Value/
Process
Property/
Module
Property?
Description
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 serializable Java object.
●
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.
Description
Privide a short description for the activity here.
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:
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.
●
Persistent: signifies the messages are stored and forwarded.
●
Non_Persistent: signifies the messages are not stored and my 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
135
Field
Description
JMS Expiration(sec)
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
Priority of the message. You may set the priority to a value from 0-9. The
default value is 4.
Type
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message properties that will be part of the message.
This is specified by the JMS Application Properties shared configuration
object.
Input Editor/Output Editor
The Input Editor/Output Editor tabs define the schema to use for messages of type Map, Stream, or
XML Text. Map messages are name/value pairs, and the schema allows you to define the structure of
the outgoing request and the incoming reply. The schema defined on the Input Editor tab becomes the
body of the message on the Input tab. The schema defined on the Output Editor tab becomes the body
of the message on the Output tab.
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, 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
136
Input Item
Datatype
Description
JMSDeliveryMode
string
The delivery mode of the message. Can be one of the
following:
●
Persistent: signifies the messages are stored and
forwarded.
●
Non_Persistent: signifies the messages are not stored
and my 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 JMS
Properties.
Body
depends on the
message type
The body of the message.
Output
The following is the output for this activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See JMS 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 JMS Propertiesfor
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.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
137
Fault
Thrown When..
JMSInvalidInputExceptio
Input to the activity is not valid.
n
JMSMessageCreateExcepti
The JMS message could not be created.
on
JMSSessionCreateExcepti
The JMS session could not be created.
on
JMSSendException
The JMS send operation failed.
JMSReceiveException
The JMS receive operation failed.
ActivityTimedOutExcepti
The specified timeout has been attained and the activity has not
completed its execution.
on
Send JMS Message
The Send JMS Message activity sends a message to the specified JMS queue..
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to ato 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
Name of the Destination queue of the outgoing and
incoming message.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
138
Field
Literal Value/
Process
Property/
Module
Property?
Description
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 serializable Java object.
●
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.
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:
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.
●
Persistent: signifies the messages are stored and forwarded.
●
Non_Persistent: signifies the messages are not stored and my 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
139
Field
Description
JMS Expiration(sec)
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
Priority of the message. You may set the priority to a value from 0-9. The
default value is 4.
Type
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message properties that will be 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.
Input Editor
The Input Editor tab defines the schema to use for outgoing messages whose message type is Map,
Stream, or XML Text. Map messages are name/value pairs, and the schema allows you to define the
structure of the outgoing message. 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.
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, 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
140
Input Item
Datatype
Description
JMSDeliveryMode
string
The delivery mode of the message. Can be one of the
following:
●
Persistent: signifies the messages are stored and
forwarded.
●
Non_Persistent: signifies the messages are not stored
and my 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 JMS
Properties.
Body
depends on the
message type
The body of the message.
Output
The following is the output for 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.
Fault
Thrown When..
JMSInvalidInputExceptio
Input to the activity is not valid.
n
JMSMessageCreateExcepti
The JMS message could not be created.
on
JMSSessionCreateExcepti
The JMS session could not be created.
on
JMSSendException
The JMS send operation failed.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
141
Reply to JMS Message
The Reply To JMS Message activity sends a reply to a previously received JMS queue or topic message.
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 of the activity.
Default: .
Reply For Event
Message Type
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 activities are:
●
GetJMSQueueMessage
●
ReceiveJMSMessage
●
WaitforJMSRequest
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 serializable Java object.
●
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.
Description
Provide a short description for the activity.
Advanced
The Advanced tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
142
Field
Description
Deliver Mode
The delivery mode of the message. Can be one of the following:
JMS Expiration(sec)
●
Persistent: signifies the messages are stored and forwarded.
●
Non_Persistent: signifies the messages are not stored and my 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
Priority of the message. You may set the priority to a value from 0-9. The
default value is 4.
JMSType
The value to supply to the JMSType header property.
Application
Properties Type
Any application-specific message properties that will be 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/value pairs, and the schema allows you 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.
Conversations
You can initiate the Conversation here. Click the Add New Conversation
multiple conversartions.
button to initiate
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
143
Input Item
Datatype
Description
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 the messages are stored and
forwarded.
●
Non_Persistent: signifies the messages are not stored
and my 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 JMS
Properties.
Body
depends on the
message type
The body of the message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
JMSInvalidInputExceptio
Input to the activity is not valid.
n
JMSMessageCreateExcepti
The JMS message could not be created.
on
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
144
Fault
Thrown When..
JMSSessionCreateExcepti
The JMS session could not be created.
on
The JMS send operation failed.
JMSSendException
Wait for JMS Request
The Wait for JMS Request activity waits for the receipt of a message for the specified JMS topic.
General
The General tab has the following fields.
Field
Literal Value/
Process
Property/
Module
Property?
Name
None
The name to ato 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 object 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 serializable Java object.
●
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™ Express Palette Reference
145
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.
Subscription Name
Yes
The subscription name registered with the JMS application
for durable subscriptions. This field is only available when
the Durable Subscription 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 your 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 checkbox 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™ Express Palette Reference
146
Field
Literal Value/
Process
Property/
Module
Property?
Acknowledge Mode
Yes
Description
The acknowledge mode for incoming messages. It can be
one of the following:
●
Auto: the message is automatically acknowledged,
when it is received.
●
Client: the message will be acknowledged at a later
point by using the Confirm activity. If the message is
not confirmed before the process instance ends, the
message is redelivered and a new process instance is
created to handle the new incoming message. Ensure
that your process confirms the message when using this
acknowledge mode.
●
Dups Ok: the message is acknowledged automatically
when it is received. JMS provides this mode for lazy
acknowledgement, but TIBCO ActiveMatrix
BusinessWorks acknowledges messages upon receipt.
●
TIBCO EMS Explicit Client: (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 DupsOk
●
TIBCO EMS Explicit 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, would be
lazily acknowledged.
●
TIBCO EMS No Acknowledge: messages delivered
using this mode do not require acknowledgement.
Therefore messages in this mode will not be redelivered
regardless of whether the delivery was successful.
Description
Provide a short description for the activity.
Event
The Event tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
147
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.
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 your JMS provider documentation for more information and syntax for a
message selector string.
Application
Properties Type
Any application-specific message properties that will be 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/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 join the Conversation here. Click the Joining existing conversation
existing conversartions.
button to join
Output
The following is the output for this activity.
Output Item
Datatype
Description
JMSHeaders
complex
The message header fields for the message. See JMS 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 JMS Propertiesfor
more information about message properties.
Only properties applicable to this type of message are displayed.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
148
Output Item
Datatype
Description
Body
as per
message type
The body of the message.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
ActivityTimedOutExcepti
The specified timeout has been attained and the activity has not
completed its execution.
on
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
149
Mail Palette
The Mail Palette is used to receive incoming emails or send outgoing emails.
SMTP Resource
At TIBCO we use reference topics extensively to document the screens of wizards and other material
that lends itself to a tabular presentation. We might later use reference topics for programming guides
or similar reference materials and create a separate boilerplate for that usage.
Receive Mail
The Receive Mail process starter polls a POP3 mail server for the new mail. After detecting and
retrieving a new mail, the Receive Mail process starter starts a new process for the process property it
resides in, and passes the mail data to the next activity in the process flow.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property/
Process
Property
Description
Name
None
Name to be displayed as the label for the activity in the process.
Host
Yes
Host name or IP address for the mail server.
Port
Yes
The default port (110) used to connect to POP3 server. To configure
your server for using a different port, specify it in this field using the
syntax: <hostName>:<portNumber>
For example, myMailServer.myCo.com:76
User Name
Yes
Username for logging into the POP3 server.
Password
Yes
Password for logging into the POP3 server.
Polling
Interval
(sec)
Yes
Polling interval (in seconds) to check for new mail. Default is 5, if no
polling interval is specified.
Delete Mail
None
If this check box is selected, mail is deleted from the POP3 server
after process starter has retrieved it.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
150
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.
This button is enabled only when the Host, Username, and Password fields on the General tab are
populated.
Description
Provide the receive mail message 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 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 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 checkbox to send the raw message to a Java Code activity that uses the
Java Activation framework to implement the appropriate handlers to process the
message. For more information on how the Java Activation framework can be used
for this purpose, 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. In such
case, the default javax.mail API handler is used.
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 stored in memory. This
allows you to accept large incoming messages without consuming more memory.
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™ Express Palette Reference
151
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, 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 the
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 defined corresponding output headers of the same name.
Conversations
You can initiate the Conversation here. Click the Add New Conversation button to initiate multiple
conversartions. For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application
Design.
Output
The following is the output for the activity.
Output Item
Datatyp
e
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™ Express Palette Reference
152
Output Item
Datatyp
e
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.
Description
You can either provide the bodyText element or fileName element.
mimeEnvelopeEl
ement
complex
This field ia available when the Provide Raw Message checkbox 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.
Mime headers 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/*":
binaryContent |
fileName |
textContent
choice
●
the attachment content must be in the binaryContent
input element, or
●
the file name storing the attachment must be in the
fileName input element.
This element contains the mime attachment. It can be either of the
following:
●
binaryContent - content of the attachment when the attachment
is binary data.
●
fileName - the file name of the attachment written on the disk.
●
textContent - content of the attachment when the attachment is
text data.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
153
Send Mail
The Send Mail activity sends an email by way of a SMTP server.
General
The General tab has the following fields.
Field
Literal
Value/
Module
Property?
Description
Name
No
The name to be displayed as the label for the activity in the process.
SMTP
Property
Yes
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.
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 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. The Input Editor tab allows you to
define a custom schema for the headers of the outgoing mail message. You can specify any standard
header supported by the javax.mail package. For example, X-Mailer or X-Priority.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
154
Input Item
Datatype
Description
username
string
Username to use when authenticating to the mail server.
password
string
Password to use when authenticating to the amil 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.
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
Subject of the email.
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
155
Input Item
Datatype
Description
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
(where * is a valid subtype of the multipart).
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.
mimeEnvelopeEl
ement
complex
Contains the message attachments.
mimePart
complex
This repeating element comprises each mime attachment.
mimeHeaders
complex
This element contains the mime header for each mimePart.
Mime headers 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, or
●
the file name storing the attachment must be in the
fileName input element.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
156
Input Item
Datatype
Description
binaryContent |
fileName |
textContent
choice
This element contains the mime attachment. It can be either of the
following:
●
binaryContent - content of the attachment when the
attachment is binary data.
●
fileName - the file name of the attachment written on the disk.
●
textContent - 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
Mail server host name is not resolved.
The exception contains name of the mail server host.
SendFailedException
The send operation failed for any reason.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
157
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.
Parsing a Large Number of Records
The input for this activity is placed in a process varaible 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.
To process a large number of records, do the following:
Procedure
1. Create a Parse Data activity.
2. On the General tab, specify the fields and select the Manually Specify Start Record checkbox.
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.
Data Format
The Data Format is a resource that contains the specification for parsing or rendering a text string using
the Parse Data and Render Data activities.
Resource
The Data Format 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, and 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
158
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. Rendering is the reverse of the process illustrated in Parsing a Text String into a
Data Schema.
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. Parsing a Text String into a Data
Schema illustrates a series of input lines containing comma-separated fields, each record on one line.
In some situations, you may not be able to choose a column separator character that does not 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 (" "). Double quote also allows you 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, howeer,
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.
Data Format Editor
This editor contains General and Data Format Configuration sections.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
159
General
The General section has the following fields.
Field
Description
Name
The name to to be displayed as the label for the resource.
Description
A short description of the data format.
Data Format Configuration
The Data Format Configuration allows you to define the structure of the data file.
Field
Description
Format Type
The Type of formatting for the text. The text can be either "Delimiter separated" or
"Fixed Format".
In delimiter-separated text, each column is separated by a delimiter character,
specified in the Col Separator field. Each line is separated by the character
specified in the Line Separator field.
In Fixed format text, each column occupies a fixed position on the line. For fixed
format text, you must specify the Fill Character, the line length, and the column
offsets. See for more information.
Col Separator
This field specifies one or more separator characters between columns when
"Delimiter separated" is specified in the Format Type field.
When rendering text, each element in the input data schema is separated by the
column separator in the output text string. If more than one character is specified in
this field, the Render Data activity places the entire string specified in this field
between each column. For example, if ":;" is specified in this field, then ":;" 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.
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 ":;"then Apple;Orange:Pear is treated as three
columns.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
160
Field
Description
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.
TIBCO BusinessWorks does not support specifying the line separator as
part of the dat
Fill Character
When processing fixed format columns, this is the type of character that is used to
fill the empty space in a column and between columns. This is only available when
"Fixed format" is specified in the Format Type field. This fill character is only used
by the Render Data activity.
You can select one of the following for this field:
●
Space - fills with a space
●
Dash - fills with a dash
●
Others - allows you to specify your own custom fill character in the Fill With
field.
For example, you have a column that holds an integer and the specified width is 10.
One row has the value "588" for that column. Because the width of 588 is three and
the column width is 10, the remaining 7 characters are filled with the specified fill
character.
Data Format Editor
You can define your own data format in this area in the form of an XML schema. You can reference
a .XSD schema stored in the project or create a new schema in this window . Clicking the Create New
Schema button in the Select Schema Element Declaration window opens a Create XML Schema
window. Here you can complete an XML schema by adding either primitive or complex elements to
each header.
Field Offsets
When processing fixed format text, you must specify the line length and the column offsets. This allows
a Parse Data or Render Data activity to determine where columns and lines begin and end. The Field
Offsets area allows you to specify the format of fixed-width text.
The line length is the total length of each input lines, including the line separator character(s). 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
161
It is a good idea to have each column offset begin where the last column offset ended. Many fixed
format data files are used by databases (for example, ISAM files) or are generated by automated
processes. These types of files have rigid file record formats and may not have additional padding
space between columns.
When you define each column offset to begin where the last column offset ends, you can read the data
more quickly by TIBCO AcitveMatrix BusinessWorks because the bytes of the input records can be read
sequentially.
Consider the following text file. The first two lines of the file indicate offset numbers (each 0 indicates
another 10 characters), and the fill character between columns is spaces:
0
12
30
45
01234567890123456789012345678901234567890123456789012345678
57643
Smith
Chris
Account
57644
Jones
Pat
Marketing
57645
Walker
Terry
Development
Parse Data
The Parse Data activity takes a text string or input from a file and processes it, converting it into a
schema tree based on the specified Data Format shared resource.
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, or you can retrieve a text field from an adapter message.
You can also specify a text file to read using this activity.
You can use this activity in a number of scenarios. For example, you have a file comprising multiple
lines with comma-separated values (as in data obtained from a spreadsheet). Now you want to insert
this data into a database table. To do this, 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 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
162
Field
Skip Blank
Spaces
Module
Property?
No
Description
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
Allows you to 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 field is checked, all lines in the input must contain
three fields.
Continue on
Error
No
Continues parsing the next record in the input after
encountering an error, if any.
If an error occurs, the error information is separated from the
output of the successfully parsed records and is provided in teh
output schema of the activity.
When this field is not selected, parse data activity quits parsing
if an error is encountered while parsing the records in the
input.
Irrespective of whether this field is checked or not, the Parse
Data activity quits when any data validation errors occur.
Input
The following is the input for the activity.
Input Item
Datatype
Description
text
string
The text string to parse.
This input item is only available when String is specified in the
Input Type field of the General tab.
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 only available when File is specified in the Input
Type field of the General tab.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
163
Input Item
Datatype
Description
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.
SkipHeaderChar
acters
integer
The number of characters to skip when parsing. This allows you to
skip over any file headers or other unwanted information.
Output
The following is the output for 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
complex
ErrorRows
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 Continue on Error is selected, and
error(s) while parsing the records in the input.
Raw input data is put in the error string.
This field contains the list of error lines for the records from the input
that failed parsing.
EOF
boolean
if no more records are available for parsing. false if there are
more records available.
true
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
164
Fault
Thrown When..
FileNotFoundException
The specified input file cannot be located.
BadDataFormatException
The input format is not valid.
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.
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 a number of 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.
●
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 so that you can render more than one output record.
Output
The following is the output for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
165
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 TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown When..
BadDataFormatException
The output format is not valid.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
166
REST and JSON
The activities of REST and JSON Palette can be used to invoke RESTful web services and expose
BuisnessWorks processes as RESTful web services. The activities in this group can also be used to
convert data between JSON format and XML format.
Parse JSON
The Parse JSON activity takes the JSON data, processes it, and converts it into an 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 a schema type for the output data. The following are
the supported schema types:
●
Generic
●
XSD
The default value in this field is the XSD schema type.
Badgerfish
None
Specifies the following conversion rules:
●
Select this check box for converting JSON data to XMLdata
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.
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 JSON tools to generate an XML schema file with a specified JSON file.
Input
The Input tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
167
Field
Description
jason 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 in the General tab.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown when...
JSONParseException
An exception occurred when parsing JSON data.
Render JSON
The 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
Description
Name
None
The name to display as the label for the activity in the process.
Schema Type
None
Specifies a schema type for the output data. The following are the
supported schema types:
●
Generic
●
XSD
●
Java Classes
The default value in this field is the XSD schema type.
Badgerfish
None
Specifies the following conversion rules:
●
Select this check box for converting JSON data to XMLdata
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
168
Field
Literal
Value/
Process
Property/
Module
Property
Jar Location
None
Description
The absolute path and name of a POJO class resource, which is
used to define a schema for the output data. Make sure that the
POJO class resource is in JAR format.
This field is only available when the Java Classes schema type is
selected.
Root Class
None
The class pointing to a root Java class.
This field is only available when the Java Classes schema type is
selected.
Remove Root
None
Specifies whether or not to remove the root element in the output
JSON string.
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 JSON Tools to generate an XML schema file with a specifed JSON file.
Input
The input data for the Render JSON activity is in 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.
Output
The Output tab contains the following field.
Field
Description
jasonString
The translated data in JSON string format.
Fault
The Fault tab lists the possible exceptions thrown by this activity. See TIBCO ActiveMatrix
BusinessWorks Error Codes for more information about error codes and corrective action to take.
Fault
Thrown when...
JSONRenderException
An exception occurred when rendering the data.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
169
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 TIBCO ActiveMatrix BusinessWorks palette
for the protocol. For example, using the TCP palette to handle 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.
The following is the general sequence of events when using the TCP palette resources:
Procedure
1. Create a TCP Connection shared configuration resource that describes the connection information.
2. One of the following occur, depending on whether the process is a TCP client or server:
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 either starts 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 TCP connection
in the process.
4. After the process is complete, close the TCP connection using the TCP Close Connection activity.
TCP Connection
The TCP Connection is a shared resource that specifies the connection information for the TCP server.
This resource is used when a process definition acts as a TCP client connecting to a remote server or
when a process definition acts as a TCP server accepting incoming TCP.
The TCP Connection is a shared resource that specifies the connection information for the TCP server.
This resource is used when a process definition acts as a TCP client connecting to a remote server or
when a process definition acts as a TCP server accepting incoming TCP. A shared resource can be
created at the Resources folder level by right-clicking and clicking the New button. For more
information on creating a shared resource, refer to the TIBCO BusinessWorks Process Design Guide.
General
Field
Module
Property?
Description
Name
No
The name of the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
170
TCP Connection
Field
Module
Property?
Host
Yes
Description
When a process definition acts as a client, this field specifies the host
name or host IP address of the TCP server to connect to.
When a process definition 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 wish to use to accept TCP/IP connections.
Port
Yes
This field specifies the port number on which a TCP server is listening
for requests.
Read TCP Data
The Read TCP Data activity reads data from an open TCP connection. The connection must be opened
by an activity or process starter that executed previously in the process.
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?
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.
Description
Specifying Text in this field enables the Separator and Encoding
fields. When Binary is specified, the Bytes To Read field is
enabled.
Separator
Yes
The type of separator. This activity reads data from the TCP
connection until the separator or the end of the data stream is
encountered.
Select User-defined binary separator (specify comma-separated
byte values) from the drop-down list to enable User Defined
Separator field.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
171
Field
User Defined
Separator
Literal
Value/
Module
Property/
Process
Property?
Description
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
172
Input Item
Datatype
Description
separator
string
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.
bytesToRea
d
number
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
Optional element. Time to wait (in milliseconds) for this activity to
complete.
Output
The following is the output for 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.
endOfStreamRea
ched
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
The TCP Close Connection activity closes a TCP connection opened by a previously executed activity or
a process starter.
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™ Express Palette Reference
173
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
The TCP Open Connection activity 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.
Input Item
Datatype
Description
connection
complex
Optional element. This element contains the information about the
TCP server you want to connect to. It comprises host, port, and
localhost elements.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
174
Input Item
Datatype
Description
host
string
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
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
Optional element. The name or the IP address of the TCP client.
Output
The following is the output for 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
The TCP Receiver process starter starts a new process when a client requests a TCP connection. When a
connection request occurs, the process starter places a handle to the open connection in the connection
output element. The subsequent activities in the process use this connection 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.
Port
Yes
Specify the port number on which this TCP server is listening for
requests.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
175
Literal
Value/
Module
Property/
Process
Property?
Field
Enable DNS
Lookup
None
Description
Select this check box to enable a Domain Name System (DNS)
lookup for resolving the IP address to a DNS name.
Caution: 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
multiple conversartions.
button to initiate
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
Output
The following is the output for 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.
IP
string
The IP address of the client sending the TCP request.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
176
Output
Item
Datatype
Description
Host
string
The host name of the client sending the TCP request. This field is
available only when the Enable DNS Lookup field in the General tab
is selected.
Port
integer
The port number of the client sending the TCP request.
Wait for TCP Request
The Wait for TCP Request activity 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
Caution: 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.
Event
The Event tab has the following fields.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
177
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 conversartions. Click the Add New Conversation
button to
button to initiate conversartions.
For details about Conversations, refer to TIBCO ActiveMatrix BusinessWorks Application Design.
Output
The following is the output for 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
IP address of the client sending the TCP request.
Host
string
Host name of the client sending the TCP request. This field is available
only when the Enable DNS Lookup field in the General tab is
selected.
Port
integer
Port number of the client sending the TCP request.
Write TCP Data
The Write TCP Data activity 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.
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Name
None
The name to be displayed as the label for the activity in the process.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
178
Field
Literal
Value/
Module
Property/
Process
Property?
Description
Type
None
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
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.
separator
binary
Optional element. This is available only when the User
Separator option is selected on the General tab.
Defined
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
179
Output
This activity has no output.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
180
XML Activities Palette
The XML Activities palette provides activities for parsing XML strings into schemas and rendering
schemas into XML strings.
Parse XML
The Parse XML activity takes a binary XML file or an XML string and processes it, converting it into an
XML schema tree based on the XSD specified.
Parsing Date and Datetime Strings
In XML documents parsed by the XML Parser activity, datetime values are read in according to the
ISO-8601 standard, as described in the XML Schema specification. For example, the value:
2002-02-10T14:55:31.112-08:00
is 55 minutes, 31 seconds, and 112 milliseconds after 2PM on February 10th, 2002 in a 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 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 default and preferred choice), 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, 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 intpu at run time.
Description
Provide a short description for the activity.
Output Editor
Use the Output Editor tab to define a schema for the XML output.
Input
The following is the input for the activity.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
181
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 the Input Style field in the General tab is set to binary.
This input item contains a required bytes item for which you specify
the input XML bytes.
This input item also contains an optional forceEncoding item. This
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 runtime.
Output
Output Item
Datatyp
e
XML Schema
complex
Description
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
Description
XMLParseException
An exception occurred when parsing the data.
UnsupportedEncodi
An unsupported encoding was specified in the forceEncodign input item.
ngException
MissingByteCountE
xception
Render XML
The Render XML activity takes an instance of an XML schema element and renders it as a stream of
bytes containing XML or an XML string.
The 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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
182
Rendering Date and Datetime Strings
When TIBCO ActiveMatrix BusinessWorks Express generates datetime strings, it always uses the UTC
time. For example, the time 55 minutes, 31 seconds, and 112 milliseconds after 2PM on February 10th,
2002 would be represented as the following by the Render XML activity: 2002-02-10T14:55:31.112Z
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.
Format Using
Default
Namespace
Prefix
No
Prepends the namespace with the default namespace prefix.
Encoding
Yes
This field is only available 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 that allows you to 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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
183
Input Item
Type
Description
byteEncodi
ng
string
This is only available when the Output Style field in the General tab is
set 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 si 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. Encoding names are case sensitive.
XML
Schema
string
The XML schema to render. The contents fo the schema are determined
by the schema specified in the Input Editor tab.
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.
Output
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
FileNotFoundException
An exception occurred when rendering the data.
UnsupportedEncodingExce
An unsupported encoding was specified in the byteEncoding input
item..
ption
MissingByteCountExcepti
on
Transform XML
The Transform XML activity 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 allows you to use the
XSLT file instead of manually creating the mappings.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
184
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 will override the stylesheet specified in
this field.
Input and
Output Style
Specifies whether the input and output is binary data, text, or an XML tree.
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.
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.
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
185
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 text is
selected ffor 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 tree is
selected.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
Fault
Thrown When..
XMLTransformException
An exception occurred when transforming the data.
UnsupportedEncodingExce
Data was supplied that is encoded in an unsupported encoding.
ption
MissingByteCountExcepti
on
TIBCO ActiveMatrix BusinessWorks™ Express Palette Reference
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement