TIBCO BusinessWorks Container Edition Palette Reference · Render Data ... Activity Icons...

TIBCO BusinessWorks™ Container EditionPalette ReferenceSoftware Release 1.0November 2015

Two-Second Advantage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCHEMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THEEMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANYOTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS ANDCONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTEDSOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THECLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USERLICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THESOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BEBOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright lawsand treaties. No part of this document may be reproduced in any form without the writtenauthorization of TIBCO Software Inc.

TIBCO, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Enterprise Message Service,TIBCO Business Studio, TIBCO Enterprise Administrator, TIBCO ActiveSpaces, TIBCO Runtime Agent,TIBCO Designer, TIBCO BusinessWorks Container Edition, TIBCO BusinessWorks Studio ContainerEdition and Two-Second Advantage are either registered trademarks or trademarks of TIBCO SoftwareInc. in the United States and/or other countries.

Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform EnterpriseEdition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks ofOracle Corporation in the U.S. and other countries.

All other product and company names and marks mentioned in this document are the property of theirrespective owners and are mentioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOTALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASEDAT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWAREVERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICALERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESECHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCOSOFTWARE 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 ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

Copyright © 2001-2015 TIBCO Software Inc. ALL RIGHTS RESERVED.

TIBCO Software Inc. Confidential Information

2

TIBCO BusinessWorks™ Container Edition Palette Reference

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Changing Help Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Basic Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Critical Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Constructor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

For Each . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Iterate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Repeat on Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

While . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Receive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Compensate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Empty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

Exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Get Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Rethrow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Set Context . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Set EPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Throw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23

REST Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Rest Service Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

REST Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

SOAP Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28

Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

SOAP Service Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

SOAP Reference Binding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

General Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Assign . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Call Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Confirm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Get Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40

Inspector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

3


Mapper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Set Shared Variable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Timer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

HTTP Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

HTTP Receiver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

Send HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Sending Data in the HTTP Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Send HTTP Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66

JAVA Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70

Converting JAVA Class to XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Creating Custom XPath Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Using Custom XPath Function at Design Time and Run Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Deleting Custom XPath Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

JAVA Invoke . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

Java Process Starter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Java To XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

XML To Java . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

JDBC Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

JDBC Call Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89

JDBC Query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

JDBC Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

SQL Direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

JMS Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102

Common JMS Properties and Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Get JMS Queue Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

JMS Receive Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

JMS Request Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

JMS Send Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Reply to JMS Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119

Parse Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

Parsing a Large Number of Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

MimeParser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .122

Parse Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124

Render Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

REST and JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

BW JSON Utils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129

Invoke REST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Restrictions on XML Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Parse JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

4


Render JSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135

XML Activities Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Parse XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138

Render XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140

Transform XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Shared Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

Data Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

HTTP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147

HTTP Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Identity Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155

JDBC Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

JMS Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

JNDI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Java Global Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161

Keystore Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Proxy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163

SSL Client Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Thread Pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166

Activity Icons Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168

5


Figures

Parsing a Text String into a Data Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144

6


TIBCO Documentation

Documentation for this and other TIBCO products is available on the TIBCO Documentation site:

https://docs.tibco.com

Documentation on the TIBCO Documentation site is updated more frequently than any documentationthat might be included with the product. To ensure that you are accessing the latest available helptopics, please visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO products is not bundled with the software. Instead, it is available on theTIBCO Documentation site.

The following documents for this product can be found on the TIBCO Documentation site:

● Concepts● Installation● Getting Started● Application Development● Palettes Reference● Samples● Error Codes● Conversion

How to Contact TIBCO Support

For comments or problems with this manual or the software it addresses, contact TIBCO Support:

● 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 canrequest one.

How to Join TIBCOmmunity

TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is aplace to share and access the collective experience of the TIBCO community. TIBCOmmunity offersforums, blogs, and access to a variety of resources. To register, go to the following web address:

https://www.tibcommunity.com

7




http://www.tibco.com/services/support

https://support.tibco.com

https://www.tibcommunity.com

Changing Help Preferences

By default, documentation access from TIBCO Business Studio is online, through the TIBCO ProductDocumentation site (Doc site) at https://docs.tibco.com/which contains the latest version of thedocumentation. Check the Doc site frequently for updates. To access the product documentationoffline, download the documentation to a local directory or an internal web server and then change thehelp preferences in TIBCO Business Studio.

Prerequisites

Before changing the help preferences to access documentation locally or from an internal web server,download documentation from https://docs.tibco.com/.

1. Go to: https://docs.tibco.com/

2. In the Search field, enter and press Enter.

3. Select the product from the list. This opens the product documentation page for the latest version.

4. Click Download All.

5. A zip file containing the latest documentation downloads to your web browser's default downloadlocation. Copy the zip file to a local directory or to an internal web server and then unzip the file.

To change help preferences on the Preferences dialog to access the documentation from a customlocation:

Procedure

1. In TIBCO Business Studio, click Window > Preferences. On Mac OS X, click TIBCO BusinessStudio > Preferences.

2. In the Preferences dialog, click BusinessWorks > Help.

3. Click Custom Location and then click Browse to select the html directory in the folder where youunzipped the documentation, or provide the URL to the html directory on your internal web server.

4. Click Apply and then click OK.

8


https://docs.tibco.com/

https://docs.tibco.com/

Basic Activities Palette

Basic activities are a simple means of interacting with a service, manipulating the passing data, orhandling exceptions. They also contain Loops that are Groups with Conditions, which follow a patternat run time such as, initialize the loop, update the loop at each iteration, and test conditions for the loopto stop iterating. The available types of loops are: For Each, Iterate, Repeat, Repeat On Error, Scope,and While.

Critical SectionCritical Section groups are used to synchronize process instances. The engine can execute multipleprocess instances concurrently. You can use Critical Section groups to synchronize the set of actionsperformed in the process across multiple process instances. Only one process instance can execute thecritical section group and its contents at any specified time. Other concurrently running processinstances that are associated with the corresponding critical section group wait at the start of the criticalsection group, until the process instance that is currently executing complete the critical section group.

General

The General tab has the following fields.

Field Description

Name The name to be displayed as the label for the group in the process.

Group Type The type of the group. The default is Critical Section.

Timeout The maximum time (in milliseconds) that a process instance waits at the startof the critical section group while another process instance is executing thecritical section. When a timeout occurs, the process instance that is waiting toexecute the critical section fails with an Activity Timeout Exception.

The timeout field can be used to avoid deadlock situations.

Shared Lock Select this check box to synchronize multiple critical section groups that usethe same shared variable as a lock.

Shared VariableType

The Shared Lock option can be defined using a Module Shared Variable or aJob Shared Variable. When a module shared variable is used against jobshared variable to define Shared Lock, it has different implications.

● Module Shared Variable: provides a shared lock to synchronize processinstances from different processes that are within a module. Using amodule shared variable, you can synchronize multiple Critical Sectiongroups that can be part of different process instancse. These CriticalSection groups can be in the same process or in another process, providedall processes are contained within a module.

● Job Shared Variable: provides a shared lock to synchronize within a job.Using a job shared variable, you can synchronize multiple Critical Sectiongroups that are part of the same job. These Critical Section groups can bein the same process or in an another process, provided all process instancesare part of the same job.

Shared Variable Name of the Module Shared Variable or Job Shared Variable.

9


Description

Provide a short description for the group in this field.

Variables

The Variables tab provides a way to declare variables that are only limited to the scope of this group.

You can select from the following available Variable Type options:

● String● Integer● Decimal● Boolean● Date&Time

ConstructorYou must use the constructor for each class to instantiate that class.

InvokeInvoke activity is an asynchronous activity that calls an operation of a process reference. The processreference can be configured to invoke another process (subprocess) or invoke an external servicethrough a binding such as SOAP.

General


Field Description

Name The name to be displayed as the label for the activity in the process.

Service Select the service for which to specify an operation.

Description

Provide a short description for the activity.

Advanced

The Advanced tab has the following field.

10


Input item

LiteralValue/ModuleProperty? Description

ActivityTimeout(seconds)

Yes The Invoke activity timeout in seconds. You can either select a presettimeout (Default Timeout, 30, 60,or 120 seconds) or specify a customtimeout in seconds.

If the Invoke activity is configured to be Default Timeout,then the timeout value equates to "3" minutes by default.

When the Invoke activity timeouts, the in-line subprocessinstance called by the Invoke activity can be cancelledbefore the subprocess instance completes. Hence, thebusiness logic in the cancelled process instance may not beexecuted to its entirety.

Input

The following is the input for the activity.

Input item Datatype Description

input message complex The input message of the operation. This element contains allthe input message parts for the operation.

Output

The following is the output for the activity.

Outsput item Datatype Description

output message complex The output message for the operation. This element contains allthe output message parts for the operation.

For EachThe For Each group is a loop element that can be used for iterating through array elements. The ForEach activity is very useful to determine these array elements dynamically at run time.

General


Field Description


Group Type The type of group. The default is For Each.

Counter Name The name of the counter or Index variable.

11


Field Description

Start Counter Value The start value for the counter ($index) which is specified through an XPathexpression. This can be a literal value.

Final Counter Value The final value of the counter which is set using an XPath expression. Thisvalue is obtained by the count of the number of elements of a specific type inthe request message.

Description

Provide a short description for the activity in this field.

Variables

A group of shared variables. Depending on the group selected in Group Type, Container displays thegroup. For example, if the For Each group is selected in the Group Type field, it displays For Each inContainer. You can add multiple complex or simple types variables.



IterateAn Iterate group repeats the series of grouped activities once for every item in an existing sequence orlist. The list can be items of any datatype. The loop executes for the number of iterations specified.

This process performs the following operations:

1. A ReceiveRecords activity is use to receive a request. The request is then passed to theParseRecords activity.

2. The ParseRecords activity parses the request to XML records.

3. The group iterates once for each record returned by the ParseRecords activity, and write the recordsto the database using the StoreRecords activity.

4. Once the iteration group is complete, the process transitions to the SendStatus activity to send thestatus of the records.

12


General


Field Description


Group Type The type of group. The default is Iterate.

Index Name The index name.

Variable List This field is an XPath expression. XPath is used to specify the schema elementyou want to refer to.

Click the Edit XPath Expression icon to specify a value for this field in theXPath Builder wizard.

You can use a simple expression containing a complete list, or a more complexone and only process certain items in the list.

Iteration Element Provide a name for a process variable containing the current iteration elementin this field.

Global When this check box is selected, the output is available for the activities outsidethe loop.

AccumulateOutput

Select this check box to accumulate the output of one of the activities in agroup.

The output of the selected activity is accumulated each time the activity isexecuted.

Output Activity Select the activity from the group of activities to execute the loop.

Output Name The name of the list of the accumulated output of the selected activity.

Description


Variables

A group of shared variables. Depending on the group selected in Group Type, Container displays thegroup. For example, if theIterate group is selected in the Group Type field, it displays Iterate inContainer. You can add multiple variables of complex or simple type.



13


RepeatThe Repeat group activity is responsible for repeating the series of grouped activities until the specifiedcondition evaluates to true. The activities are always executed once before checking whether thecondition is true. After executing the series of activities, the initial evaluation of the condition is done,and it repeats when the condition evaluates as true. The Repeat activity evaluates the loop'sconditional statement to determine whether or not more iterations of the loop are required.

General


Field Description


Group Type The type of group. The default is Repeat.

Index Name Use this field to specify a name for the index variable.

Condition The condition ($index) is specified through an XPath expression which can be aliteral value. Click the Edit XPath Expression button to set an XPath expression.

Description


Variables

A group of shared variables. The Container displays the group. This depends on the group selected inGroup Type. For example, if the Repeat group is selected in the Group Type field, it displays Repeat inContainer. You can add multiple variables of complex or simple type.



Repeat on ErrorUsing the Repeat on Error group, you can repeat a series of activities when an unmanageable erroroccurs. The activities in this group are executed once. If there are no unmanageable errors, the loopterminates. If an error occurs for which there is no error transition, the condition of the loop isevaluated. If the condition is true, the loop terminates. If the condition is false, the loop repeats untilthere is no error or the condition is true.

General


14


Field Description


Group Type The type of group. The default is Repeat on Error.


Stop RepeatCondition

The condition specifies that the activities inside the Repeat On Error are performedrepeatedly until the condition evaluates to false.

Description


Variables

A group of shared variables. Depending on the group selected in the Group Type, the Containerdisplays the group. For example, if Repeat on Error group is selected in the Group Type field, itdisplays RepeatOnError in Container. You can add multiple variables of complex or simple type.



ScopeThe Scope group comprises a collection of nested activities. Scope group is shared by all the nestedactivities. You can use a Scope to contain a unit of work, by making it easy to manage, execute, andrevert. For example, if a customer cancels an online order, the money must be returned and the onlineorder canceled, without affecting other orders. You can use a Scope to manage these activities as a unit.

General


Field Description


Group Type The type of group. The default is Scope.

Description

Provide a short description for the group.

Variables

A group of shared variables. Depending on the group selected in the Group Type, the Containerdisplays the group. For example, if the Scope group is selected in the Group Type field, it displaysScope in Container. You can add multiple variables of complex or simple type.

15




WhileThe While activity repeats the series of grouped activities if the specified condition evaluates as true.The condition is evaluated when the group is enters. If the condition evaluates to false, the activitieswithin the group are not executed.

General


Field Description


Group Type The type of group. The default is While.


Condition The condition ($index) is specified through an XPath expression which can be aliteral value. Click the Edit XPath Expression button to set an XPathexpression.

Description

Provide a short description for the group.

Variables

A group of shared variables. Depending on the group selected in the Group Type, Container displaysthe group. For example, if the Scope group is selected in the Group Type field, it displays Scope inContainer. You can add multiple variables of complex or simple type.



16


ReceiveReceive activity initiates the process execution based on the receipt of a request message for anoperation of the process service.

General


Field Description


Service Select the process service and the operation from which to receive the request.

Description


Output Editor

The schema of the process variable must match the schema of the output of the activity shown on theOutput tab.

Output

Output Item Datatype Description

output varies The output of this activity is the incoming message from thecalling client or service. The structure of the message isdetermined by the schema of the input message for the selectedoperation on the General tab.

CompensateCompensate activity is executed only from the compensation handlers when a fault is encounteredoutside a scope (this scope will have compensation handler defined). This activity triggerscompensation handler for a scope present only on the same level. All activities present in scope getexecuted successfully.

The compensation handlers are defined per scope. The compensation handlers of scopes that aredirectly enclosed by the scope and contain Compensate activity, can be executed. The handlers executein reverse order, so the handler of the last completed scope is executed first. The compensationhandlers can only be defined on scope level.

General


Field Description


17


Description


EmptyAn Empty activity denotes an activity with no action to be performed. You can specify the Name andDescription, but there is no input or output for this activity.

This activity is useful if you want to join multiple transition flows. For example, there are multipletransitions out of an activity and each transition takes a different path in the process. In this scenarioyou can create a transition from the activity at the end of each path to an Empty activity to resume asingle flow of execution in the process.

ExitExit activity is a synchronous activity that cancels any asynchronous activities that are in a waiting stateand terminate the process instance. You can specify the Name and Description, but there is no input oroutput for this activity.

Get ContextGet Context activity retrieves the value of the specified context parameter. This is useful if your processrequires some context information from a request or a response.

GetContext activity must be placed after Invoke or Receive activity.

General


Field Description


Direction Select from the following available options to specify from where the contextinformation should be fetched:

● Receive Service: pulls context information from a service request. Selecting thisoption displays the Service field.

● Return from Reference: pulls context information from a reference response.Selecting this option displays the Reference field.

● Fault from Reference: pulls context information from a reference fault response.

Service/Reference

Select the targeted portType and operation from where the context information is tobe picked.

Fault This field is displayed when Fault from Reference option is selected in theDirection field.

Description


18


Output



<schema> varies The value of the context resource specified in theDirection field of the General tab is the output for thisactivity. The schema for the output is determined by theschema specified for the context resource.

RethrowRethrow activity is used within an exception-handling routine to throw the caught error again. This isuseful if you want to perform some processing within an error-handling routine, and also send it to thenext higher scope.

ReplyReply activity is a synchronous activity that sends a message in response to a request message that wasreceived for an operation of a process service. This activity can be used to send a reply or a fault.

General


Field Description

Name The name to be displayed as the label for the activity.

Service Select the process and the operations for which to send a response.

Reply With Select from the following available options to send the reply message:

● Output Message● Undeclared Fault

Description


Input Editor

The schema of the process variable must match the schema of the input for the activity shown on theInput tab.

Input

Input Item Datatype Description

input varies The reply message to send. The schema depends on the outputmessage of the operation for this reply.

19


Set ContextSet Context activity can be used to set the value of a context information resource.

SetContext activity must be placed before Invoke or Receive activity.

General


Field Description


Direction Select from the following available options to specify where the contextinformation should be supplied:

● Invoke Reference: Selecting this option displays the Reference tab.● Reply to Service: sends context information to a service. Selecting this option

displays the Service field.● Reply to Service with Fault: sends context information for a service fault

reply.

Service/Reference

Select the targeted portType and operation where you want to supply the contextinformation.

Fault This field is displayed when Reply to Service with Fault option is selected in theDirection field.

Description


Input



input message complex The input message of the operation. This element contains allinput message parts for the operation.

Set EPRSet EPR activity is a dynamic alternative to the static service element defined in the WSDL. To use anincoming message, define the EPR schema as a part of the message in the WSDL.

An endpoint reference (EPR) combines web services elements that define the address for a resource in aSOAP header. If you use an incoming message, an EPR schema should be defined as a part of themessage in WSDL.

General


20


Field Description

Name The name to be displayed as the label for the activity.

DynamicReference

The name of the dynamic target interface for which this task is supplying theservice name and namespace

Description


Input


Input Item Description

SimpleEndpointReference

Contains endpoint address information for the destination of the outgoingmessage

Output


Output Item Description

EndpointReference Contains the following elements:

● Address: Endpoint address● Interface: The name of the dynamic target interface for which this task

is supplying the service name and namespace

ThrowThrow activity throws the specified fault and the control is passed to any error-handling routinedefined to handle the error. This activity is useful in a group or in a called process. You can use thisactivity to catch and raise your own error conditions. The Throw activity is useful if an error in thebusiness logic occurs during processing.

General

The General has the following fields.

Field Description


Default Fault Select this check box if you want the default message text and error code forthe error message.

This is reflected in the Input Editor and Input for this activity.

21


Description


Input Editor

Selecting the Default Fault check box displays the message and msgCode elements in the Input Editor.

Input



message string The text of the generated error message.

msgCode string The error code of the error message. This is used as an identifierfor the error for the applications to test for an error.

Fault

This activity does not produce any fault.

22


Binding

Binding is used to establish a connection between SOA Services and their consumers. They arecommunication gateways to connect to the external world. They follow a well-known communicationprotocol that both client and service are aware of.

The two types of binding components are:

● Service Binding: used to create and expose a service to the external world. The service can containone or more operations. Once exposed, the service can be consumed by its clients.

● Reference Binding: used to create a client that can connect and communicate to an external service.

REST BindingREST Binding provides external connectivity for REST over HTTP. You can specify custom HTTPheaders and parameters using REST binding. It supports GET, PUT, POST, and DELETE HTTPmethods. It also supports JSON, XML, and plain text message types.

Binding

This section has the following fields.

Field Description

Resource The name of the resource.

Resource ServicePath

Specify the path of the Service Resource.

HTTP ConnectorName

The name of the HTTP Connector.

Click on the HTTP Connector Name field to display details aboutthe HTTP Connector resource.

Request ClientFormat

The type of request message format.

The two available request message type options are: Body and Form.

● Body: Provides two request body format option: JSON and XML. Both orany one of these options can be used.

● Form: This option can be used to inject the parameters of a Web form intoa RESTful web service.

Reply Client Format The type of reply message format.

The two available reply message format options are: JSON and XML.

Operations

This section shows the following details.

Field Description

Name The name of the HTTP method used, for example, GET, PUT, POST, andDELETE.

23


Field Description

Nickname The specified name of the service, for example, getBooks.

Operation Details


Field Description

Summary This tab has the following available options:

● Summary: The summary of the REST resource● HTTP Method: Displays the HTTP Method specified in the Operations

section. These are the available HTTP methods:

— POST— GET— PUT— DELETE

Request Specifies the resource created, using the POST method.

Request and Response depend on the method selected.

24


Field Description

Response This tab has the following available options:

● Use HTTP Headers: Selecting this check box includes the REST Webservice application (or client) within the HTTP headers and body of arequest, all of the parameters, context, and data required by the server-side component to generate a response.

● Use Custom Status Line: You can specify a custom status line (statuscode and reason phrase) to the outgoing message. The codes used mustbe defined in the configuration under the Response Status tab.

● Response with Status Code Only: The operation returns a status code asresponse, when this check box is selected. Message body is not required.For example, using a POST operation returns a 201 status code whichmeans "Created" and responds with the resource URL.

● Resource Schema: Displays the schema selected. This option is notavailable when the Use Custom Status Line and Response with StatusCode Only check boxes are selected. These are the available options:

— String— Integer— Boolean— XSD element: Selecting this option to either select the XSD schema

element available under the Schemas folder of your project or acreate new XML schema resource. Click Create New Schema to acreate new XML schema resource using the Simplified Schema Editorwizard.

Response Status Specifies the response code for the operation and the code message. Forexample, code 201 means Created or code 503 means Service Unavailable.

You can also add your own custom code and reason phrase.

Parameters


Parameter Name Type Required

Parameter name ofthe operation used

The parameter type. It can be anyone of the following:

● String● Integer● Boolean

Whether this parameter is required.The available options are Yes or No.

Working with Path and Query Parameters

TIBCO Businessworks Container Edition REST binding supports the use of path parameters for theresource service path (for example, /books/{isbn} instead of /books} in the REST service. The usermust specify every parameter by enclosing it in brackets { }. For example, /book/{isbn} specifies

25


the user can have isbn as a parameter. The client invokes this service using the URL http:/<host>:<port>/book/<isbn> where <isbn> is an actual value. Using the path parameters combinedwith static URL, for example, /book/{isbn}/events, is also supported.

The Query and Path parameter names should not be same as the Form parameters name. For example,if Form parameter contains name as one of its parameter, the following path and query parameters arenot allowed and throws an exception:

/resource/{name}

/resource?name={name}

All the parameters defined in the resource service path are made available to the user as an Input forevery operation. Refer to Support for Path and Query Parameters. See the following image for the /book/{isbn} ) example to see the Input for the GET operation.

About Swagger UI

Using the Swagger UI you can visualize RESTful services. It specifies the format (URL, method, andrepresentation) to describe REST the web services.

Authentication support has been added to the REST binding. Hence, the Swagger UI displays BasicAuth Username and Password fields, regardless of whether the Authenticate check box is selected ornot selected in REST binding.

Partial Response in REST

Using the Partial Response feature in REST, you can retrieve only the data you need, instead of bulkdata as a response. You can also request only those fields that are required as part of the response.

For example, in the Swagger UI to select the immediate children nodes of an object, specify the requiredfield names separated by comma such as ISBN, author, bookName, and so on.

The partial response feature uses a fields query parameter.

The fields keyword is reserved to be used internally by BusinessWorks Container Edition. Adding thefields keyword as a query parameter automatically triggers support for partial responses.

Partial responses do not support selecting particular objects from an array. For example, using thefields keyword for /books/isbn, the isbn's of all the books are returned.

Format: The values of the fields keyword can be a comma separated value of fields of the responsemessage. Fields can be specified directly, for example, using isbn or hierarchy /book/isbn.

26


Rest Service WizardRest Service Wizard is used to create new Businessworks Rest Resource or add Rest Services to anexisting resource.

The Rest Service Wizard has the following fields:

Field Description

Resource Name The name of the BusinessWorks Container Edition REST Resource.

Summary The summary or description of the REST Resource.

Resource ServicePath

The relative path for this REST Service.

Type of Resource This field has two options: Collection or Single.

For example, Books is a collection resource and Book is a single resource. Thisis dictated by the schema element used in the Resource Schema field.

Resource Schema The XSD schema element to be used for creating the REST resource.

You can also use this to create the input and output of each operationdefined. You can override this on the next screen if required, for eachoperation.

Operations These are the HTTP methods implemented by this REST Service.

Currently BusinessWorks Container Edition only supports POST, GET , PUTand DELETE methods for users to implement.

27


Field Description

Implementation Data The implementation data field can be Structured or Opaque.

● Structured: The XSD element structure is preserved for the input andoutput of every operation. You need not manually parse the payload togenerate the actual element to be used in the process.

● Opaque: Use this mode to apply the pass through mechanism. A usergets a messageBody element in the input or output of every operationand needs to use either Parse activities for JSON or XML to get aStructured output for the payload.

To add additional services to an BusinessWorks Container Edition process, click the Create A Rest

Service icon on the top left of the process canvas.

REST ReferenceCreate a REST Reference binding to consume a REST endpoint. You cannot edit the REST Referencebinding configuration.

Prerequisites

Swagger 2.0-compliant REST API documents must be imported into the TIBCO Business Studio ™Container Edition project's Service Descriptors folder. This will give you the ability to expand andcollapse endpoints, operations, parameters and response codes in the Project Explorer view.

To consume a REST API that exists in the Service Descriptor of the project, do the following:

Procedure

1. Expand the Swagger 2.0 files in the Service Descriptors special folder to view the endpoints,operations, parameters, response codes.

2. Drag and drop an endpoint on the right side of the canvas to create a REST Reference Binding.This will create a cloud shaped icon with a right facing arrow. The cloud is an indication that it is aREST Reference whereas the arrow within the cloud indicates that it is a binding. Since the bindingis within a cloud, it is an indication that it is a REST binding. You cannot convert a REST binding toa SOAP binding or vice versa.

When you create a REST reference for the service, make sure to edit the Default Host fieldin the HTTP Client Resource to reflect the actual host name. By default, the Default Hostfield is set to localhost.

3. Drag and drop an operation from the Reference Binding on to the canvas.This creates an Invoke activity which is pre-configured to invoke the operation. It also creates anHTTP Client Shared Resource with the host name and port number. The configuration for theseentities is copied from the Swagger document from which you created the Reference Binding. TheReference consists of the name of the API as well as the operations it supports.

When invoking a POST or PUT method, you must provide the request string in the Input tab. To doso, click the column next to item under postRequest in XPath Expression and provide the requeststring in the drop-down box.

4. Test the configured process using the TIBCO Business Studio ™ Container Edition Debugger.

SOAP BindingYou can use SOAP binding to create service providers and service consumers, based on the SOAPprotocol. TIBCO BusinessWorks Container Edition supports SOAP 1.1 and SOAP 1.2 protocol.

28


Messages created by SOAP binding can either use HTTP or JMS transport for communication.Depending upon whether you want to create a service provider or a service consumer, there are twotypes of SOAP bindings: SOAP Service Binding and SOAP Reference Binding.

TerminologyTIBCO BusinessWorks Container Edition uses specific terminology to identify the purpose of themessage, that is exchanged between a service provider and a service consumer.

Terms Used For SOAP Messages

The following table describes the terms used to describe a SOAP message.

Term Description

ServiceRequest A request message received by a service provider

ServiceReply The response message sent by a service provider

ReferenceRequest A request message generated by a service consumer

ReferenceReply A response message received by a service consumer

SOAP Headers

Refer to the following table for the terminology used to described different configurations that can beused to create a SOAP Header.

Term Description

Described Described denotes that the WSDL message definition used to create a SOAPheader is available in the concrete WSDL.

Undescribed Undescribed denotes that the WSDL message definition used to create aSOAP header is not available in the concrete WSDL.

Bound Specifies that the SOAP header definition is the part of the same WSDLmessage, that is also used to create a SOAP body. In such cases, a WSDLmessage contains multiple parts. Some parts are defined to describe SOAPheaders and others are defined to describe the SOAP body.

Unbound Specifies that the SOAP header definition is not a part of the same WSDLmessage, that is also used to create a SOAP body

Based on the definitions in the SOAP Headers table, SOAP headers can be categorized into any of thefollowing three types of configurations:● Described bound headers● Described unbound headers● Undescribed unbound headers

SOAP Attachments

Refer to the following table for SOAP attachment types and their relevant description.

29


SOAP AttachmentTypes Description

Described BoundAttachments

In this configuration, a part of the input or output WSDL message of typebase64binary is configured as an attachment. In a concrete WSDL, theattachment is described as a mime part of the multipart message.

UndescribedUnboundAttachments

None of the parts of the WSDL input or output message is configured to bean attachment. The concrete WSDL does not indicate whether an attachmentis in the input or output message.

Attachment mapping is done at the Binding Configuration under ContextMapping (Request/Response)

SOAP Service BindingUsing SOAP service binding you can create a service provider through the SOAP protocol.

Binding


Field Description

Name The name of the service binding.

Description A short description of the service getting exposed.

Target Namespace The Target Namespace of the service.

Generate Concrete WSDL

The SOAP service binding helps you to create the concrete WSDL using Concrete WSDL GenerationWizard. See Generating Concrete WSDL for more details.

SOAP Default Configuration


Field Description

SOAP Version The version of the SOAP specification: 1.1 or 1.2. The default is 1.1.

Style The default SOAP binding style for all operations. Specify eitherDocument or RPC style.

Encoding Encoding is literal.

30


Field Description

Attachment Style Select the default attachment style for all the binding operations. Can beoveridden at the operations level for each operation.

The following attachment styles are available:

● SwA - Supports both, Bound and Unbound Attachments● MTOM

The MTOM attachment style is available only if SOAP 1.2 specification isused.

Transport Configuration


Field

Literal Value/ModuleProperty Description

TransportType

None The transport over which SOAP message is sent. The HTTP andJMS transports are supported.

ConnectorName

None The name of the shared resource. This points to either the HTTPor JMS shared transport configuration.

Configuration for HTTP Transport

HTTPConnectorName

None Name of the HTTP Connector resource.

Click on the HTTP Connector Name field to displaydetails about the HTTP Connector resource.

Endpoint URI Yes The endpoint URI for the service.

Configuration for JMS Transport

JMSConnectionName

None The name of the JMS Connector resource.

Click on the JMS Connection Name field to displaydetails about the JMS connector resource.

31


Field


AcknowledgeMode

None The acknowledge mode for service request messages. It can beone of the following:

● Auto: The message is acknowledged when it is received by aSOAP Service Binding.

● Client: The message is not acknowledged when it is receivedby the SOAP Service Binding. You can confirm the messageby using the Confirm activity in the BusinessWorks processthat is configured as an operation implementation. If theConfirm activity is not used, the message is automaticallyacknowledged by the SOAP Service Binding while sendingthe service reply.

● Dups OK:The message is acknowledged automatically whenit is received by a SOAP Service Binding. JMS provides thismode for lazy acknowledgment , but BusinessWorksContainer Edition acknowledges messages upon receipt.

● Tibco EMS Explicit: (only available for TIBCO EnterpriseMessage Service™)

The message is not acknowledged when it is received by aSOAP service binding. You can confirm the message by usingthe Confirm activity in the BusinessWorks Container Editionprocess that is configured as the operation implementation.

If the Confirm activity is not used, then the message isautomatically acknowledged by the SOAP Service Bindingwhile sending the service reply.The session is not blocked and one session handles allincoming messages for each process instance.

● Tibco EMS Explicit Dups OK: (only available for TIBCOEnterprise Message Service)

The message is not acknowledged when it is received by aSOAP service binding. You can confirm the message by usingthe Confirm activity in the BusinessWorks Container Editionprocess that is configured as the operation implementation.

If the Confirm activity is not used, the message isautomatically acknowledged by SOAP Service Binding whilesending the service reply.The session is not blocked and one session handles all theincoming messages for each process instance. The messageshowever, are lazily acknowledged.

MessageType

None Specifies the type of the service request messages. It can be eitherText message or Bytes message.

MessagingStyle

None Specifies the style of the service request messages. It can beGeneric, Queue, or Topic.

32


Field


JMSDestination

Yes Specifies the name of the destination for the service requestmessages. The syntax of the destination name is specific to theJMS provider you are using.

JMSApplicationProperties

None User-defined JMS Properties expected to be available in theservice request messages.

NOTE: JMS Application properties should be defined in aschema only through a complex type. Also, all JMS Applicationproperties should be direct child of this complex type.

JMSApplicationProperties(Response)

None User-defined JMS Properties expected to be sent in the theservice response messages.

NOTE: JMS Application properties should be defined in aschema only through a complex type. Also all JMS Applicationproperties should be direct child of this complex type.

Max Sessions None When the Acknowledge Mode field is set to Client, this fieldconfigures the maximum number of JMS sessions that is createdfor the service request messages.

When a message is received, the session is blocked until themessage is acknowledged in the process. If acknoledgement isnot done at process level then it is automatically acknowlegedwhen the SOAP Service Binding sends a service reply.

After reaching the maximum number of sessions, no newincoming messages can be processed. Once any one of themessages is processed ,the total number of active sessionsdecreases and then another incoming message can be processed.

Operations None This field is available only when Topic is selected in the JMSDestination Type field.

Operation Name - Specifies the operation name.

Durable Subscription - Set to true if the client is a durablesubscriber.

Subscription Name - Specify the Subscription Name if DurableSubscription is set to true.

Persistence Configuration


33


Field

LiteralValue/ModuleProperty Description

Persistence Type None Select any one from the available Persistence configurationtypes. They are NONE and File.

Selecting the File option displays the Directory, CreateDirectories, and Threshold Size fields.

Directory Yes The directory where attachments will be serialized.

CreateDirectories

Yes Creates new directories if not present on the disk.

Threshold Size Yes The maximum size of the attachment that can be kept inmemory. Attachments larger than the specified size will bewritten to the disk.The file name generated for serialization israndom except when the Content-disposition header is availablefor the attachment. Here, the name is the same as the content-disposition header value.

You can configure the size to Bytes, KB or MB.

Threading Policy Details

The following are the details for the SOAP Service Binding threading policy.

Activity TypeMulti-Threaded? Default Thread Count Thread Count Configuration

Transport: HTTP

ProcessStarter

Yes● Minimum thread pool

threads = 10● Maximum thread pool

threads = 75

It can be configured on the HTTPConnector shared resource using thefollowing fields:

● Minimum QTP threads● Maximum QTP threads

Add Binding

You can add a binding. Click the Add Binding icon to add a binding.

Delete Binding

You can delete a binding. Click the Delete Binding icon to delete a binding.

34


SOAP Reference BindingUsing SOAP reference binding you can create a service consumer using SOAP protocol.

Binding


Field Description

Name The name of the reference binding.

Description A short description of the HTTP reference binding.

WSDL Service Specifies the service name and its target namespace.

WSDL Port Specifies the binding implemented by the service. If more than oneimplementation is available in concrete WSDL, select an appropriateimplementation.

SOAP Version The version of the SOAP specification: 1.1 or 1.2.

Attachment Style The attachment style for the incoming and outgoing messages. Thefollowing attachment styles are available:

● SwA● MTOM

The attachment style MTOM is available only if the activity uses SOAP 1.2and is not displayed when SOAP 1.1 is used.

Transport Configuration


Field Literal Value/Module Property Description

TransportType

None The transport over which the SOAPmessage is sent. HTTP and JMS transportsare supported.

Application for HTTP Transport

Default Host/Port

None Specifies the default host and portconfiguration available in the concreteWSDL.

HTTP ClientName

None Name of the HTTP Client resource.

Endpoint URI Yes The endpoint of the service through whichSOAP clients can access the service.

Application for JMS Transport

35


Field Literal Value/Module Property Description

JMSConnectionName

None Name of the JMS Connector resource

Click on the JMS ConnectionName field to display detailsabout the JMS Connectorresource.

JMSDestination

Yes Specifies the name of the destination forthe incoming JMS messages. The syntax ofthe destination name is specific to the JMSprovider you are using.

MessagingStyle

None Specifies the style of the incomingmessages on the specified destination. Itcan be Generic, Queue, or Topic.

Message Type None Specifies the type of the incomingmessages on the specified destination. Itcan be either Text Message or BytesMessage.

DeliveryMode

No The delivery mode of messages.

● Persistent Messages are stored andforwarded.

● Non-Persistent Messages are notstored and can be lost due to failure.

The default is Persistent.

Expiration Yes The length of time a message can remainactive. 0 means that the message does notexpire.

Priority Yes The priority of the message. Priority is avalue from 0-9. Higher numbers signify ahigher priority (that is, 9 is a higherpriority than 8).

The default is 4.

JMSApplicationProperties

None The user-defined JMS Properties requiredto be available in the incoming message.

JMSApplicationProperties(Response)

None The user-defined JMS Properties requiredto be sent in the outgoing message.

Persistence Configuration


36


Field

LiteralValue/ModuleProperty Description

Persistence Type None Select any one from the available persistence configurationtypes.

● None● File

Selecting the File option displays the Directory, CreateDirectories, and Threshold Size fields.

Directory Yes The directory to write attachments that exceed the specifiedthreshold size.

CreateDirectories

Yes Creates new directories if not already present on the disk.

Threshold Size Yes The maximum size (in bytes) of an incoming messageattachment that can be kept in memory. Attachments larger thanthe specified size are written to a file in the specified directory.

The file name is the output, so that subsequent activities in theprocess can access the file and read its contents.

37


General Activities

General Activities palette comprises various general purpose activities and process starters. Forexample, Timer, a process starter activity, is used to start a process at a specific time.

AssignAssign is a synchronous activity. You can use this activity to assign a value to a process-definedvariable. The Assign activity is used to assign a value to the process-defined as well as scope-definedvariables. Ensure to set all the essential values when using the Assign activity to set a process variable.

General


Field Description


Process Variable toSet

A drop-down list of the available user-defined process variables for theprocess.

Select any user-defined process variable to modify.

Description

Provide a short description of the activity.

Input


<schema> The specified data schema for the user-defined process variable selected onthe General tab.

Output

The schema for the output is determined by the schema specified for the process variable.

Call ProcessThe Call Process is an asynchronous activity that calls and executes an existing process.

General


Field Description


Service The endpoint of the service provided by the sub-process.

38


Description


Input



input varies The input to the called process is defined in the OutputEditor tab of the Start activity of the called process.

Output



output varies The output of the called process is defined in the InputEditor tab of the End activity of the called process.

ConfirmConfirm is a synchronous activity that confirms any confirmable message received by the processinstance.

General


Field Description


ConfirmEvent The message you want to confirm.

This is a drop-down list of any process starter or activity awaiting anincoming event in the current process.

You can confirm messages only from the reliable sources, for example, JMSmessages. E-mail is also confirmable when received by the Receive Mailprocess starter (the e-mail message is deleted from the server when it isconfirmed).

Select only the event that sent the confirmable message.

Description


39


Get Shared VariableGet Shared Variable is a synchronous activity that retrieves the current value of a module sharedvariable or job shared variable.

General


Field Description


Inline Specify the type of shared variable (Module Shared Variable or Job SharedVariable).

Shared Variable The module shared variable or job shared variable whose value you want toretrieve.

Description

Provide a short description here.

Output



schema The value of the shared variable specified in the Shared Variable field ofthe General tab is the output for this activity.

The schema for the output is determined by the schema specified for theshared variable.

InspectorInspector activity is used to write the output of any or all activities and module properties to a file orstdout. This is particularly useful when debugging processes and you want to see the entire schemainstead of mapping specific elements to the Write File activity.

You can use the Inspector activity to write the output of any activity or module properties in thecurrent process. Activities and module properties in a subprocess are not available to the Inspectoractivity (but the output of a Call Process activity can be written using the Inspector activity). If youwant to obtain the output from one or more activities or module properties in a subprocess, place theInspector activity in the process of the subprocess.

General


Field Description


40


Field Description

Inspect The output of the processes you want. Select any one from available items onthe drop-down list to output.

● All● ModuleProperties● _processContext

Only activities that have output and are executed prior to the Inspectoractivity are visible in the drop-down list.

Stdout Specifies whether the output of this activity should be sent to stout (standardoutput). Select this check box to send the output to stdout.

If this check box is not selected, the output is not sent to stdout.

Append to File Select this check box to specify that the output is appended to the filespecified in this activity’s input.

Not selecting this check box overwrites any file that exists with the specifiedname.

Suppress Header Select this check box to suppress the output of header information, such as theprocess instance ID and the timestamp.

If this check box is not selected, the header information for the current processinstance is written before the output of the activity or module property.

Description


Input



fileName string The absolute path to the file you want to write. This filecontains the output of the specified activity or moduleproperty.

Output

The following is the output of this activity.


output string The output of the module property or activity specifiedon the General tab in string form.

You can use this output in subsequent activities, inaddition to writing the output to a file or stdout.

41


LogLog is a synchronous activity that writes a message to the log.

General


Field Description


Logger Name Specifies the name of a message category. The value of the logger-name iscase-sensitive and can be a single name or a hierarchical name.

Log Level Select one of the following log levels recognized by the process engine.

● Error: logs error conditions and messages.● Warning: is the warning message of an unexpected error in the process.● Info: logs informational messages highlighting the application/engine

progress.● Debug: can be used for debug-level messages.

Suppress Job Info If selected, no additional information is added to the log entry.

If not selected, each log message prepends JobId, ProcessInstanceId, ActivityName, Document Update: December 2014 and Version, Deployment UnitName, and Version name to the message text.

Description


Input


Input Iten Datatype Description

msgCode string The error code of the message. This is used as an identifier for themessage so that applications can scan the log for the message.

loggerName string The name of a message category specified in the Logger Name fieldin 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 defaultencoding of the Java Virtual Machine used by the processengine is used for text encoding, when writing to the logfile.

42


MapperMapper is a synchronous activity that adds a new process variable to the process. This variable can bean inline schema, primitive element, or a complex element. You can map the data values from thecurrent 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 asimple 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 inputand output schema of the Mapper activity. This data is then available to other activities in the process.

Input

The input for the activity is defined by the specified data elements on the Input Editor tab.

Output

The output for the activity is defined by the specified data elements on the Output Editor tab.

Set Shared VariableSet Shared Variable is a synchronous activity that you can use to change the value of a shared variable.

General


Field Description


Inline Specify the type of the shared variable (Module Shared Variable or JobShared Variable).

Shared Variable The module shared variable or job shared variable whose value you want toretrieve.

Description


Input


43



schema The value of the shared variable specified in the Shared Variable field ofthe General tab is the input for this activity.

The schema for the input is determined by the schema specified for theshared variable.

Output



schema or no output The value of the shared variable specified in the Shared Variable field ofthe General tab is the output for this activity.

The schema for the output is determined by the schema specified for theshared variable.

SleepSleep is an asynchronous activity that suspends the process on the current transition for the specifiedtime. For a process with multiple control flows, only the current execution branch of the process issuspended.

General


Field Description


Description


Input



IntervalInMillisec

integer The amount of time interval, in milliseconds, to suspend thecurrent branch of the process. The default time interval is 3minutes.

TimerTimer is a process starter activity that starts the process at a specific time. You can also specify theprocesses to be started periodically.

General


44


Field

Literal Value/ModuleProperty/ProcessProperty? Description

Name None The name to be displayed as the label for the activity in theprocess.

Start Time Yes The day and time to start the process. To run the processperiodically, the start time indicates the first time to run theprocess.

The local machine’s time zone is used to determine the processstart. If the project is running on machines in different time zones,the time zone of the machine where the project was saved, isused. Use a process property in this field to provide start timesrelative to the time zone where the project is deployed. If youprovide a process property for this field, the format of thespecified time must be: yyyy MMM dd HH:mm:ss z

Run Once None Indicates this process should be run only once on the day andtime indicated by the Start Time field.

If you do not select this check box, the Time Interval and IntervalUnit fields are displayed that you can use to specify the frequencyof the process.

TimeInterval

Yes The integer indicating the number of units specified in theInterval Unit field. For example, if a value of 1 is specified andthe Interval Unit field is specified as Hour, a new process isstarted every hour beginning at the time specified in the StartTime field.

● If a value of 2 is specified and the Interval Unit field isspecified 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 (1000milliseconds), the timer ignores the specified interval and istriggered once every second.

Using Literal Value, Module Property, and ProcessProperty in this field, specifies the time interval inmilliseconds and the Interval Unit field is notdisplayed.

Interval Unit None The unit of time to use with the Time Interval field to determinehow often to start a new process. The units can be: Millisecond,Second, Minute, Hour, Day, Week, Month, and Year.

45


Field

Literal Value/ModuleProperty/ProcessProperty? Description

End After None Specify the number of occurrences or the end time here. Selectfrom the following available options:

● Never: Click the Never radio button if you want tocontinuously execute the process instance. For example, if theTime Interval value specified is 5 and the Interval Unitspecified is Second, the process instance executes every 5seconds.

● Occurrences: Clicking the Occurrences radio button displaysthe Occurrences field. Specify the number of occurrences ofthe process instance execution. This field can be configuredwith Literal Value, Module Property, and Process Property.

● End Time: Clicking the End Time radio button displays theEnd Time field. Specify the end time and date when you wantthe process to end. This field can be configured with LiteralValue, Module Property, and Process Property.

Description


Advanced

The Advanced tab has the following fields.

Field Description

Sequencing Key This field contains an XPath expression that specifies which processes shouldrun in sequence. Process instances with sequencing keys evaluating to the samevalue, are executed sequentially in the sequence the process instance wascreated.

Custom Job Id This field contains an XPath expression that specifies a custom job ID for everyjob in the process instance.

Output

The following is the output of the activity.

46



TimerOutputSchema

The time the process instance started.

The time is represented by several items in the output schema indicating:

● Now● Hour● Minute● Second● Week● Month● Year● Date● Time● DayOfMonth

Each of these items uses the appropriate datatype.

47


HTTP Palette

Using the HTTP Palette you can send and receive HTTP requests.

HTTP ReceiverHTTP Receiver is a process starter activity that starts the process based on the receipt of an HTTPrequest.

General


Field

Literal Value/ModuleProperty/Processproperty? Description


HTTPConnection

Yes The HTTP Connector resource describes the characteristics ofthe connection used to receive incoming HTTP requests.

See HTTP Connector for more information about specifyingshared resources.

Context Path

Path Spec

Yes This is the prefix of a URL path that is used to select thecontexts to which an incoming request is passed.

You can either specify both Context Path and Path Spec, any,or none of these elements. For example, the path displays asthe http://hostname.com/contextPath/pathSpec format.

If the Context Path is not specified, the context path isreferred to as the root context.

Output Style None The type of output. It can be either String or Binary.

Parse PostMethod Data

None Specifies to parse the message body of the HTTP request intoa schema for the output of the activity.

When this check box is selected, the parameters specified inthe Parameters field are used to validate the incomingrequest and parse it into the output schema.

For an incoming GET request, there is no messagebody, hence this field has no effect on the incomingGET requests.

48


Field

Literal Value/ModuleProperty/Processproperty? Description

Parameters None The parameters of the incoming HTTP request.

If you specify parameters in this table, the incoming request isparsed and represented as a schema in this output of theactivity. For each parameter, you must provide a name,datatype, and whether the field is Optional, Required, orRepeating.

Use the and buttons to the right of the parameter tableto add and remove parameters.

Specifying parameters in this field parses the querystring of the request into the output schema,regardless of whether the Parse Post Method Datacheck box is selected. Selecting the Parse PostMethod Data check box and specifying parametershere is required to parse the message body alongwith the query string of the request.

Expose SecurityContext

None Places the information from the user’s security context (eitherauthentication or SSL certificate information) into the Contextor SecurityContext output element.

This is a fairly expensive operation and SSL certificates canconsume memory resources. Hence, select this option only ifyou require information from the user’s security context forlater use in your process.

DefaultEncoding

Yes Specifies the encoding to use if no charset is specified in theContent-Type header of the message. This encoding is usedfor the message body and URL.

However, when URIEncoding is specified in the HTTPConnector shared resource, the Default Encoding parameterspecified here applies to the contentType alone and not to theURIEncoding property.

Description


Advanced


49


Field

ProcessProperty/ModuleProperty? Description

Write to File None Select this check box to write incoming requests that exceedthe specified threshold size to a file instead of storing therequest in memory. You can accept large incoming requestswithout consuming a great deal of memory. Selecting thischeck box displays the Directory, Creating Non-ExistingDirectories, and Threshold Data Size(bytes) fields.

This option is not intended to be used with theParse Post Method Data option on the Generaltab. When you select Write to File, the PostDataoutput element becomes a choice elementcontaining either the output FileName or thePostData. This depends upon whether the dataexceeds the size specified in the Threshold DataSize field. It is recommended to use either theWrite to File option or the Parse Post MethodData option, but not both at the same time.

Not selecting this field keeps the incoming requests inmemory.

After writing, the files created using this optionare not deleted automatically. You must managethe storage used by these files and delete themwhen they are no longer used.

Directory Yes The directory to write messages that are above the specifiedthreshold. The process engine does not attempt to create thedirectory if the specified directory does not exist. Therefore,create the directory before starting the process engine.

Create Non-ExistingDirectories

None When this check box is selected, all directories in the pathspecified in the Directory field are created, if they do notalready exist.

If this check box is not selected and there are one or moredirectories in the specified path in the Directory field thatdo not exist, an exception is raised.

Threshold DataSize(bytes)

Yes The maximum size (in bytes) of an incoming request thatcan be kept in the memory. Requests larger than thespecified size are written to a file in the specified directory.The file’s name is output so that subsequent activities in theprocess can access the file and read its contents.

Specify zero (0) in this field for all incoming requests to besaved to a file.

50


Field

ProcessProperty/ModuleProperty? Description

Sequence Key None This field can contain an XPath expression that specifieswhich processes should run in sequence. Process instanceswith sequencing keys that evaluate to the same value areexecuted sequentially in the sequence the process instancewas created.

Custom Job Id None This field can contain an XPath expression that specifies acustom 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 dataand the server is expected to decode the data. For example, an incoming request may have thefollowing 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 Generaltab), the body of the message remains URL-encoded in the PostData output element. If the messagebody is parsed, the data is decoded before being placed in the PostData output element, and thatelement would display as follows:

name=John Smith&address=500 1/2 Main Street

The sequence of the parameters may not be the same in the PostData output element as the sequence inthe 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 uponwhether the message body is parsed. Hence, ensure that you obtain data from the parameters outputelement 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 usethe default structure, or you can alter the structure, if the incoming request has a specific data structurefor the header of the request.

The header structure is defined by the HTTP protocol. See the HTTP protocol specification for moreinformation about the fields and content of the header of an HTTP request. You can obtain thisspecification at www.w3.org.

Output HeaderElement Datatype Description

Accept string This field specifies media types that are acceptable forresponse messages for the incoming request. For example,text/*,text/html. Media types are described in the HTTPspecification.

If no Accept-Header field is present, it is assumed that theclient accepts all media types.

51


http://www.w3.org/

Output HeaderElement Datatype Description

Accept-Charset string This field specifies the character sets that are acceptable forresponse messages for the incoming request. For example,iso-8859-5, unicode-1-1. Character sets are described in theHTTP specification.

If no Accept-Charset header is present, it is assumed that theclient accepts any character set.

Accept-Encoding

string This field specifies the content-coding values that areacceptable for response messages. For example, compress,gzip. See the HTTP specification for more information aboutthis header field.

Content-Type string This field indicates the media type of the entity body sent tothe 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 decimalnumber of OCTETs) sent to the receiver.

This field takes into account the encoding of the messagebody. See Special Characters in HTTP Requests for moreinformation on when the message body is URL encoded.

Connection string Using this field the requestor can specify options required forthis connection. For example, the option close specifies thatthe requestor would like the connection to be closed when therequest is complete.

Cookie string See the HTTP specification for more information about thisfield.

If you want to receive more than one cookie, set thecardinality for this field to repeating (*).

Pragma string This field is used to include implementation-specific directivesthat might apply to the receiver. See the HTTP specificationfor more information about using this field.

Output



Method string The method specified in the request. For example, GET orPOST.

RequestURI string The address portion of the request. This is the portion beforethe question mark (?).

HTTPVersion string The version field of the HTTP request.

52



PostData orBinaryContent orFileName

string The message body of the HTTP request. The content of thiselement depends upon whether the message body is parsed.Parsing behavior is controlled by the Parse Post MethodData field on the General tab.

See Special Characters in HTTP Requests for moreinformation.

If the Write to File field is selected on the Advanced tab, andthe incoming message exceeds the specified threshold size,thePostData field can also contain the file name of the filecontaining the message.

QueryString string The query string portion of the request. This is the portionafter the question mark (?).

Header string The header of the HTTP request.

Protocol string This can be HTTP or HTTPS depending upon the protocolused by the request.

Port string The port number on which the request was received. This isthe 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 moreinformation about these items.

Parameters complex The parameters for the incoming request. These parametersare configured in the Parameters field on the General tab.

When the Parse Post Method Data check box on the Generaltab is selected, the parameters include the parameters in thequery string and message body of the incoming HTTPrequest.

When the Parse Post Method Data check box is not selected,the parameters include only the query string of the incomingrequest.

53



DynamicHeaders complex The dynamic header is an additional header parameter toreceive header parameters from incoming HTTP requests.This element is specified in the Output Editor tab. TheDynamicHeaders consists of the following information:

● Name: the name of the header● Value: the value of the header

The following overriding conditions can be considered:

● Overrides the value of HeaderName with the value foundin DynamicHeaders, if it is a non-repeating header. Ifmore than one occurrence of this header is found underDynamicHeaders, 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 a repeating element, add the respective name value

pairs under dynamic headers, which is added to theexisting list maintained for this element.

● For a repeating element, if the new header name is notfound under the "Headers" section declared throughTIBCO Business Studio Container Edition, the followingis added into the HTTP Headers.

— Shows only one value, if found once inDynamicHeaders.

— Shows array of values, if found repeating inDynamicHeaders.

mimeEnvelopeElement

complex This element contains the message attachments.

This element contains a repeating element named mimePartthat contains each mime attachment.

54



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 anattachment, use "*;filename=<filename>" in thiselement.

HTTP servers may alter or ignore the suggestedname.

● content-type● content-transfer-encoding● content-id● any element

See http://www.faqs.org/rfcs/rfc2045.html for moreinformation about MIME headers and their syntax.

When the content type is specified as "text/*"(for example, "text/xml"), the attachment contentis expected to be in either the textContent inputelement or the file name storing the attachment isexpected to be in the fileName input element.When the content type is anything other than"text/*", the attachment content is expected to bein either the binaryContent input element or thefile name storing the attachment is expected to bein the fileName input element.

binaryContent |textContent |fileName

choice This element contains the mime attachment.

The element can be one of the following:

● binaryContent: content of the attachment content of theattachment when the attachment is binary data.

● textContent: content of the attachment when theattachment is text data.

● fileName: the file name of the attachment written to thedisk.

Context complex 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 RequestSend HTTP Request is an asynchronous activity that sends an HTTP request and waits for a responsefrom the web server. This activity sends a request to a server that is compliant with either the HTTP 1.1or 1.0 specification. TIBCO BusinessWorks Container Edition automatically sends the request using thecorrect version based on the version supported by the HTTP server. Therefore, do not specify the HTTPversion of the server you are sending the request to.

55


http://www.faqs.org/rfcs/rfc2045.html

General


Field Description


HTTP Client Specifies the HTTP Client shared resource. For details, refer to HTTP Client.

Parameters The parameters of the HTTP request. For each parameter, you must provide:

● Parameter Name● Parameter Type as string● Parameter Cardinality as Optional, Required, or Repeating

These parameters are specified in the parameters element on the General tab.

Description


Advanced


Field

Literal Value/ModuleProperty? Description

Write to File None Select this check box to write the incoming requests thatexceed the specified threshold size to a file instead of storingthe request in memory. You can accept large incomingrequests without consuming a great deal of memory.Selecting this check box displays the Directory andThreshold Data Size fields.

To keep the incoming requests in memory, do notselect this check box.

The files created using this option after writing arenot deleted automatically. You must manage thestorage used by these files. Delete these files whenthey are no longer in use.

Directory Yes The directory to write messages that are above the specifiedthreshold. The process engine does not attempt to create thedirectory if the specified directory does not exist. Therefore,create the directory before starting the process engine.

56


Field


Creating Non-ExistingDirectories

No Selecting this check box creates all directories in the pathspecified in the Directory field, if they do not already exist.

Not selecting this check box with one or more non-existingdirectories in the specified path in the Directory field, raisesan exception.

Threshold DataSize(bytes)

Yes The maximum size (in bytes) of an incoming request to bekept in memory. Requests larger than the specified size arewritten to a file in the specified directory. The file’s name isthe output so that subsequent activities in the process canaccess the file and read its contents.

Specifying zero (0) in this field causes all incoming requeststo be saved to a file.

Input Editor

Input Editor comprises the data structure of the headers of the HTTP request and HTTP reply message.You can either use the default structure or modify the structure, if the outgoing request or the reply tothe request has a specific data structure for the header.

Input Header Datatype Description

Accept string This field specifies media types that are acceptable forresponse messages for the request. For example, text/*,text/html. Media types are described in the HTTPspecification.

If no Accept-Header field is specified, all media types areacceptable on the server.

Accept-Charset string This field specifies the character sets that are acceptable forresponse messages for the request. For example,iso-8859-5, unicode-1-1. The character sets are describedin the HTTP specification.

If no Accept-Charset header is specified, any character set isacceptable on the server.

Accept-Encoding string This field specifies the content-coding values that areacceptable for response messages. For example, compressand gzip. See HTTP specification (http://www.w3.org/Protocols/Specs.html) for more information about thisheader field.

Content-Type string This field indicates the media type of the entity body for theoutgoing message and the incoming response. Media typesare described in the HTTP specification. An example of themedia type is text/html; charset=ISO-8850-4.

57


http://www.w3.org/Protocols/Specs.html


Input Header Datatype Description

Cookie string A name and value pair (also known as a cookie) containinginformation that the HTTP server may be expecting. You canset the cardinality for this element to Repeating (*) to specifymore than one cookie. You can also specify multiple name orvalue pairs in a single non-repeating element by separatingeach pair with a comma (for example, "name1=value1,name2=value2").

Pragma string This field is used to include implementation-specificdirectives that might apply to the receiver. See the HTTPspecification (http://www.w3.org/Protocols/Specs.html) formore information about using this field.

Output Editor

Output Editor comprises the data structure of the headers of the HTTP request and HTTP replymessage. You can either use the default structure or modify the structure, if the outgoing request or thereply to the request has a specific data structure for the header.

The header structure is defined by the HTTP protocol. See the HTTP protocol specification for moreinformation about the fields and content of the header of an HTTP request. You can obtain thisspecification at http://www.w3.org/.

Output Header Datatype Description

Allow string This field lists the set of methods supported by the resourceidentified by RequestURI.

Content-Type string This field indicates the media type of the entity body for theoutgoing message and the incoming response. Media typesare described in the HTTP specification. An example of themedia type is text/html; charset=ISO-8850-4.

Content-Length string This field indicates the size of the entity body (in decimalnumber of OCTETs) of the response message.

Content-Encoding string This field is used as a modifier to the content-type. Whenpresent, its value indicates what additional content encodinghas been applied to the entity-body. Also, what decodingmechanisms must be applied to obtain the media-typereferenced by the Content-Type header field.

Content-Encoding is primarily used to allow a document tobe compressed without losing the identity of its underlyingmedia type. See the HTTP specification for more informationabout 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 otherthan RequestURI for completion of the request or foridentification of a new resource.

58



http://www.w3.org/

Output Header Datatype Description

Set-Cookie string If you want to receive more than one cookie, set thecardinality for this field to Repeating (*).

See the HTTP specification for more information about thisfield.

Pragma string This field is used to include implementation-specificdirectives that might apply to the receiver.

See the HTTP specification for more information about usingthis field.

Input



Host string The HTTP host you want to connect to. Specifying a value forthis input item overrides any value specified on the Generaltab.

Port string The port number that the HTTP server uses for incomingrequests. Specifying a value for this input item overrides anyvalue specified on the General tab.

Method string The HTTP method to use for the request. All HTTP 1.1methods are supported, but the connect method isunnecessary because TIBCO BusinessWorks ContainerEdition automatically uses the CONNECT method whenconnecting through a proxy server.

If no method is specified in this element, the GET method isused by default.

RequestURI string The address portion of the request. This is the portion of theURI before the question mark (?).

PostData string The message body of the HTTP request. Do not specify thiselement when the method of the request is GET.

For details on this input element, refer to Sending Data in theHTTP Request

QueryString string The query string portion of the request. This is the part afterthe question mark (?).


Timeout integer The amount of time (in milliseconds) to wait for a responsefrom the HTTP server.

59



Headers complex The header fields to send for the request. When this elementis specified on the Input Editor tab, you can use this inputitem to provide values for the header when sending therequest.

DynamicHeaders complex The dynamic header is an additional header parameter toadd runtime headers to the outgoing HTTP messages. Thiselement is specified in the Input tab.

You can use only US-ASCII characters inDynamicHeaders.

The DynamicHeaders consists of the following information:


You can consider the following overriding conditions.

● Overrides the value of HeaderName with the value foundin DynamicHeaders if it is a non-repeating header. Ifmore than one occurrence of this header is found underDynamicHeaders, it throws the following exception.

The header [ headerName ] is defined as non-

Repeating Header in Input Headers. This header

cannot have multiple occurences in

DynamicHeaders.

● If it is a repeating element, add the respective name valuepairs under dynamic headers, which is then added to theexisting list maintained for this element.

● For a repeating element, if the new header name is notfound under the "Headers" section declared throughTIBCO Business Studio Container Edition , the followingis added into HTTP Headers.


— Shows an array of values, if found repeating inDynamicHeaders.

mimeEnvelopeElement



60



mimeHeaders complex This element contains the mime header for each mimePart.mimeHeaders can contain the following information:

● content-disposition: To suggest a filename for anattachment, use "*;filename=<filename>" in thiselement.

The HTTP servers may alter or ignore thesuggested name.

● content-type● content-transfer-encoding● content-id


When the content type is specified as "text/*"(for example, "text/xml"), the attachment contentis in either the textContent input element or thefile name storing the attachment is in the fileNameinput element. When the content type is anythingother than "text/*", the attachment content is ineither the binaryContent input element or the filename storing the attachment is in the fileNameinput element.

binaryContent | choice This element contains the mime attachment.

The element is binaryContent: the content of the attachmentwhen the attachment is binary data.

Output



Header complex The fields of the header specified on the Output Editor tab.See the description of the Output EditorOutput Editor tab formore information about these items.

StatusLine complex This field is the first line of the response message. Thisconsists of the protocol version, a numeric status code, andthe text phrase explaining the status code.

See the HTTP specification for more information about statuscodes in the HTTP responses.

61




httpVersion string The HTTP method to use for the request. All HTTP 1.1methods are supported, but the connect method isunnecessary because TIBCO BusinessWorks ContainerEdition automatically uses the CONNECT method whenconnecting through a proxy server.

If no method is specified in this element, by default the GETmethod is used.

statusCode string The address portion of the request. This is the portion of theURI before the question mark (?).

reasonPhrase string The message body of the HTTP request. Do not specify thiselement when the method of the request is GET.


binaryContent string The binary content of the response to the request from theHTTP server.

asciiContent integer The ASCII content of the response to the request from theHTTP server.

Headers complex The header fields of the reply. The structure of this outputitem is specified on the Output Headers tab.

62



DynamicHeaders complex The dynamic header is an additional header parameter toadd runtime headers to the outgoing HTTP messages. Thiselement is specified in the Input tab.

You can use only US-ASCII characters inDynamicHeaders.

The dynamic headers consist of the following information:


You can consider the following overriding conditions.

● Overrides the value of HeaderName with the value foundin DynamicHeaders if it is a non-repeating header. Ifmore than one occurrence of this header is found underDynamicHeaders, it throws the following exception.

The header [ headerName ] is defined as non-

Repeating Header in Input Headers. This header

cannot have multiple occurences in

DynamicHeaders.

● If it is a repeating element, add the respective name orvalue pairs under DynamicHeaders, which is added tothe existing list maintained for this element.

● For a repeating element, if the new header name is notfound under the "Headers" section declared throughTIBCO Business Studio Container Edition, the followingis added into HTTP Headers.



mimeEnvelopeElement



63




● content-disposition: to suggest a filename for anattachment, use "*;filename=<filename>" in thiselement.


● content-type● content-transfer-encoding● content-id


When the content type is specified as "text/*"(for example, "text/xml"), the attachment contentis expected to be in either the textContent inputelement or the file name storing the attachment isexpected to be in the fileName input element.When the content type is anything other than"text/*", the attachment content is in either thebinaryContent input element or the file namestoring the attachment is in the fileName inputelement.

binaryContent |textContent |fileName

choice This element contains the mime attachment.

The element can be one of the following:

● binaryContent: content of the attachment content of theattachment when the attachment is binary data.

● textContent: content of the attachment when theattachment is text data.

● fileName: the file name of the attachment written to thedisk.

Fault

The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more informationabout error codes and the corrective actions to take.

Fault Thrown When..

ActivityTimedOutException The timeout for the activity is attained.

HttpClientException The HTTP server responds with a message containing the 4XXstatus code.

64



Fault Thrown When..

HttpServerException The HTTP server responds with a message containing the 5XXstatus code.

HttpCommunicationException An HTTP exception occurred while executing the specifiedmethod, or when trying to read the response.

Sending Data in the HTTP RequestYou can use several HTTP methods in an HTTP request. Each method sends data in the request in adifferent manner. For example, the GET method uses the query string of the RequestURI to passparameter and value pairs. Other methods use the HTTP message body to send data in the request.

The Send HTTP Request activity has the following three input elements for sending data in a request:

● Post Data: corresponds to the body of the HTTP message. All methods except the GET methodaccept data in this element.

● Query String: corresponds to the query string of the RequestURI. You can use this input element todynamically construct the query string using an XPath expression when you do not know thenames or number of the input parameters for the request until the activity executes.

● Parameters: corresponds to the parameters defined in the Parameters field on the General tab. Thisis useful if you have a fixed set of parameters to send with the request. For requests using the GETmethod, these parameters are passed as the query string of the RequestURI. For requests using thePOST method, these parameters are usually sent as the body of the HTTP message. They can also beincluded in the query string.

These input elements are mutually exclusive for some methods. For example, for POST requests, youcan either specify parameters on the General tab and in the parameters input element or you canspecify a PostData input element. However, do not specify both input elements. In the case of a POSTrequest, the PostData input element is ignored when you specify parameters on the General tab.

For GET requests, you can either specify the parameters on the General tab and in the parameters inputelement or you can specify a QueryString input element. If you know the list of parameters for therequest, configure the parameters on the General tab. If the list of parameters is not known until theactivity executes, use the QueryString element. However, when you specify all parameters on theGeneral tab as Optional, you can use the QueryString input element instead of the parameters inputelement. If any element in the parameters element contains an expression, the QueryString element isignored.

Special Characters in HTTP Requests

Depending upon the content type of the data for the request, the request can contain URL-encoded dataand the server decodes the data. If this is the case and you want to send special characters such as +, /,or = in your HTTP request, your data string must be URL-encoded if you send the data using thePostData or QueryString input elements. If you send the data using the parameters specified on theGeneral tab, encoding is done automatically.

For example, if you want to specify the following PostData:

name=John Smith&address=500 1/2 Main Street,

the PostData input element should result in the following string:

name=John%20Smith&address=500%201%2F2%20Main%20Street

For more information about the URL specification, see http://www.rfc-editor.org/rfc/rfc1738.txt.

65


http://www.rfc-editor.org/rfc/rfc1738.txt

Send HTTP ResponseSend HTTP Response is a synchronous activity that sends a response to a previously received HTTPrequest. The default status line returned by this activity is "200 OK".

General


Field Description


Reply For The HTTP Receiver process starter activity that received the request. This is alist of available activities that can receive HTTP requests.

Flush Response You can specify whether the response is to be flushed after each Send HTTPResponse activity.

By default, this property is not selected. This check box is useful when there area large number of Send HTTP Response activities in a job. In such cases, theClose Connection check box is selected in the last activity to indicate theresponse is complete.

However, selecting the Flush Response check box overrides this behavior andcauses the response to be flushed after each Send HTTP Response activity.

CloseConnection

Specifies that this activity contains the last part of an HTTP response. This fieldis used when you have more than one Send HTTP Response activities in aprocess and each activity sends a part of the response to the client. All SendHTTP Response activities in a process should have this check box clear, exceptthe last Send HTTP Response activity. Select this check box for the last SendHTTP Response activity to indicate the response is complete.

Select this check box, if the entire response is sent by only one Send HTTPResponse activity in the process.

Description


Input Editor

Input Editor tab describes the data structure for the headers of the HTTP response. You can use thedefault structure, or you can alter the structure, if the outgoing response has a specific data structure forthe header of the request.

The header structure is defined by the HTTP protocol. See the HTTP Protocol specification for moreinformation about the fields and content of the header of a HTTP request. You can obtain thisspecification at www.w3.org.

The following are the default header fields.

66


http://www.w3.org/

Header Datatype Description

StatusLine string This field is the first line of a response message. This consistsof the protocol version, a numeric status code, and the textphrase explaining the status code.

See the HTTP specification for more information about statuscodes in HTTP responses.

Content-Type string This field indicates the media type of the entity body sent tothe receiver. The media types are described in the HTTPspecification. An example of the media type is: text/html;charset=ISO-8850-4.

By default this item is set to text or html. If you are usingthis activity and the Retrieve Resources activity to retrieve aWSDL file, you should set the type to text or xml whenspecifying values on the Input tab.

Set-Cookie string See the HTTP specification for more information about thisfield.

Pragma string This field is used to include implementation-specificdirectives that might apply to the receiver. See the HTTPspecification for more information about using this field.

Location string This field is used to redirect the receiver to a location otherthan the RequestURI for the completion of the request or foridentifying a new resource.

Input



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. Seethe description of the Input Editor tab for more informationabout these items.

Only the first Send HTTP Response activity in theprocess can set the Headers element. If your processcontains multiple Send HTTP Response activities, theheaders are set by the first activity and this element isignored for all subsequent activities.

67



DynamicHeaders

complex The dynamic header is an additional header parameter to addruntime headers to the outgoing HTTP messages. This elementis specified on the Input tab. DynamicHeaders consists of thefollowing information:


You can consider the following overriding conditions:

● Overrides the value of the HeaderName with the valuefound in the DynamicHeaders, if it is a non-repeatingheader. If more than one occurrence of this header is foundunder 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 valuepairs under DynamicHeaders. This is added to the existinglist maintained for this element.

● For a repeating element, if the new header name is not foundunder the "Headers" section in TIBCO Business StudioContainer Edition, the following is added into the HTTPheaders.

— Shows only one value, if found once in theDynamicHeaders.


mimeEnvelopeElement


This element contains a repeating element named mimePart thatcontains each mime attachment.

68




● content-disposition: to suggest a filename for an attachment,use "*;filename=<filename>" in this element.


● content-type● content-transfer-encoding● content-id● any element

See http://www.faqs.org/rfcs/rfc2045.html for more informationabout MIME headers and their syntax.

When the content type is specified as "text/*" (forexample, "text/xml"), the attachment content iseither the textContent input element or the file namestoring the attachment is in the fileName inputelement. When the content type is anything other than"text/*", the attachment content is in either thebinaryContent input element or the file name storingthe attachment is in the fileName input element.

binaryContent|

choice This element is the content of the attachment when theattachment is binary data.

Fault

The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more informationabout error codes and the corrective action to take.

Fault Thrown When..

HttpCommunicationExceptio

n

An HTTP exception occurred when sending the response.

69



JAVA Palette

Converting JAVA Class to XML SchemaThis topic lists the rules that need to be followed when converting Java class to XML schema.

The Java class is converted to an XML schema using the following rules:

● The Java class public member should not have the public getter and setter methods for it.● The Java class member public variable name is mapped to an XML element with the same name. For

example, a Java class member variable declared as public int ZipCode is mapped to an XMLelement named ZipCode.

● The Java Bean accessors and modifiers are mapped to appropriate XML element names. Forexample, a Java class method public int getBalance() or public void setBalance(int Balance) aremapped to an XML element named Balance.

● Only one XML element is created regardless of how many members of the Java class share the samename. For example, there may be an attribute named MySalary and accessors named getMySalary()and setMySalary(). This translates to one element named MySalary in the resulting XML document.

● All Java primitive types are supported. Datatypes that extend java.util.Collections, are alsosupported (for example, List, ArrayList, and Vectors). Arrays (for example, int[ ] and string[ ]) arealso supported.

● Use Java generics and provide the type information while declaring and creating the collection forexample,

Instead of using List list = new ArrayList();

use generics: List<String> list = new ArrayList<String>();● The datatype java.util.Map or any types that extend java.util.Map are not supported. For

example, HashMap is not supported.

Creating Custom XPath FunctionsThis topic provides the detailed procedure of creating a custom XPath function group. You can use theCustom XPath Function wizard to create your custom XPath function group. It uses thecom.tibco.xml.cxf.customXPathFunction extension.

Procedure

1. Launch TIBCO Business Studio and select File > New > Project.

2. In the New Project window, select Plug-in Project and click Next.

70


3. Specify a name for the project that reflects the XPath functions, for example,MyCustomXPathFunctions. Retain all other default selections and click Next.

4. On the Plug-in Content page, locate the Options group and ensure This plug-in will makecontributions to the UI is selected.

5. Accept all of the defaults and click Next.

71


6. Select Custom XPath Function Wizard on the Templates page, and click Next.

72


7. In the New Custom XPath Function Group plug-in project window provide values for the followingfields and click Next to continue.

● Category: The name of the category that includes the custom XPath functions

● Prefix: The prefix for the functions

73


● Namespace: The namespace for the functions

● Help Text: The description of the functions

8. Specify the XPath Function and XPath Function Parameters in the XPath Function Group CreationSection dialog.

9. Click the Add button located on the right side of the XPath Functions table and provide values for:

● Name: the name of the function● Return Type: the return type of the function● Description: the description of the function

10. Click the Add button located on the right side of the XPath Function Parameters table. Specifyvalues for the following parameters and click Finish:

● Name: the name of the parameter● Type: the data type of the parameter● Optional: select the check box if the parameter is optional.

11. The Open Associated Perspective dialog displays. Click Yes.TIBCO Business Studio opens in Plug-in and the Plug-in Development perspective.

12. Open the Java class in the newly created Custom XPath function plug-in and implement theCustom XPath function.

74


Now your Custom XPath function is ready for use at design time and run time.

Using Custom XPath Function at Design Time and Run TimeYou can use the newly created Custom XPath functions at design time and run time.

Making Your Custom XPath Function Available at Design Time

Procedure

1. Right-click the Custom XPath Function Plug-in project and select Export from the menu. On theExport window, select Plug-in Development > Deployable plug-ins and fragments and click Next.

2. Select the Install into host Repository radio button on the Deployable plug-ins and fragmentsscreen and click Finish.

75


The Custom XPath function plug-in is exported into the TIBCO Business Studio ™ instance to use atdesign time.

3. You may be prompted with the following security warning message. Click OK.

4. Click Restart Now when the following window is displayed.

5. In TIBCO Business Studio ™, the Custom XPath function is available for use in any activity mapperin an TIBCO BusinessWorks ™ process.

76


Making Custom XPath Function Available at Run Time

● After using the Custom XPath function in an activity in an TIBCO BusinessWorks ™ processat design time, include the Custom XPath function plug-in the application project.

● After including the Custom XPath Function Plug-in in the application project, test it in the

Debugger and then, export it as an EAR, and deploy at run time.

Deleting Custom XPath FunctionsThis topic lists the steps to uninstall a Custom XPath function so that it is not visible in the mapper.

Procedure

1. On the menu bar, click Help. On Mac, this is located under the "BusinessWorks" menu.

77


2. Click Installation Details.The following dialog box is displayed.

3. Select the Custom XPath function you want to uninstall, and click the Uninstall button.

4. Restart the workspace.

JAVA InvokeJava Invoke is a synchronous activity that can be used to invoke a Java class method. You can constructan instance of the specified Java class, if you invoke the constructor for the class.

General


78


Field



Java GlobalInstance

None Specify the resource in this field to execute methods on sharedJava objects created by Java Global Instance resources.

Refer to Java Global Instance for more information about theshared Java objects created by Java Global Instance resources.

This disables the options on the Advanced tab. In the drop-down list in the Method field, you can select the method toexecute.

If the configuration of the Java Global Instanceresource changes, select and view any Java Invokeactivities in your process that reference the JavaGlobal Instance to automatically propagate thechanges. An exception is raised if you attempt to testyour process before refreshing the reference to theJava Global Instance. You may need to manuallyupdate the mappings of any input or output, if youselect a new method with a different signature in theJava Global Instance resource.

MultiOutput None Select this check box to specify multiple parameters in the Javainvoke method.

Class Name None The declared Java class whose method you want to execute.Use the Browse A Class button to select the class, or use theJava Global Instance field to specify a shared Java object.

Method None The method in the selected Java class you want to execute.

You can use the drop-down list to select a different method inthe selected Java class, if required.

79


Field


Parameters None The parameters for the Java Invoke activity. This element isavailable when the MultiOutput check box is selected.

This element contains a list of input and output parameters thatare required for the Java invoke. This element is not availablewhen the selected method has no parameters.

Each Input and Output parameter has the following fields.

● Field Type: It can be either In or Out.

● Field Name: The name of the parameter. When creating anew parameter, provide the name of the parameter. Thesetter/getter methods get automatically generated for thesame, or select the options from the drop-down list of thenames of class member variables that have setter/gettermethods.

● Type: The datatype of the parameter. The default is string.Specify one of the supplied Java primitive types, or specifyObject Reference when accepting a Java object from anotherJava activity as input.

● Occurrence: Specify whether the parameter is Required,Optional, or Repeating.

● Click to add the input parameter.

● Click to add the output parameter.

● Click to delete the parameter.

Description


Advanced


80


Field


Instantiate thereferenced class

None This field controls one of the following:

● The referenced class must be constructed when the activityis executed,

● An object reference must be supplied in the activity’s inputschema.

Select this check box, if you want to construct the referencedclass using the default constructor when the activity executes.In this case, the referenced class is not included in theactivity’s input schema.

Do not select this check box, if you want to provide an objectreference for the class name specified on the General tab. Theobject must be created and contained in the output schema ofa previously executed activity.

In this case, the referenced class is included in the activity’sinput schema.

This check box is not available when MultiOutput on theGeneral tab is selected.

Cache the object None This option is available only when the Instantiate thereferenced class check box is selected.

Select this check box to specify that all instances of this JavaInvoke activity share the instance of the instantiatedreferenced class. A cached referenced object is kept in thememory until the process engine terminates.

Not selecting this check box leads to each instance of this JavaInvoke activity creating its own copy of the referenced class.

Invoke CleanupMethod

None This check box is available only when the Cache the objectcheck box is selected.

When selected, you can invoke a method on the cached objectbefore the object is released from memory, when the processengine terminates. You can perform cleanup activities, such asclosing 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 Methodcheck box is selected.

Using this field you can specify the name of the method toinvoke, before the cached class in memory is released.

The selected method cannot contain any parameters, thereforeonly methods with no parameters are listed in this field. Anyvalues returned by the selected method are ignored, butexceptions raised by the selected method are sent to the log.

81


Input



Parameters varies This element contains a list of input parameters that arerequired for the Java invoke Method selected on the Generaltab.

This element is not available when the selected method has noparameters.

Output



MethodReturnValue varies The Output tab has the return value specified for the Javainvoke Method selected on the General tab.

This element is not available for methods that return void.

Parameters varies The Output tab lists all output parameters specified on theGeneral tab.

Selecting MultiOutput on the General tab makes this outputitem available.

Fault

The Fault tab lists the exceptions thrown by this activity. Selecting a method to invoke lists theexceptions thrown by the method.

In theJava Invoke activity:

● If MultiOutput is selected, the Fault tab throws the InvocationException exception with errorschema element as msg,msgCode,methodName,exceptionClassName,exceptionMessage.

● If MultiOutput is not selected, the Fault tab shows the exceptions thrown by the method selected init with error schema elements as: 1:Java exception Object 2:exceptionClassName3:exceptionMessage

● If MultiOutput is not selected and method does not throw any exception, again the Fault tab showsInvocationException with error schema element as msg, msgCode, methodName,exceptionClassName, and exceptionMessage.

Error Schema Element Datatype Description

msg string The TIBCO BusinessWorks Container Edition errormessage. For details, refer to Error Codes.

msgCode string The TIBCO BusinessWorks Container Edition error code.For details, refer to Error Codes.

82


Error Schema Element Datatype Description

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.

exceptionMessage string The exception message.

The value of this element is obtained by calling the<exception>.getMessage() method.

Java Process StarterJava Process Starter is a process starter activity. You can use this activity to create a custom starterwritten in Java.

Java Process Starter Abstract Class

The JavaProcessStarter abstract class defines the interface of your Java Process Starter with the TIBCOBusinessWorks Container Edition application. You must define an implementation for the followingmethods:

● init() : this method is called when the process engine starts up. This method should initialize anyresource connections. You could also specify a Java global instance on the Advanced tab thatinitializes resource connections. Java global instances are also loaded and initialized duringapplication start up. You can call this .getJavaGlobalInstance() to obtain the Java global instanceresource in your process starter code.

● onStart() : this method is called by the process engine to activate the process starter. This methodshould activate any event notifier or resource observer code. The notifier or observer code can thencall the onEvent() method to start a process instance.

● onStop(): this method is called by the application to deactivate the process starter. This methodshould deactivate any event notifier or resource observer code.

● onShutdown(): this method is called by the application when the runtime shuts down. This methodshould release any resources and resource connections and perform any required clean upoperations.

The following methods are already implemented and can be used in your code:

● onEvent(Object object): this method is called when a listener or resource observer catches a newevent. The input to this method is a Java object containing the event data.

● getGlobalInstance(): this method returns an object reference to the Java global resource specified onthe Advanced tab of the process starter. This is useful if you want to place initialization code orother shared information in a Java global resource instead of in the init() method of this class.

● onError(): this method throws the exception specified in the input parameter. Use this method topropagate an error to the TIBCO BusinessWorks Container Edition process instance when a listeneror resource observer fails to generate an event.

Passing Java Objects Between Java Activities

You can create instances of Java objects in Java Invoke activity or by using the Java Invoke or XML ToJava activities. These Java objects can be passed using an output parameter to another activity later inthe process definition. The Java Invoke activity receiving a Java object accepts the object into an inputparameter. Map the output Java object to the input object of the receiving Java Invoke object.

83


Any Java objects passed by input and output parameters between activities should have the capabilityto serialize.

General


FieldProcessProperty Description

Name No The name to be displayed as the label for the activity in theprocess.

Class Name No The name of the compiled Java class that is implemented byextending the JavaProcessStarter abstract class.

Use the Browse a Class button to select the class from thespecified class library. This shows the classes that extend fromthe JavaProcessStarter abstract class.

Initialize withParameters

No Selecting this check box displays the Init Method field and InitParameters table.

Init Method No Selecting the Initialize with Parameters check box displays thisfield.

You can use the drop-down list, if required, to select a differentmethod in the selected Java class.

Init Parameters No Specify default values in this table for the input parameters ofthe init() method. Each input parameter has three fields:

● Parameter Name: the name of the parameter.● Parameter Type: the datatype of the parameter.● Parameter Value: specify a default value for the parameter.

Description


Advanced


Field Description

Sequence key This field can contain an XPath expression that specifies which processesshould run in sequence. Process instances with sequencing keys thatevaluate to the same value are executed in the sequence the processinstance was created.

Custom Job Id This field can contain an XPath expression that specifies a custom job IDfor the process instance.

84


Field Description

Java Global Instance A Java global instance resource. Specify a value in this field to reference aJava global instance resource in your JavaProcessStarter implementationclass. Refer to Java Global Instance for details.

You can use the getGlobalInstance() method to obtain a reference to theJava global instance resource.

Output


Output ItemDatatype Description

javaObject varies The Java object that was passed to the onEvent() method.

By default, this element is a Java object reference.

Fault


Error SchemaElement Datatype Description

msg string The BusinessWorks Container Edition error message. Fordetails, refer to Error Codes.

msgCode string The BusinessWorks Container Edition error code. For details,refer to Error Codes.

Java To XMLJava To XML is a synchronous activity. You can use this activity to convert Java object's data membersinto an XML document.

If the class does not have a public data member and only has a Java bean modifier that sets the data, theinput schema contains an element for the modifier, but the resulting XML document has no value setfor the corresponding element. For example, the Java object has a method declared as public int setID(),but there is no method for getting the ID and the data member ID is not public. In this case, an elementnamed ID in this activity’s output schema exists, but that element has no value because there is nopublic mechanism for getting the data.

General


FieldModuleProperty? Description

Name No The name to be displayed as the label for the resource.

85



Class Name No The class name in the Java schema to use.

Use the Browse button to bring up the dialog to select the Javaclass.

Click the Reload button to regenerate the schema.

Description


Advanced


Field Description

Instantiate thereferenced class

This field controls one of the following:

● The referenced class must be constructed when the activity isexecuted.

● An object reference must be supplied in the activity’s input schema.

Select this check box to construct the referenced class using the defaultconstructor when the activity executes. In this case, the referenced classis not included in the activity’s input schema.

Do not select this check box if you want to provide an object referencefor the class name specified on the General tab. The object must becreated and contained in the output schema of a previously executedactivity.

In this case, the referenced class is included in the activity’s inputschema.

Cache the object This option is available only when you select the Instantiate thereferenced class check box.

Select this check box to specify that all instances of this Java Invokeactivity share the instance of the instantiated referenced class. A cachedreferenced object is kept in the memory until the process engineterminates.

Not selecting this check box leads to each instance of this Java To XMLactivity creating its own copy of the referenced class.

Input


86


Input item Datatype Description

referenced class Java Object An object reference to the Class Name specified on theGeneral tab. This element is only available when you do notselect the Instantiate the referenced class check box on theAdvanced tab.

Output



XML Schema varies The output is the XML schema from the converted Java object.

The elements in the schema display in alphabetical order.

Fault

The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more informationabout error codes and possible the corrective actions to take.

Fault Thrown When...

JavaToXMLConversionExceptio

n

An error occurred when converting the Java object to XML.

XML To JavaXML to Java is a synchronous activity. You can use this activity to create an instance of a Java objectbased on data from an XML document. The XML schema for providing the input to the Java object orJava schema specified on the General tab of this activity.

The specified Java class must meet the following requirements:

● The Java class must have a public default constructor (that is, a constructor with no arguments).● The Java class must be eligible to be serialized (that is, the class must implement or be a subclass of a

class that implements java.io.Serializable).

If the class does not have a public data member and only has a Java bean accessor that retrieves thedata, the input schema contains an element for the accessor. However, the resulting Java object has novalue set for the member. For example, the object has a method declared as public int getID(), but thereis no method for setting the ID and the data member ID is not public. In this case, an element named IDin this activity’s input schema, but mapping a value to the element does not result in setting the IDmember of the output Java object. This is because there is no public mechanism for setting the data.

General




87



Class Name No The class name in the Java schema to use.

Use the Browse button to bring up the dialog to select the Javaclass.

Description


Input



XML Schema varies The XML schema you want to convert to a Java object. Thecontent of this schema depends upon the Java class or Javaschema defined in the Class Name field on the General tab.

The elements in the schema display in an alphabetical order.

Output



referencedclass

Java Object A Java object that is created out of the XML schema.

Fault

The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more informationabout error codes and the possible corrective actions.

Fault Thrown When..

XMLToJavaConversionExceptio

n

An error occurred when converting the XML schema to a Javaobject.

88


JDBC Palette

The JDBC palette contains activities and shared resources for querying, updating, or calling storedprocedures in the database.

JDBC Call ProcedureJDBC Call Procedure is an asynchronous activity that calls a database procedure or function using thespecified JDBC connection. If this activity is not part of a transaction group, the SQL statement iscommitted after the activity completes.

If this activity is part of a transaction group, the SQL statement is committed or rolled back with theother 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 transactiongroup, select the Override Transaction Behavior check box on the Advanced tab. This specifies that theactivity 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


Field

Literal Value/ProcessProperty/ModuleProperty? Description


JDBC SharedResource

Yes The path to the shared resource containing the JDBCconnection information.

See JDBC Connection for more information about JDBCresources.

Timeout Yes The time (in seconds) to wait for the procedure call tocomplete. If the call does not complete in the specified timelimit, it returns an error.

Maximum Rows Yes The maximum number of rows to retrieve. To retrieve allrows, specify 0.

Description


Procedure

The Procedure tab has the following fields.

89


Field


Schema Yes The schema in which the procedure resides. This name is used toresolve naming conflicts, if more than one schema in the database hasthe selected procedure with the same name.

Configure the Schema field to use a Process Property or a ModuleProperty if a schema has been defined for the project, and you knowthe schema name. To search for a schema, configure the field to use aLiteral Value , and click the Browse button to select a schema fromthe database that is using the specified JDBC Connection.

Catalog orPackage

Yes The catalog or package in which the procedure resides. This name isused to resolve naming conflicts if more than one catalog or packagein the database has selected procedures with the same name.

Configure the Catalog or Package field to use a Process Property or aModule Property if a catalog or package has been defined for theproject, and you know their names. To search for a catalog orpackage, configure the field to use a Literal Value , click the Browsebutton, and select a catalog or package from the database using thespecified JDBC Connection. If a schema is specified in the Schemafield, only catalogs or packages in the specified schema are listed.

This field is only applicable to databases with more than one catalogand package. See your database documentation for more informationabout catalogs and packages.

Procedure/ Function

No The name of the database procedure or user-defined function to call.

Click the Browse button to select the database for availableprocedures or functions after specifying the JDBC Connection field.

Click the Refresh button to retrieve the changes from the database, ifyou change the parameters or signatures while editing your project.

The list of available procedures and functions is limited by the valuessupplied in the Schema and Catalog or Package fields.

Parameters

No This field displays the parameters for the procedure and you canoverride the data type (IN, OUT, IN/OUT) for each parameter in theDirection column.

The parameters listed in the table show the Parameter Name, DataType, and the Direction (IN, OUT, IN/OUT) of the each parameter.All IN and IN/OUT parameters listed in the Parameters table areshown in the Input tab of the activity for the user to provide values.

Advanced


90


Field Description

ThreadPoolSharedResource

Specifies a queue of threads available to run a queue of tasks. Thread poolsare used to improve performance when executing large numbers ofasynchronous tasks by reducing per task invocation overhead, provide ameans of bounding, and managing the resources consumed when executinga collection of tasks.

OverrideTransactionBehavior

Overrides the default behavior of a transaction group. If this activity is in atransaction group, the activity is normally committed or rolled back with theother transactional activities.

Select this check box to specify that this activity is not part of the transactiongroup and is committed when it completes. Also, select this check box to usea separate database connection to perform the activity and commit the SQLstatement.

Interpret EmptyString as Null

Specifies how empty strings in the activity’s input elements should behandled. Selecting this check box sends the nulls to the database whereempty strings are supplied.

Empty strings are treated as zero-length strings, if this check box is notselected. Whether you use this option or not, you can still use XPath to setinput elements explicitly to null.

ResultSets UseSchema

Specifies that the design-time must try to fetch the schema when a resultsetis expected from a stored procedure call.

When selected, TIBCO Business Studio Container Editiontries to invoke thestored procedure with default values and get the metadata for the resultset.

If the check box is not selected, or if TIBCO Business Studio ContainerEditiondoes not get any metadata, the results are displayed as ’unknownresultsets’.

Input

The input for this activity is dependent upon the input parameters of the database procedure.


inputSet complex The input parameters of the database procedure. Thedatatype contained in this element varies depending uponthe parameters specified for the database procedure.

The IN and IN/OUT parameters displayed in the Parameterstable on the Procedure tab are displayed here for the user toset values.

ServerTimeZone string Specifies the time zone for the database server.

timeout number The time (in seconds) to wait for the procedure call tocomplete. The call if not completed in the specified timelimit, returns an error.

maxRows number The maximum number of rows to retrieve. To retrieve allrows, specify 0.

91


Output

The output of the activity is depends upon the output parameters of the database procedure.


outputSet complex The output of the database procedure. The datatypecontained in this element varies depending upon what thedatabase procedure returns.

UnresolvedResultSets

string The output of the database procedure may return other resultsets. These result sets are returned in this output item as anXML string. Create a schema resource to describe these resultsets, and then use the Parse XML activity to parse the XMLbased on the schema. You can then use the parsed output insubsequent activities.

Fault

The Fault tab lists the possible exceptions thrown by this activity. See Error Codes for more informationabout error codes and the possible corrective action to take.

Fault Thrown When..

JDBCConnectionNotFoundException An error occurred when attempting to connectto the specified database.

InvalidTimeZoneException An invalid time zone was specified.

JDBCSQLException An SQL error occurred.

LoginTimedOutException A timeout occurred while attempting toconnect to the database.

ActivityTimedOutException The operation times out.

JDBC QueryJDBC Query is an asynchronous activity that performs the specified SQL SELECT statement. If thisactivity 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 theother 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 atransaction 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 whenthe activity completes, even if the activity is in a transaction group.

General


92


Field



JDBC SharedResource

Yes The path to the shared configuration resource containing theJDBC connection information. For details, refer to JDBCConnection

Timeout(sec) Yes The time (in seconds) to wait for the query to complete. If thequery does not complete in the given time limit, an error isreturned.

Maximum rows Yes The maximum number of rows to retrieve. To retrieve allrows, specify 0.

Description


Statement

The Statement tab has the following fields.

Field Description

Statement This is the SQL SELECT statement to perform in the database. You can use aSQL Builder wizard to build the query for the desired database.

Prepared Statement The Prepared Statement contains the Parameter Name and Data Type fields.All the parameters defined in the Prepared Statement table are shown in theInput tab of the activity for the user to provide values.

Each prepared statement corresponds to the question mark in the sameposition in the SQL statement. That is, the first prepared statement in the listcorresponds to the first question mark, the second prepared statement in thelist corresponds to the second question mark, and so on. The warning is forthe purpose of information only. Ensure that the parameters in this fieldcorrectly correspond to the statement.

You can optionally specify names for each prepared parameter. By default, the prepared statements arenamed Parameter1, Parameter2, and so on. You must supply the datatype of each parameter to the SQLstatement, and this datatype is used in the input schema for the statement.

Execute the Query Button

Runs the JDBC Select statement entered in the Statement field and shows the results in the ResultsView. These results are persisted in the workspace.

SQL Button

Launch Eclipse SQL Builder. For more information on using the SQL Builder to visually build queries,go to: http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.datatools.sqltools.doc.user%2Fdoc%2Fhtml%2Fasc1229700427574.html

Fetch Button

93


http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.datatools.sqltools.doc.user%2Fdoc%2Fhtml%2Fasc1229700427574.html

http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.datatools.sqltools.doc.user%2Fdoc%2Fhtml%2Fasc1229700427574.html

Using the Fetch button on this activity, you can synchronize the activity with the contents of thedatabase. When you first configure a JDBC activity, click the Fetch button to retrieve the schema for theoutput result set before applying your changes by saving your project.

After you have configured your activity, the Fetch button is useful when you make a change to thedatabase while editing a process containing this activity in TIBCO BusinessWorks Container Edition.The Fetch button synchronizes with the database and changes the output schema, if necessary.

Advanced


Field Description


Specifies a queue of threads available to run a queue of tasks. Thread poolsare used to improve performance when executing large numbers ofasynchronous tasks by reducing per task invocation overhead, provide ameans of bounding, and managing the resources consumed when executing acollection of tasks.



This activity is not part of the transaction group and is committed when itcompletes, when this check box is selected. Selecting this option uses aseparate database connection to perform the activity and commit the SQLstatement.

Use Nil Specifies whether NULLs are represented as optional schema elements orwhether each item that can contain a NULL has subitems.


Specifies how empty strings in the activity’s input elements should behandled. Selecting this check box sends the nulls to the database whereempty strings are supplied. Empty strings are treated as zero-length strings,when this check box is not selected. Whether you use this field or not, youcan still use XPath to set input elements explicitly to null.

Many databases treat empty strings and nulls as the same, so thisfield does not affect how the database interprets empty strings.

Process In Subsets Selecting this check box specifies that you want to process the result set insmaller batches rather than processing the entire result set at once. When thischeck box is selected, the subsetSize input element is displayed for you tospecify the size of each batch of records you want to process. Also, thelastSubset output element is displayed and is set to true when the last batchof records is being processed.

Not selecting this check box returns the whole result set.

Input


94




timeout number The time (in seconds) to wait for the query to complete. If thequery does not complete in the given time limit, an error isreturned.

maxRows number The maximum number of rows to retrieve. To retrieve all rows,specify 0.

Output



resultSet complex The root class for the output of the JDBC Query activity. Thisclass contains all output items for the activity.

Record complex The result of the database query. The contents of the Recordelement depends upon the columns returned by the query.

Fault


Fault Thrown When..

JDBCConnectionNotFoundException An error occurred when attempting to connect to thespecified database.



LoginTimedOutException A timeout has occurred while attempting to connect tothe database.

InvalidSQLTypeException A parameter’s datatype does not match the datatype ofthe table column.

DuplicatedFieldNameException A duplicate field name was specified.

ActivityTimedOutException The operation has timed out.

95


JDBC UpdateJDBC Update is an asynchronous activity that performs the specified SQL INSERT, UPDATE, orDELETE statement.

If this activity is not part of a transaction group, the SQL statement is committed after the activitycompletes. If this activity is part of a transaction group, the SQL statement is committed or rolled backwith 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 atransaction 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 whenthe activity completes, even if the activity is in a transaction group.

General


Field



JDBC SharedResource

Yes The path to the shared resource containing the JDBC connectioninformation. For details, refer to JDBC Connection

Timeout Yes The time (in seconds) to wait for the query to complete. If thequery does not complete in the given time limit, an error isreturned.

Description


Statement

The Statement tab has the following fields.

Field Description

Statement This is an SQL INSERT UPDATE OR DELETE statement to perform in thedatabase. You can use the SQL Builder wizard to build the query for thedesired database.

96


Field Description

Prepared Statement The Prepared Statement contains the Parameter Name and Datatype fields.All the parameters defined in the Prepared Statement table are shown in theInput tab of the activity for the user to provide values.

Each prepared statement corresponds to the question mark in the sameposition in the SQL statement. That is, the first prepared statement in the listcorresponds to the first question mark, the second prepared statement in thelist corresponds to the second question mark, and so on. The warning is forinformational purposes only, you must make sure the parameters in this fieldcorrectly correspond to the statement.

Advanced


Field Description


Specifies a queue of threads available to run a queue of tasks. Thread poolsare used to improve performance when executing large numbers ofasynchronous tasks by reducing per task invocation overhead, provide ameans of bounding, and managing the resources consumed when executing acollection of tasks.

Insert if recorddoesn't exist

Select this check box to insert the record if it does not exist in the database.



If you select this check box, this activity is not part of the transaction groupand is committed when it completes. Selecting this option uses a separatedatabase connection to perform the activity and commit the SQL statement.

Override JDBCConnection

Selecting this option overrides the default datasource connection, and allowsfor SQL queries to be executed against the optional datasource.

After selecting this option, the sharedResourceName field is enabled underthe Input > Data Source tab. From the sharedResourceName field, type thecomplete path with the name of the optional datasource, which can be foundunder the Resources folder. For example, if a JDBC shared resource is locatedat Resources > Package_Name > JDBC_SR_Name, then the value you entershould be Package_Name.JDBC_SR_Name. The value you enter in theXPath Expression field is case sensitive and must be a string.

To avoid mapping issues, ensure the optional datasource maintains astructure that is identical to the default database, and that both datasourcesare using the same datatypes.

Transactions between multiple datasources is not supported.

97


Field Description


Specifies how empty strings in the activity’s input elements should behandled.

Selecting this check box sends the nulls to the database where empty stringsare supplied.

When the check box is not selected, empty strings are treated as zero-lengthstrings. Whether you use this check box option or not, you can still use XPathto set input elements explicitly to null.

Many databases treat empty strings and nulls as the same, so thischeck box does not affect how the database interprets emptystrings.

Batch Update Selecting this check box signifies that you want to perform multiplestatements by supplying an array of records as input to the activity whereeach record matches the prepared parameters for the statement. Thestatements are performed in one batch at the end of the activity’s execution.

If you do not select this check box, the expected input is the list of preparedparameters for the statement (no array of records). Some database driversmay not support batch updates. A JDBCSQLException is thrown, if thedatabase driver does not support batch updates.

Input




timeout number The time (in seconds) to wait for the query to complete. If thequery does not complete in the given time limit, an error isreturned.

Output



noOfUpdates integer The number of updates performed by the statement specifiedon the General tab.

This element can also return -2 that indicates, in the event of abatch update, that the updates were successful, but it isunknown how many updates were performed.

Fault


98


Fault Thrown When..




LoginTimedOutException A timeout has occurred while attempting to connect to thedatabase.

InvalidSQLTypeException A parameter’s datatype does not match the datatype of thetable column.


SQL DirectSQL Direct is an asynchronous activity that executes an SQL statement that you supply. With thisactivity you can build an SQL statement dynamically using other activities, then pass the SQLstatement into this activity's input. You can use this activity to execute DDL SQL statements likeCREATE and DROP. You can also execute SQL statements that are not supported by other activities inthe JDBC palette.

If this activity is not part of a transaction group, the SQL statement is committed after the activitycompletes. If this activity is part of a transaction group, the SQL statement is committed or rolled backwith the other JDBC activities in the group at the end of the transaction.

General


Field



JDBC SharedResource

Yes The path to the shared resource containing the JDBC connectioninformation. For details, refer to JDBC Connection.

Timeout Yes The time (in seconds) to wait for the query to complete. If thequery does not complete in the given time limit, an error isreturned.

Maximum Rows Yes The maximum number of rows to retrieve. To retrieve all rows,specify 0.

Description


99


Advanced

The Advanced tab has the following field.

Field Description

ThreadPoolSharedresource

Specifies a queue of threads available to run a queue of tasks. Thread poolsare used to improve performance when executing large numbers ofasynchronous tasks by reducing per task invocation overhead, provide ameans of bounding, and managing the resources consumed when executinga collection of tasks.



If you select this check box, this activity is not part of the transaction groupand is committed when it completes. Selecting this option uses a separatedatabase connection to perform the activity and commit the SQL statement.

Override JDBCConnection

Selecting this option overrides the default datasource connection, and allowsfor SQL queries to be executed against the optional datasource.

After selecting this option, the sharedResourceName field is enabled underthe Input > Data Source tab. From the sharedResourceName field, type thecomplete path with the name of the optional datasource, which can be foundunder the Resources folder. For example, if a JDBC shared resource islocated at Resources > Package_Name > JDBC_SR_Name, then the valueyou enter should be Package_Name.JDBC_SR_Name. The value you enterin the XPath Expression field is case sensitive and must be a string.

To avoid mapping issues, ensure the optional datasource maintains astructure that is identical to the default database, and that both datasourcesare using the same datatypes.

Transactions between multiple datasources is not supported.

Input



statement string The SQL statement you want to execute. You can use anyprocess variables to build the statement dynamically, ifrequired.


timeout number The time (in seconds) to wait for the query to complete. If thequery does not complete in the specified time limit, an error isreturned.

maxRows number The maximum number of rows to retrieve. To retrieve all rows,specify 0.

100


Output



noOfUpdates string The number of updates performed by the statement specifiedon the General tab.

This element can also return -2 that indicates, in the event of abatch update, that the updates were successful, but it isunknown how many updates were performed.

unknownResultSet

string The result of the database statement. The result elementdepends upon what is returned by the statement.

The result set is a list of zero or more rows with zero or morecolumns. Each column contains a name and a value element.You can use XPath expressions to retrieve the desired row andcolumn from the result set. There can be multiple result setsreturned 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 resultset returned by the first statement executed by this activity. Thesecond item in the list of result sets corresponds to the result setreturned by the second statement executed by this activity, andso on.

Fault


Fault Thrown When..




LoginTimedOutException A timeout has occurred while attempting to connect to thedatabase.


101


JMS Palette

Java Message Service (JMS) is a specification about sending and receiving messages between two ormore applications in a Java environment. The JMS palette is used to send and receive JMS messages ina process.

The models supported are:

● Point-to-Point (queues): Message delivered to one recipient● Publish/Subscribe (topics): Message delivered to multiple recipients

JMS supports these two models by using distinct interfaces within the API for each messaging model.Refer to the documentation of the JMS provider or JMS specifications for more information about JMSand its message models.

Common JMS Properties and HeadersJMS properties comprise message headers and message properties. MessageHeader properties are setby the JMS client sending the message. You can view these after the message is received. You can alsoset MessageProperties on the outgoing messages on the Input tab of the activity that sends messages.

Message Headers

The following table describes the messages headers.

MessageHeadersProperty Dataype Description

JMSDestination string The destination where the message is sent.

JMSReplyTo string The JMS destination where the reply message shouldbe sent.

JMSDeliveryMode string The delivery mode of the message. Can be one of thefollowing:

● PERSISTENT: signifies the messages are stored andforwarded.

● NON_PERSISTENT: messages are not stored andmay 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 providerto 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 isexpressed as the amount of time, in milliseconds sincemidnight, January 1, 1970, UTC. If set to 0, the messagedoes not expire.

JMSRedelivered boolean Typically this item is set when the JMS provider hasdelivered the message at least once before.

102


MessageHeadersProperty Dataype Description

JMSPriority integer The priority of the message. Priority is a value from 0-9.Higher numbers signify a higher priority (that is, 9 is ahigher priority than 8).

JMSCorrelationID string This ID is used to link a response message with itsrelated request message. This is usually the message IDof a request message when this field is found in a replymessage.

JMSType string The JMS provider-supplied string to describe the typeof the message. Some JMS providers use this propertyto define messages in the provider’s repository. See theJMS provider documentation for more informationabout the use of this field.

Message Properties

The following table describes the messages properties.

MessageProperties Dataype Description

JMSXUserID string The ID of the user sending the message.

This property is optionally set on incoming messagesby the JMS application. This property is not set onoutgoing messages.

JMSXAppID string The ID of the application sending the message.


JMSXProducerTIXID string The transaction identifier of the transaction where thismessage was produced.


JMSXConsumerTXID string The transaction identifier of the transaction where thismessage was consumed.


JMSXRcvTimestamp integer The time the JMS server delivered the message to theconsumer. The time is expressed as the amount of time,in milliseconds since midnight, January 1, 1970, UTC.

This property is optionally set on incoming messagesby the JMS server. This property is not set on outgoingmessages.

103


MessageProperties Dataype Description

JMSXDeliveryCount integer The number of delivery attempts for this message.

JMSXGroupID string The identity of the message group this message is apart of.

You can set this property on outgoing messages togroup messages into a numbered sequence.

JMSXGroupSeq integer The sequence number of this message in its group.

You can set this property on outgoing messages togroup messages into a numbered sequence.

Get JMS Queue MessageGet JMS Queue Message is an asynchronous activity that retrieves a message from the specifiedqueue. You can use this activity to perform a receive operation on the queue as opposed to waiting for aqueue message to be delivered to the Wait for JMS Queue Message activity.

You can use the Message Selector field on the Advanced tab to retrieve a specific queue message fromthe queue.

General


Field



JMS Connection Literal Value

ModuleProperty

The JMS connection. For details refer to, JMS Connection.

Destination Yes The name of the queue from which to retrieve the message.

The syntax of the destination name is specific to the JMSprovider you are using. See the JMS providerdocumentation for more information about queue names.

104


Field


Message Type Yes The type of the message which can be one of the following:

● Text: The message is a java.lang.String.

● Bytes: A stream of bytes.● Map: A set of name or value pairs. The names are

strings, and the values are simple datatypes (JAVAprimitives), an array of bytes (use the Binary datatypewhen mapping this data), or a string. Each item can beaccessed sequentially or by its name.

● Object: A Java object that can be serialized.● Object Ref: An object reference to a Java object.● Simple: A message with no body part.● Stream: A stream of Java primitives, strings, or arrays

of bytes. Each value must be read sequentially.● XML Test: The message is XML text.

Max Sessions No Specifies the maximum number of client sessions that canconnect with the messaging server. This property isenabled only when the Client ACK mode is used.

The default value is 1.

Description

Provide a short description for the activity here.

Advanced


Field

Literal Value/ProcessProperty? Description

Message Selector Yes A string to determine whether a message should bereceived. The syntax of the message selector is determinedby the JMS provider (where message properties are usedinstead of table column names).

See the JMS provider documentation for more informationand syntax for a message selector string.

ApplicationProperties Type

None The type of application-specific message properties that ispart of the message.

105


Output Editor

The Output Editor tab defines the schema to use for messages of type Map, Stream, or XML Text. Mapmessages are name or value pairs, and using this schema you can define the structure of the retrieveddestination queue message. The schema defined on the Output Editor tab becomes the body of themessage on the Output tab. For XML Text message type, select an XSD element. For Map and Streammessage types, select an XSD type in the Output Editor tab.

Input



destinationQueue

string The queue to which to send the request. This input itemoverrides 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 theMessage Selector field of the Advanced tab. The syntax of themessage selector is determined by the JMS provider, but it isusually a subset of SQL92 (where message properties are usedinstead of table column names).

See the JMS provider documentation for more information andsyntax for a message selector string.

Output



JMSHeaders complex The message header fields for the message. See Common JMSProperties and Headers for more information about messageheader fields.

Only properties applicable to this type of message are displayed.

JMSProperties complex The message properties for the message. See Common JMSProperties and Headers for more information about messageproperties.


Body as permessage type

The body of the message.

Fault


106


Fault Thrown When..

JMSInvalidInputException The input to the activity is not valid.

JMSSessionCreateException The JMS session could not be created.

JMSReceiveException The JMS receive operation failed.

ActivityTimedOutException The specified timeout is attained and the activity has notcompleted its execution.

JMS Receive MessageJMS Receive Message is a process starter activity that starts the process based on the receipt of amessage for the specified JMS destination.

General


Field



Messaging Style Yes Select from one of the following available messaging styleoptions:

● Generic: This options corresponds to an abstract JMSDestination. If you are not sure whether yourdestination is a Queue or Topic, select Generic.

● Queue● Topic

JMS Connection None The JMS connection. See JMS Connection for moreinformation.

Destination Yes The JMS destination from where the process starterreceives the message.

107


Field


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 (JAVAprimitives), an array of bytes (use the Binary datatypewhen mapping this data), or a string. Each item can beaccessed sequentially or by its name.

● Object: a Java object that can be serialized.● Object Ref: an object reference to a Java object.● Simple: a message with no body part.● Stream: a stream of Java primitives, strings, or arrays of

bytes. Each value must be read sequentially.● XML Test: the message is XML text.

Durable Subscriber Yes Specifies a durable subscription.

You must specify a name in the Subscription Name fieldthat is registered with the JMS application as the durablesubscriber name. This field is only available if theMessaging Style is Generic or Topic.

Subscription Name Yes The subscription name registered with the JMS applicationfor durable subscriptions. This field is only available whenyou select the Durable Subscriber check box.

After creating a durable subscription you can only beremove this by accessing the administration tool of the JMSprovider. See the documentation of the JMS provider formore information about managing durable subscriptions.

Suppress LocalMessages

Yes Specifies to not receive messages on the specified topicname when the message origin is the JMS application onthe same connection as the process engine.

If the process publishes and subscribes to messages withthe same topic name, this option is useful if you want tospecify whether to receive messages sent by the same JMSapplication that published the message.

Selecting this check box prevents the process fromreceiving messages sent by the same connection.

Keep this check box clear to specify that the messages sentby the same connection should be received.

108


Field


Acknowledge Mode Yes The acknowledge mode for incoming messages. It can beone of the following:

● Auto: the message is automatically acknowledged,when it is received.

● Client: the message is acknowledged at a later point byusing the Confirm activity. If the message is notconfirmed before the process instance ends, themessage is redelivered and a new process instance iscreated to handle the new incoming message. Ensurethat your process confirms the message when using theacknowledge mode.

● Dups Ok: the message is acknowledged automaticallywhen it is received. JMS provides this mode for lazyacknowledgment, but TIBCO BusinessWorks ContainerEdition acknowledges messages upon receipt.

● TIBCO EMS Explicit Client: (only available for TIBCOEnterprise Message Service) a message which is notacknowledged using the Confirm activity before theprocess instance ends, will be redelivered instead of allmessages in the session. The session is not blocked andone session handles all incoming messages for eachprocess instance.

● TIBCO EMS Explicit Client Dups OK: (only availablefor TIBCO Enterprise Message Service) a messagewhich is not acknowledged using the Confirm activitybefore the process instance ends, will be redeliveredinstead of all messages in the session. The session is notblocked and one session handles all the incomingmessages for each process instance. The messageshowever, are lazily acknowledged.

● TIBCO EMS No Acknowledge: messages deliveredusing this mode do not require acknowledgment.Therefore, messages in this mode are not redeliveredregardless of whether the delivery was successful.

Max Sessions No Specifies the maximum number of client sessions that canconnect with the messaging server. This property isenabled only when the Client ACK mode is used.


Description


109


Advanced


Field


Message Selector Yes A string to determine whether a message should bereceived. The syntax of the message selector is determinedby the JMS provider.

See the JMS provider documentation for more informationand syntax for a message selector string.


None Any application-specific message properties that is part ofthe message. This is specified by the JMS applicationproperties shared configuration object.

Polling Interval (sec) None Specifies the polling interval to check for new messages. Ifno value is specified for the property, the default pollinginterval is one second.

Set a value in this field to specify the polling interval (inseconds) for this activity. The value in this field overridesthe default polling interval.

Sequence Key None This field can contain an XPath expression that specifieswhich processes should run in sequence. Process instanceswith sequencing keys that evaluate to the same value areexecuted in the sequence the process instances werecreated.

Custom Job Id None This field can contain an XPath expression that specifies acustom ID for the process instance.

Output Editor

The Output Editor tab defines the schema to use for incoming messages whose Message Type is Map,Stream, or XML Text. Map messages are name or value pairs, and you can use the schema to define thestructure of the incoming message. The schema on the Output Editor tab becomes the structure usedfor the body of the message displayed on the Output tab. For XML Text message type, select an XSDelement. For Map and Stream message types, select an XSD type in the Output Editor tab.

Output


110









JMS Request ReplyJMS Request Reply is an asynchronous activity that is used to send a request to a JMS destination andwait for a response from the JMS client.

This activity uses temporary destinations to ensure that reply messages are received only by theprocess that sent the request. However, the user has the ability to use preexisting JMS destinations.

General


Field



Messaging Style Yes Select from one of the following available options:

● Generic● Queue● Topic


Destination Yes The name of the destination of the outgoing message.

111


Field




● Byte: a stream of bytes.● Map: a set of name or value pairs. The names are

strings, and the values are simple datatypes (JAVAprimitives), an array of bytes (use the Binary datatypewhen mapping this data), or a string. You can accesseach item sequentially or by its name.



Description

Privide a short description for the activity here.

Advanced


Field Description

Reply To Destination The destination to use for replies for this activity.

If more than one job has the same Reply To Destination, each jobmay not receive the correct reply. Ensure to specify an expressionin this field that assigns a different Reply To Destination to eachprocess instance.

Deliver Mode The delivery mode of the message. Can be one of the following:

● Persistent: signifies that the messages are stored and forwarded.● Non_Persistent: signifies that the messages are not stored and may be

lost due to transmission failure.● TIBCO_EMS_Reliable_Delivery: this mode is only available when

using TIBCO Enterprise Message Service. See the TIBCO EnterpriseMessage Service documentation for more information.

112


Field Description

JMS Expiration(sec) Corresponds to the JMSExpiration property that specifies how long themessage 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 inmilliseconds.

Priority The 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.


Any application-specific message properties that is part of the message. Thisis specified by the JMS application properties shared configuration object.

Input Editor and Output Editor

The Input Editor and Output Editor tabs define the schema to use for messages of type Map, Stream,or XML Text. Map messages are name or value pairs, and you can use the schema to define thestructure of the outgoing request and the incoming reply. The schema defined on the Input Editor tabbecomes the body of the message on the Input tab. The schema defined on the Output Editor tabbecomes the body of the message on the Output tab. For XML Text message type, select an XSDelement. For Map and Stream message types, select an XSD type in the Input Editor or Output Editor.

Input



Destination string The destination to which to send the request. This inputitem 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 ToDestination, then each job may not receive thecorrect reply. Ensure to specify an expressionin this field that assigns a different Reply ToDestination to each process instance.

JMSExpiration integer Specifies how long the message can remain active (inseconds). If set to 0, the message does not expire.

JMSPriority string The priority of the message. This item overrides thepriority set on the Advanced tab.

113




● Persistent: signifies that the messages are stored andforwarded.

● Non_Persistent: signifies that the messages are notstored and may be lost due to transmission failure.

● TIBCO_EMS_Reliable_Delivery: this mode is onlyavailable when using TIBCO Enterprise MessageService. See the TIBCO Enterprise Message Servicedocumentation for more information.

JMSCorrelationID string This ID is used to link a response message with its relatedrequest message. This is usually the message ID of arequest message when this field exists in a reply message.

JMSType string The type of the message. This item overrides the valuespecified on the Advanced tab.

JMSProperties complex The message properties. For details, refer to CommonJMS Properties and Headers.

Body depends on themessage type


requestTimeout integer This field specifies the amount of time (in milliseconds)that the activity waits before it times out.

Output









Fault

The Fault tab lists the possible exceptions thrown by this activity.

114


Fault Thrown When..

JMSInvalidInputExceptio

n

The input to the activity is not valid.

JMSMessageCreateExcepti

on

The JMS message could not be created.

JMSSessionCreateExcepti

on

The JMS session could not be created.

JMSSendException The JMS send operation failed.

JMSReceiveException The JMS receive operation failed.

ActivityTimedOutExcepti

on

The specified timeout has been attained and the activity has notcompleted its execution.

JMS Send MessageJMS Send Message is a synchronous activity that sends a message to the specified JMS destination.

General


Field



Messaging Style None Select from one of the following available options:

● Generic● Queue● Topic


Destination Yes The name of the destination of the outgoing message.

115


Field




● 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 whenmapping this data), or a string. Each item can beaccessed sequentially or by its name.



Description


Advanced


Field Description

Reply ToDestination

The destination to use for replies for this activity.

If more than one job has the same Reply To Destination, each jobmay not receive the correct reply. Ensure to specify an expressionin this field that assigns a different Reply To Destination to eachprocess instance.

Deliver Mode The delivery mode of the message. Can be one of the following:

● Persistent: signifies that the messages are stored and forwarded.● Non_Persistent: signifies that the messages are not stored and may be lost

due to transmission failure.● TIBCO_EMS_Reliable_Delivery: this mode is only available when using

TIBCO Enterprise Message Service. See the TIBCO Enterprise MessageService documentation for more information.

116


Field Description




Priority The priority of the message. You may set the priority to a value from 0-9. Thedefault value is 4.

Type The value to supply to the JMSType header property.


Any application-specific message property that is part of the message. This isspecified by the JMS application properties shared configuration object.


Overrides the default behavior of a transaction group. If this activity is in atransaction group, the JMS message is normally committed or rolled backwith the other participants in the transaction.

If this check box is selected, the JMS message does not participate in thetransaction.

Input Editor

The Input Editor tab defines the schema to use for outgoing messages whose message type is Map,Stream, or XML Text. Map messages are name or value pairs, and you can use the schema to define thestructure of the outgoing message. After defining the schema on the Input Editor tab, it becomes thestructure used for the body of the message displayed on the Input tab. For the XML Text message type,select an XSD element. For Map and Stream message types, select an XSD type in the Input Editor tab.

Input



Destination string The destination to which to send the message. This inputitem overrides the Destination field on the General tab.


If more than one job has the same Reply ToDestination, each job may not receive thecorrect reply. Ensure to specify an expressionin this field that assigns a different Reply ToDestination to each process instance.



117












Output



MessageID string The unique identifier of the message.

Fault


Fault Thrown When..


n



on



on



118


Reply to JMS MessageReply To JMS Message is a synchronous activity that sends a reply to a previously received JMS queueor topic message. The Reply For Event field in the General tab lists the activities that can receive theJMS message. The activity you select determines the response of the reply message.

General


Field Description

Name The name to be displayed as the label of the activity.

Reply For Event A drop-down list of activities that can receive JMS queue or topic messages.The activity you select determines the message this activity replies to. Thereply-to queue or topic name from the message in the selected activity is usedto send the reply message. The listed activity is WaitforJMSRequest.

Message Type The type of the message. This can be one of the following:


● 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 Binarydatatype when mapping this data), or a string. Each item can be accessedsequentially or by its name.

● Object: a Java object that can be serialized.● Object Ref: an object reference to a Java object.● Simple: a message with no body part.● Stream: a stream of Java primitives, strings, or arrays of bytes. Each value

must be read sequentially.● XML Test: the message is XML text.

Description


Advanced


119


Field Description

Deliver Mode The delivery mode of the message. This can be one of the following:

● Persistent: signifies that the messages are stored and forwarded.● Non_Persistent: signifies that the messages are not stored and may be lost

due to transmission failure.● TIBCO_EMS_Reliable_Delivery: this mode is only available when using

TIBCO Enterprise Message Service. See the TIBCO Enterprise MessageService documentation for more information.




Priority The priority of the message. You may set the priority to a value from 0-9. Thedefault value is 4.

JMSType The value to supply to the JMSType header property.


Any application-specific message property that is part of the message. This isspecified by the JMS application properties shared configuration object.

Input Editor

The Input Editor tab defines the schema to use for outgoing messages whose message type is Map,Stream, or XML Text. Map messages are name or value pairs, and you can use the schema to define thestructure of the outgoing message. After defining the schema on the Input Editor tab, it becomes thestructure used for the body of the message displayed on the Input tab. For XML Text message type,select an XSD element. For Map and Stream message type, select an XSD Type in the Input Editor tab.

Input



Destination string The destination to which to send the request. This inputitem overrides the Destination field on the General tab.


If more than one job has the same Reply ToDestination, each job may not receive thecorrect reply. Ensure to specify an expressionin this field that assigns a different Reply ToDestination to each process instance.


120













Fault


Fault Thrown When..


n



on



on



121


Parse Palette

The Parse palette provides shared configuration resources for parsing and rendering theformatted text. This is useful if you want to transform the formatted lines of text into a data schema ortransform 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 todetermine where each field begins and ends.

Parsing a Large Number of RecordsThe input for this activity is placed in a process variable and takes up memory as it is being processed.When reading a large number of records from a file, the process may consume significant machineresources. To avoid too much memory, you may want to read the input in parts, parsing andprocessing 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 recordsin parts. You may want to modify the procedure to include additional processing of the records, or youmay want to change the XPath expressions to suit your business process. If processing a large numberof records, do the following.

Procedure

1. Select and drop the Parse Data activity on the process editor.

2. On the General tab, specify the fields and select the Manually Specify Start Record check box.

3. Select the Parse Data activity and click the group icon on the tool bar to create a group containingthe 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. Forexample, 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 toprocess for each execution of the loop.

If you do not select the Manually Specify Start Record check box on the General tab of the ParseData activity, the loop processes the specified noOfRecords with each iteration, until there are nomore input records to parse.

You can optionally select the Manually Specify Start Record check box to specify the startRecordon the Input tab. If you do this, you must create an XPath expression to properly specify thestarting record to read with each iteration of the loop. For example, the count of records in the inputstarts at zero, so the startRecord input item could be set to the current value of the loop index minusone. For example, $i - 1.

MimeParserThis activity is responsible for parsing MTOM messages into a SOAP message that contains binaryattachments as an inline data of the SOAP message. The output can be either in a Text or a Binaryformat.

General


122


Field Description


Input Style The input message format. (Currently only MTOM is available.)

Output Style The output message format.

You can select either Text or Binary format for the output messages.

Description


Advanced

The Advanced tab has the following.

Field Description

Generate Strict ParsingErrors

Select this check box to generate strict parsing validation errors.

Input



MimeBinaryData Binary This is the incoming binary data.

Output



soapMessage Binary or String Depends on the type selected in the Output Style format.

StrictValidationErrors

Complex This displays only when the Generate Strict Parsing Errorscheck box is selected.

ErrorString String Shows strict parsing validation error logs.

Fault



XOPParseException The input has XOP related exceptions.

123



MimeParseException The input has MIME related exceptions.

InvalidXMLException The input has invalid xml related exception.

Parse Data

The Parse Data activity takes a text string or input from a file and processes it by converting itinto 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 usethe Read File activity to obtain text from a file. You can also use this activity to specify a text file to read.

You can use this activity in various scenarios. For example, a user has a file comprising multiple lineswith comma-separated values (as in data obtained from a spreadsheet) and this data has to be insertedinto a database table. In such a scenario, read and parse the file into a data schema with the Parse Dataactivity.

General




Data Format No The Data Format shared resource to use when parsing the textinput.

Input Type No Specify the type of input for this activity.

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 Typefield . Any valid Java encoding name can be used.

Skip BlankSpaces

No Select this check box to skip any empty records when parsingthe text input.

When this check box is not selected, parsing stops at the firstblank line encountered in the input.

124



ManuallySpecify StartRecord

No You can specify the record in the input where you want to startparsing.

This is useful if you have a large number of records and youwant 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 informationon how to read the input stream in parts.

StrictValidation

No Validates every input line for the specified number of fields forthe fixed format text.

For example, if the format states that there are three fields perline and this check box is selected, all lines in the input mustcontain three fields.

Continue OnError

No Continues parsing the next record in the input afterencountering an error, if any.

If an error occurs, the error information is separated from theoutput of the successfully parsed records and is provided in theoutput schema of the activity.

When this check box is not selected, the Parse Data activityquits parsing if an error is encountered while parsing therecords in the input.

Irrespective of whether this check box is selected or not, theParse Data activity quits when any data validation errorsoccur.

Input



text string The text string to parse.

This input item is available only when String is specified in theInput Type field of the General tab.

fileName string The location and name of the file to read. The file's content isused as the input text string for this activity.

This input item is available only when File is specified in theInput Type field of the General tab.

125



startRecord number The line number of the input stream to begin parsing. All linesbefore the specified line are ignored. This input item is availableonly if the Manual Specify Start Record check box on theGeneral tab is selected.

The input stream begins with the line number 1 (one). This isuseful for reading the input stream in parts to minimizememory usage.

See Parsing a Large Number of Records for more information.

noOfRecords number The number of records to read from the input stream. Specify -1if you want to read all records in the input stream.

This is useful for reading the input stream in parts to minimizememory usage.

See Parsing a Large Number of Records for more information.

SkipHeaderCharacters

integer The number of characters to skip when parsing. You can skipover any file headers or other unwanted information.

Output


Outputitem Datatype Description

Rows complex This output item contains the list of parsed lines from the input. This isuseful to determine the number of records parsed by this activity.

The schema specified by the Data Format resource is contained in thisoutput item.

schema complex The schema containing the data from the parsed input text. This outputitem contains zero or more parsed records.

ErrorRows This output item is available when you select Continue on Error, anderror(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 inputthat failed parsing.

done boolean true if no more records are available for parsing. false if there aremore records available.

This output item is useful to check whether there are no more recordsin the input stream when reading the input in parts to preservememory.

126


Fault


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. Theschema processed is based on a specified Data Format shared resource.

You can use this activity in various scenarios, for example, retrieving a result set from a database table.You may want to:

● Format this result set as a formatted text string (with line breaks between each row in the result set),and then write that text string out to a file.

● Use the Render Data activity to render the data schema as a formatted text string.● Use the Write File activity to write the string to a file.● 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




Data Format No The Data Format shared resource to use when rendering the textoutput.

Input



Rows complex The element containing the list of items to render.

root complex The complex element containing data schema (specified by the DataFormat shared resource) to render as a text string. This is a repeatingelement which renders more than one output record.

127


Output


OutputItem Datatype Description

text string The output text string as a result of rendering the specified dataschema. Line breaks separate records of the data schema.

Fault


Fault Thrown When..

BadDataFormatException The output format is not valid.

128


REST and JSON

The activities of REST and JSON Palette can be used to invoke RESTful web services and exposeprocesses as RESTful web services. The activities in this group can also be used to convert data betweenJSON format and XML format.

BW JSON UtilsBW JSON utils provide an easier way to create XML schema (XSD files) from JSON payload or SQLstatements.

Create XSD Schema from JSON payload

To create schema from the available JSON payload:

1. In the Process package, click Schemas > BW JSON Utils > Create Schema from JSON payload.

2. Specify a Root Element name, in the JSON Payload to XSD dialog and click OK.

3. Specify a file name in the JSON Payload to XSD dialog and click OK.

4. Add the JSON payload and click OK.

5. The JSON to XSD Completed message window displays the JSON String is converted toSchema. The Schema has been created in the Schemas folder with name <Name>.xsd

message.

6. Verify whether <Name>.xsd file is created under the Schemas folder.

Create Schema from an SQL String

To create SQL schema, do the following:

1. In the Process package, click Resources > JDBC Connection Resource and verify whether the JDBCconnection is able to connect to the database successfully.

2. Right-click the fully configured JDBC Connection Resource > BW JSON Utils > Create Schemafrom SQL.

3. In the SQL Query Builder, provide the query statement to fetch the required information and clickOK.

4. A "Schema has been created successfully under the Schemas folder with <Name>.xsd."message is displayed.

Invoke REST APIInvoke REST API asynchronous activity invokes RESTful web services and receives responses fromthe service provider.

For the Invoke REST API activity to work, an HTTP Client shared resource is required. In the HTTPClient shared resource, make sure Apache HttpComponents (Supported by HTTP and REST) isselected as the Implementation Library in the HTTP Client section.

General


129


FieldModuleProperty Description


HTTP Client Yes The HTTP client resource.

Resource Path No The resource of the REST service.

HTTP Method No The REST methods used for the requests.

Select from one of the following available methods:

● POST● GET● PUT● DELETE● Patch

Request Type No The value of the Content-Type header set while invoking theREST operation.

● JSON: the service provider returns the data in the JSONformat.

● XML: the service provider returns the data in the XMLformat.

● Custom: to override the Content-Type value in the Inputtab, select CUSTOM and provide the value in the Inputtab.

Response Type No The value of the Accept header set while invoking the RESTOperation.

● JSON: the service provider returns the data in the JSONformat.

● XML: the service provider returns the data in the XMLformat.

● Custom: to override the Accept header value in the Inputtab, select CUSTOM and provide the value in the Inputtab.

Description


Advanced


130


Field Description

Output HTTP ResponseHeaders

Request Entity Processing This field has two values:

● BUFFERED: the request entity is buffered in memory to determinethe content length that is sent as a Content-Length header in therequest.

● CHUNKED: the entity is sent as chunked encoded (no Content-Length is specified, entity is streamed). The Transfer-Encodingheader is set to Chunked.

The default value is Chunked.

Input



Message Body The body of the HTTP request message.

asciiContent string The ASCII content (ASCII content of the request like POST orPUT to the server) of the request to the HTTP server.

131



HttpHeaders string The header of the HTTP request. The header structure isdefined by the HTTP protocol. See the HTTP protocolspecification for more information about the fields andcontent of the header of an HTTP request.

● Accept: specifies the media types that are acceptable forresponse messages for the incoming request. For example,text/*,text/html. Media types are described in theHTTP specification.

● Accept-Charset: specifies the character sets that areacceptable for response messages for the incomingrequest. For example, iso-8859-5, unicode-1-1. Charactersets are described in the HTTP specification.

● Accept-Encoding: specifies the content-coding values thatare acceptable for response messages. For example,compress, gzip.

● Content-Type: the media type of the entity body sent tothe receiver. Media types are described in the HTTPspecification.

● Content-Length: indicates the size of the entity body sentto the receiver.

● Connection: the requestor can specify options desired forthis connection. For example, the option close specifiesthat the requestor would like the connection to be closedwhen the request is complete.

● Cookie: See the HTTP specification for more informationabout this field.

● Pragma: is used to include implementation-specificdirectives that might apply to the receiver. See the HTTPspecification for more information about using this field.

DynamicHeaders complex The dynamic header is an additional header parameter toadd runtime headers to the outgoing HTTP messages. TheDynamicHeaders consists of the following information:


Output

The Output tab has the following fields.


StatusCode The HTTP Response Code.

ReasonPhrase ReasonPhrase is intended for giving a short textual description ofStatusCode.

132



mesageBody The body of the response message. This is asciiContent.

Fault


Fault Thrown when...

HttpCommunicationExcep

tion

An HTTP exception occurred when trying to execute the specifiedmethod, or when trying to read the response.

HttpClientException The HTTP server replied with a message that has the 4XX status code.

HttpServerException The HTTP server replied with a message that has the 5XX status code.

Support for Path and Query Parameters

Invoke REST API activity supports both Path and Query parameters. For Path Parameters, encloseeach path parameter in { } brackets. For example, if the resource path is set as /books/{isbn}, aPathParameters element is added to the activity input.

Multiple path parameters can be defined in a similar way. The activity also supports static URL contentmixed with path parameters, for example, /books/{isbn}/events/{author}.

Query parameters are defined using the pattern /staticUrl?Param1&Param2.

A QueryParameters element is added to the Input tab of the activity with each of the parameter listed.For example, if the resource path is set as /books?isbn&author, a QueryParamters element is added tothe activity input.

Restrictions on XML SchemaThis topic lists the restrictions on XML Schema.

Schema Restrictions

● No wildcards or attribute wildcards. For example, any element and any attribute is not supported.

133


● No foreign-namespace elements or attributes (single namespace).● Complex types may not contain both an attribute and a child element with the same local name.● Complex types may not be of the pattern "simple type plus attributes".● Complex types may not contain mixed content.● Attributes that are not part of the default(empty) namespace, cannot be used for Complex Elements.● The 'choice' and 'sequence' compositors may not have maxOccurs > 1 (same as the restriction on

'all' in the schema specification).● Substitution groups are not allowed.● Element of simple type with an attribute is not allowed.● The elementFormDefault can only be qualified for schemas used by REST binding and JSON

activities.

Restrictions on JSON

● Arrays must have homogeneous content.● Arrays cannot directly contain arrays ( [ [ ... ], [ ... ] ] )

Not currently supported

● JSON nulls● Binary content in JSON as a special case

Parse JSONParse JSON activity takes the JSON data, processes it, and converts it into XML data.

General


Field

LiteralValue/ProcessProperty/ModuleProperty Description

Name None The name to display as the label for the activity in the process.

Schema Type None Specifies the mode for the output data. The following are thesupported schema types:

● Generic: converts a JSON string to an XML string● XSD: converts a JSON string to an XML document defined

using a schema specified in the Output Editor.

The default value in this field is the XSD schema type.

134


Field


Badgerfish None Specifies the following conversion rules:

● Select this check box for converting JSON data to XML datawith the mapping of XML namespace, XML attribute,CDATA, and so on.

● Do not select this check box if you want normal conversionrules for mapping data from JSON to XML.

Description


Output Editor

From the Output Editor you can define or reference an XML schema for the activity output. You canuse the BW JSON Utils tool to generate an XML schema file with a specified JSON file. Refer to BWJSON Utils for more information.

Input

The Input tab has the following fields.

Field Description

json string The input JSON data for translation.

Output

The output for the Parse JSON activity varies depending on the data schema you specified in theSchema Type field on the General tab.

Fault



JSONParserException An exception occurred when parsing the JSON data.

Render JSONRender JSON activity takes XML data and renders it as a JSON string.

General


135


Field



Schema Type None Specifies a schema type for the output data. The following are thesupported schema types:

● Generic: converts an XML string to a JSON string● XSD: converts an XML string to a JSON document defined

using a schema specified in the Output Editor.

The default value in this field is the XSD schema type.

Badgerfish None Specifies the following conversion rules:

● Select this check box for converting JSON data to XML datawith the mapping of XML namespace, XML attribute,CDATA, and so on.

● Do not select this check box if you want normal conversionrules for mapping data from JSON to XML.

Description


Input Editor

From the Input Editor tab, you can define or reference an XML schema for the activity input. You canalso use the BW JSON Utils tool to generate an XML schema file with a specified JSON file. See BWJSON Utils for more information.

Input

The input data for the Render JSON activity is in the XML format. The schema type of the XML datavaries 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

jsonString The translated data in JSON string format.

Fault


136



JSONRendererException An exception occurred when rendering the data.

137


XML Activities Palette

The XML Activities palette provides activities for parsing XML strings into schemas and renderingschemas into XML strings.

Parse XMLParse XML is a synchronous activity that takes a binary XML file or an XML string and converts it intoan XML schema tree based on the XSD specified.

Parsing Date and Datetime Strings

In XML documents parsed by the Parse XML activity, datetime values are read in accordance with theISO-8601 standard, as described in the XML Schema specification. For example, the value:

2002-02-10T14:55:31.112-08:00

is 55 minutes, 31 seconds, and 112 milliseconds after 2.00 p.m. on February 10th, 2002 in a time zonethat 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 isperforming the parsing. This can lead to complications if you are processing XML from a different timezone, so you are encouraged to always use a time zone.

General


Field Description


Input Style Can be binary, text, or dynamic.

In binary mode, the binary content is read. The encoding used for parsing thecontent is either the value specified in the forceEncoding input item, the encodingspecified in the XML header or the xmlBinary input item, or UTF-8 (the defaultencoding, if no encoding is specified).

In text mode, (the default and preferred choice) an XML string is passed as aninput item.

In dynamic mode, a choice is offered for input. You can either supply binary ortext input. You can use a choice statement and set substitution in the mapping tosupply the correct type of input at run time.

Description


Output Editor

Use the Output Editor tab to define a schema for the XML output.

Input


138



xmlString string The XML string to parse.

This input element is available when the Input Style field in theGeneral tab is set to text.

xmlBinary complex Available when you set the Input Style field in the General tab tobinary.

This input item contains a required bytes item for which you specifythe input XML bytes.

This input item also contains an optional forceEncoding item. Thisspecifies the encoding to use when parsing the XML. If this element isnot specified, the encoding specified in the XML header of the byteelement is used to parse the XML. If the encoding value is not specifiedin 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 thecorrect input type at run time.

Output


Output ItemDatatype Description

XML Schema complex The parsed XML schema is the output of this activity. The contents ofthe schema are determined by the schema defined in the OutputEditor tab.

Fault



XMLParseException An exception occurred when parsing the data.

UnsupportedEncodingExcept

ion

An unsupported encoding was specified in the forceEncodinginput item.

MissingByteCountException An exception occurred while parsing the data with an invalid ormissing byte count.

ValidationException The file specifies a version of XML that the parser is not preparedto handle.

139


Render XMLRender XML is a synchronous activity that takes an instance of an XML schema element and renders itas 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 ofbytes containing XML or an XML string. The schema is processed based on the XSD file specified.

Rendering Date and Datetime Strings

UTC time is used when datetime strings are generated. For example, the time 55 minutes, 31 seconds,and 112 milliseconds after 2.00 p.m.on February 10th, 2002 would be represented by the Render XMLactivity as 2002-02-10T14:55:31.112Z

General


Field



Output Style No Specifies whether the output should be text or binary data.

Format UsingDefaultNamespacePrefix

No Prepends the namespace with the default namespace prefix.

Encoding Yes This field is available only when the Output Style field is set totext. This field specifies the encoding value to place into the XMLheader of the rendered XML data.

You can specify any valid XML encoding value listed in IANA-Charsets.

Description


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 dialogdisplays. Using this dialog locate and select the input schema by location in the project or bynamespace. Use the By Location tab if your input schema is located in the project directory. Use the ByNamespace 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 elementsin the list.

140


Input Editor

From the Input Editor tab you can define a schema for the incoming XML data you want to render.

Input


Input Item Type Description

byteEncoding

string This is only available when you set the Output Style field in theGeneral tab to binary.

This specified the encoding value to place into the XML header in therendered XML output. This is also the encoding used to encode thebinary data. If this item is not specified, the default encoding of thejava virtual machine used by the process engine is used to encode thebinary data. This value may not be a valid XML encoding.

You can specify any valid XML encoding value listed in IANA-Charset. See http://www.iana.org/assignments/character-sets for acomplete list. The encoding names are case sensitive.

XMLSchema

string The XML schema to render. The contents of the schema are determinedby the schema specified in the Input Editor tab.

Output


OutputItem Type Description

xmlString string Available when text is selected in the Output Style field in the Generaltab. This item contains a stream of bytes representing the renderedXML.

xmlBytes bytes Available when binary is selected in the Output Style field in theGeneral tab. This item contains a stream of bytes representing therendered XML.

Fault


Fault Thrown When..

XMLRenderException An exception occurred when rendering the data.

UnsupportedEncodingExce

ption

An unsupported encoding was specified in the byteEncoding inputitem.

MissingByteCountExcepti

on

An exception occurred while rendering the data with an invalid ormissing byte count.

141


http://www.iana.org/assignments/character-sets

Transform XMLTransform XML is a synchronous activity that invokes the built-in XSLT processor to apply an XSLTstylesheet to an XML source document and produce a result document.

Normally, transformation of data occurs by mapping process variables to an activity's input andapplying XPath expression to perform any transformation. If you have an XSLT file that you are usingfor transformation, or if an outside source supplies an XSLT file, this activity helps you to use the XSLTfile instead of manually creating the mappings.

For more information about creating and editing XSLT files, see the XSLT specifications at http://www.w3.org/TR/xslt.

General


Field Description


Stylesheet The XSLT file shared configuration resource to use when transforming the XML.You can also specify an XSLT stylesheet in the stylesheet input element, if desired.Stylesheets specified in the activity input override the stylesheet specified in thisfield.

Input andOutput Style

Specifies whether the input and output is binary data, text, or an XML tree.

Description


Input



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 totext, this element is named xmlString. If the input/output style isset to tree, this element is named xmlTree.

styleSheet string This optional element contains the XSLT stylesheet to use totransform the XML input. This stylesheet overrides the stylesheetspecified in the styleSheet field in the General tab.

parameter complex This repeating element contains the input parameters for thestylesheet.

Each input parameter is specified as name/value pairs. The nameis a string that corresponds to the name of the parameter specifiedin the XSLT stylesheet parameter list.

name string The name of the stylesheet input parameters.

142


http://www.w3.org/TR/xslt

http://www.w3.org/TR/xslt


value string The value to supply for the specified stylesheet input parameters.

isXMLDocument boolean Specifies whether the parameter is an XML document.

Output


OutputItem Datatype Description

xmlString text orbinary orcomplex

A binary or text value or an XML tree containing the output schemaspecified by the XSLT file.

The element is named xmlString and is of type text when you selecttext for the input/output style on the General tab. The element isnamed xmlOutput and is of type binary when binary is selected. Theelement is named treeOutput and is a complex type when you selecttree.

Fault


Fault Thrown When..

XMLTransformException An exception occurred when transforming the data.

UnsupportedEncodingExce

ption

Data was supplied that is encoded in an unsupported encoding.

MissingByteCountExcepti

on

An exception occurred while transforming the data with an invalidor missing byte count.

143


Shared Resources

Shared resources are used to define a resource that contains configuration data that can be referencedfrom multiple processes.

You can define a shared resource and then reference it from multiple activities in the same or differentprocess. For example, you can define a JDBC Connection resource and then use it in any of the JDBCactivities in your process to connect to the database.

Shared resources such as JDBC Connection, JMS Connection, HTTP Connection, and so on areavailable at design-time. At runtime, the referencing activities and event sources have full access totheir instances and configuration. Shared resources can be grouped in packages, similar to the wayprocess packages and Java packages are presented in the file system.

When defined in an application module, shared resources are not visible outside the applicationmodule. However, when defined in a shared module, they are visible outside the shared module.

Data FormatThe Data Format shared resource contains the specification for parsing or rendering a text string usingthe 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 lineseparator, the fill character, and field offsets for fixed-width for fixed-width columns.

You must also specify the data schema to use for parsing or rendering the text. When parsing text, eachcolumn of an input line is transformed into the corresponding item in the specified data schema. Thefirst column of the text line is turned into the first item in the data schema, the second column istransformed into the second item, and so on. Each line is treated as a record, and multiple lines result ina repeating data schema containing the lines of the input text string. The following figure illustrateshow 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. Thefirst item of the data schema is transformed into the first column of the text line in the output textstring. Rendering a data schema into a text string is exactly the opposite process of parsing a text stringinto a data schema.

Data Format Editor

This editor contains General, Data Format Configuration, Data Format Editor, and Field Offsetssections.

144


General

The General section has the following fields.

Field Description

Name The name to be displayed as the label for the resource.

Description A short description of the data format.

Data Format Configuration

You can define the structure of the data file using the Data Format Configuration.

Field Description

Format Type The Type of formatting for the text. The text can be either Delimiter separated orFixed format.

When you select the Delimiter separated option, the text in each column isseparated by a delimiter character, specified in the Col Separator field. Each line isseparated by the character specified in the Line Separator field.

When Fixed format option is selected, the text in each column occupies a fixedposition on the line. For fixed format text, you must specify the fill character, theline length, and the column offsets.

Col Separator This field specifies one or more separator characters between columns when"Delimiter separated" is specified in the Format Type field.

When rendering text, each element in the input data schema is separated by thecolumn separator in the output text string. If more than one character is specified inthis field, the Render Data activity places the entire string specified in this fieldbetween each column. For example, if ":;" is specified in this field, then ":;" displaysbetween each column in the rendered string.

When parsing text, each column becomes an element in the output data schema. Ifmore than one character is specified in this field, the Parse Data activity uses therules specified in the Col Separator Parse Rule field to determine how to parse thedata.

Col SeparatorParse Rule

Specifies the rule to use for multiple column separator characters when parsingdata. 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 stringthat acts as a separator. For example, if the specified Col Separator is ":;" thenApple:;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 thespecified Col Separator is ":;" Apple;Orange:Pear is treated as three columns.

145


Field Description

LineSeparator

Specifies the character(s) that determine the end of each line. Available LineSeparator 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 characterin the output text string.

The last line in your input file must be terminated by the specified line separator.

Fill Character When processing fixed format columns, this is the type of character that is used tofill the empty space in a column and between columns. This field is only availablewhen you select the Fixed format option in the Format Type field. The fill characteris used only by the Render Data activity.

You can select any one from the following available options:

● Space: fills with a space● Dash: fills with a dash● Others: specify your own custom fill character in the Fill With field

For example, you have a column that holds an integer and the specified width is 10.One row has the value "588" for that column. Because the width of 588 is three andthe column width is 10, the remaining 7 characters are filled with the specified fillcharacter.

Data Format Editor

You can define a custom schema for the text in the Data Format Editor. You can define your owndatatype here. After defining the data type, the data specified here is used to parse a text string into thespecified schema or render the specified schema as a text string. The Header element contains thefollowing:

● @attribute● (any element)● primitive● (any element)

Field Offsets

When processing fixed format text, you must specify the line length and the column offsets. Thisenables the Parse Data or Render Data activity to determine where columns and lines begin and end.You can specify the format of fixed-width text using the Field Offsets.

The line length is the total length of input lines, including the line separator characters. Include theappropriate number of characters for the selected line separator in the Data Format Configuration tothe total length of each line.

The column offset is the starting and ending character position on each line for the column. Each linestarts at 0 (zero). For each column of the line, you must specify the name of the data item associated

146


with this column(this is the same name you specified for the corresponding elements in the dataschema), the starting offset for the column, and the ending offset for the column.

Each column offset can begin where the last column offset ended. Many fixed format data files are usedby databases or are generated by automated processes. These files have rigid file record formats andmay not have additional padding space between the columns. When you define each column offset tobegin where the last column offset ends, you can read the data more quickly. This is because you canread sequentially the bytes of the input reords.

Consider the following text file. The first two lines of the file indicate offset numbers (each 0 indicatesanother 10 characters), and the fill character between columns is spaces:0 12 30 450123456789012345678901234567890123456789012345678901234567857643 Smith Chris Account57644 Jones Pat Marketing57645 Walker Terry Development

Delimeter Separated Fields

When processing delimiter-separated text, each field in the input line is separated by the delimiterspecified by the Column Separator field. Leading and trailing spaces are stripped from each field andthe specified Line Separator determines when a new record starts.

In some situations, you may not be able to choose a column separator character that does not display inany column data. For example, if you choose a comma as the column separator, there may be commasin some of the column values. To process data that contains column separator characters in a column,you can surround the column with double quotes (" "). You can also use double quote to includeleading and trailing spaces as well as line breaks in a field. If you want to display a double quote in afield, escape the double quote by using two consecutive double quotes. That is, use "" to represent adouble quote in a field.

The following data illustrates input lines with each field separated by commas. some fields, however,contain commas, leading or trailing spaces, double quotes, and line breaks.

57643, Smith, "Chris", Accounting , "State: Be prepared!"

57644, Jones, "Pat ", Marketing , "Statement: To paraphrase JFK, ""Ask not what your

company can do for you, ask what you can do for your company.""

57645, Walker, "Terry", Development, "Statement: May goal si to be CEO someday."

Notice that Pat Jones' statement spans two lines and contains double quotes as well as a comma. Theentire field is surrounded by double quotes, so it is still treated as part of the same record.

HTTP ClientThe HTTP Client resource template represents an outgoing HTTP connection.

General


Field Description

Package The name of the package

Name The name to be displayed as the label for the resource

Description A short description of the shared resource

147


HTTP Client


Field


ImplementationLibrary

No Specifies the implementation library to be used:

● Apache Commons(Supported by HTTP and SOAP): mustbe used for SOAP binding.

● Apache HttpComponents(Supported by HTTP and REST):must be used for REST binding, when the Invoke REST APIactivity needs to be used.

The default is Apache Commons(Supported by HTTP andSOAP).

The HTTP palette activities work with both ApacheCommons and Apache HttpComponents.

DisableConnectionPooling

Yes Indicates whether to use the single or multi-threadedconnection manager.

The default value is False.

Maximum TotalConnections

Yes Specifies the maximum number of concurrent, active HTTPconnections allowed by the resource instance to be opened withthe target service. This property is enabled only if connectionpooling is enabled (the Disable Connection Pooling parameter isunchecked).

The default value is 200. For applications that create many long-lived connections, increase the value of this parameter.

Idle ConnectionTimeout(ms)

Yes Keep-alive time (in milliseconds) for idle HTTP connection inthe Persistent Connection Pool.

Maximum TotalConnections PerHost/Route

Yes Specifies the maximum number of concurrent, active HTTPconnections allowed by the resource instance to the same hostor route. This property is enabled only if connection pooling isenabled (the Disable Connection Pooling parameter isunchecked).

This number cannot be greater than Maximum TotalConnections. Every connection created here alsocounts into Maximum Total Connections.


148


Field


Stale Check Yes Selecting this check box determines whether the staleconnection check is to be used. Disabling the stale connectioncheck can result in slight performance improvement at the riskof getting an I/O error, when executing a request over aconnection that has been closed at the server side.

Default Host Yes The name of the host that accepts the incoming requests.

For machines that have only one network card, the defaultvalue localhost specifies the current machine. For machineswith more than one network card, this field specifies the hostname of the card used to accept the incoming HTTP requests.

The default is localhost.

Default Port Yes The port number on which to invoke outgoing HTTP requests.

The default is 80.

Thread Pool No Specifies a queue of threads available to run a queue of tasks.

Thread pools are used to improve performance when executinglarge numbers of asynchronous tasks by reducing per taskinvocation overhead, provide a means of bounding, andmanaging the resources consumed when executing a collectionof tasks.

You can optionally create this client thread pool to routemessages to the target service. The thread pool resource can becreated by either selecting a thread pool resource template orcreating a new one. See Thread Pool for more information.

Advanced


Field


Socket Timeout Yes Specifies the number of milliseconds to wait for data before theconnection is severed.

The value 0 is interpreted as an infinite timeout and is usedwhen no socket timeout is set in the HTTP method parameters.

ConnectionTimeout

Yes Specifies the number of miliseconds to wait while a connectionis being established.

The value 0 is interpreted as no timeout.

149


Field


Accept Redirect Yes Indicates whether the HTTP method should automaticallyfollow HTTP redirects.

This option is used when client connection receives the redirectresponses from server like Moved Permanently, MovedTemporarily, Temporary Redirect and so on.


Retry Count Yes Specifies the maximum number of retry attempts for connectingto the server if an exception occurs.


Use SingleCookie Header

Yes Select this check box if multiple name/value pairs must be sentin a single non-repeating Cookie header element for outgoingHTTP requests.


Use Non-PreemptiveAuthentication

Yes Select this check box if you want to use non-preemptiveauthentication.

HTTP Proxy No Specifies the HTTP proxy server to be used to gain accessoutside of a firewall. The Proxy Configuration sharedconfiguration resource specifies the configuration of the proxyserver. See Proxy Configuration for more information.

Security

Security can include any combination of the following characteristics:

Field Description

Authentication To be included when the messages must be authenticated. Authenticationcan be performed with user names and passwords.

Identity Provider : Provides username and password credentialsencapsulated in an identity provider resource. Selecting this check boxactivates the Identity Provider field.

You can enforce authentication on requests by selecting theAuthentication check box, or by associating the Basic CredentialMapping policy with REST or HTTP activities. If you choose touse the policy, ensure the Authentication check box on the HTTPClient resource is not selected.

Confidentiality To be included when encrypting or decrypting messages.

Selecting this check box displays the SSL Client Configuration field. Fordetails, refer to SSL Client Configuration.

150


HTTP ConnectorHTTP Connector resource describes the characteristics of the connection used to receive incomingHTTP requests. This resource is used when the process requires an HTTP request on a specific portwhere the HTTP server is running. For example, the process starter HTTP Receiver and the signal-inWait for HTTP Request activity receiving HTTP requests.

There can be only one process with an HTTP Receiver or Wait for HTTP Request activity that uses thesame HTTP Connection resource. With this restriction the HTTP server listening for the incomingrequests dispatches the request to the correct process.

General



Package No The name to be displayed as the label of the resource package.


Description No A short description of the activity.

Basic Configuration

The Basic Configuration section has the following fields.


Host Yes Specifies the name of the host that accepts the incoming requests.For machines that have only one network card, the default valuelocalhost specifies the current machine. For machines that havemore than one network card, this field specifies the host name ofthe card that will be used to accept incoming HTTP requests.

If there is more than one network card on the machine, and youspecify localhost in this field, all network cards on the machinelisten for incoming HTTP requests on the specified port.

When using local host for the system property, use the full nameof your machine as the host in the client.

You can start more than one HTTP server on a singleport by using Context and Path fields on HTTPReceiver and Wait for HTTP activities. Ensure thatyou use a different port, if different Context or Pathare not specified.

Port Yes Specifies the port number on which to listen for incoming HTTPrequests.

151



Accept QueueSize

Yes Specifies the number of connection requests to be queued beforethe operating system starts sending rejections. The default valuesare: -1 and 0.

These default values signify that the queue size is 50 or OS-specific.

AcceptorThreads

Yes Specifies the number of acceptor threads. Acceptor threads areHTTP socket threads for an HTTP connector resource that acceptthe incoming HTTP requests.


Advanced Configuration

The Advanced Configuration section has the following fields.


Header Buffer Size(B)

Yes Specify to set the size of the buffer for request headers. An idleconnection at most has one buffer of this size allocated. Thedefault is 4K.

Use Non-BlockingIO Sockets

Yes Select this check box to use non-blocking threading model forNIO buffers.

Use this connector when there are many connections with idleperiods. The default is true.

Request BufferSize (B)

Yes Specify to set the size of the content buffer for receivingrequests. These buffers are used only for active connectionsthat have requests with bodies that do not fit within the headerbuffer. The default is 8K.

Use Direct Buffers Yes Specify to determine whether direct byte buffers are used ornot. The default is True.

Response BufferSize (B)

Yes Specify to set the size of the content buffer for sendingresponses. These buffers are used only for active connectionsthat are sending responses with bodies that will not fit withinthe header buffer. The default is 24K.

URI Encoding Yes Specifies the character encoding used to decode the URI bytes.

If you do not set any value for uriEncoding, the default UTF-8is used.

152



Max Idle Time(ms)

Yes Specify to set the maximum idle time for a connection. TheMax Idle Time is applied in the following cases:

● When waiting for a new request to be received on aconnection; when reading the headers and content of arequest

● When writing the headers and content of a response

Jetty interprets this value as the maximum time between theprogress made on the connection. The timeout is reset ifimplemented by jetty if a single byte is read or written.

Enable DNSLookups

Yes Selecting this check box enables a domain name system (DNS)lookup for HTTP clients so that the IP address is resolved to aDNS name. This can adversely affect the throughput. Thischeck box is not selected as default. Select this check box onlywhen required.

The default is False.

Low Resource MaxIdle Time (ms)

Yes Specifies to set the period in ms for the connection to be idle.

This results in the server rapidly closing idle connections togracefully handle high load situations.

Compression Yes Specifies if the output of the HTTP Connection is compressedusing the HTTP/1.1 GZIP compression.

The acceptable values for this field are: True or False

The default is False.

Linger Time (ms) Yes Specifes to set the LINGER_TIME on the connection socket.This setting affects only the close connection socket.

CompressibleMime Types

Yes Specifies the list of MIME types for which HTTP compressionmay be used. The default value for this comma separated lististext/html, text/xml, text/plain.

Max Post Size Yes Specifies the maximum size in bytes of the POST that thecontainer FORM URL parameter parsing can handle.

By default, the value of this field is set to 2M or 2097152bytes. Setting the value less than or equal to zero disables thelimit for maxPostSize.

Reverse ProxyHost

Yes Specifies the name of the reverse proxy host that accepts theincoming requests.

153



Max Save Post Size Yes Specifies the maximum size in bytes of the POST that thecontainer can save/buffer during FORM or CLIENT-CERTauthentication.

● FORM authentication: the request message is saved whilethe user is redirected to the login page. It is retained untilthe user authentication succeeds or the session associatedwith the authentication request expires.

● CLIENT-CERT authentication: the request message isbuffered for the entire duration of the SSL handshake. Afterprocessing the request, the buffer is emptied.

However, in both the cases the buffering happens before theuser authentication. By default, the value of this field is set to4K or 4096 bytes. Setting the value to -1 disables the limit forthis field.

Reverse Proxy Port Yes The reverse proxy port number on which to listen for theincoming HTTP requests.

Minimum QTPThreads

Yes The Queued Thread Pool (QTP) uses the default job queueconfiguration to The QTP threads accept the requests from theacceptor threads.

This field specifies the minimum number of QTP threadsavailable for the incoming HTTP requests. The HTTP servercreates the number of threads specified by this parameterwhen it starts up. The default value is 10.

Maximum QTPThreads

YesThis field specifies the maximum number of threads availablefor the incoming HTTP requests. The HTTP server does notcreate more than the number of threads specified by thisparameter. The default value is 75.

Security

Security can include any combination of the following characteristics:

Field Description

Confidentiality To be included when encrypting or decrypting the messages.

Selecting this check box displays the SSL Server Configuration field. Usethis field to specify the SSL parameters for the HTTP Connector sharedresource.

154


Identity ProviderIdentity Provider shared resource provides user name and password credentials.

General


Field Description

Name The name of a Identity Provider shared resource.

Description A short description of the shared resource.

Identity Provider


Field Description

Username Enter a user name.

Password Enter a password.

JDBC ConnectionJDBC Connection resource describes a JDBC connection. JDBC connections are used when specifyingactivities from the JDBC palette.

General


Field Description

Name The name to be displayed as the label for the shared resource


JDBC Connection


Field


Connection Type None Specifies the kind of JDBC connection you want to create.

MaximumConnections

Yes The maximum number of database connections to allocate.The default maximum is 10. The minimum value that can bespecified is 1.

155


Field


Login Credentials Yes The user name used to connect to the database.

The password used to connect to the database.

JDBC Drivers


Field


Database Driver Yes The name of the JDBC driver class. You can select from a listof supported drivers.

If you select a supported driver, the Database URL field ispopulated with a template for the URL of the driver.

Database URL Yes The URL to use to connect to the database. A template of theURL is supplied for the selected JDBC driver. You mustsupply the portions of the URL that are in angle brackets (<>).

Login Timeout Yes The length of time (in milliseconds) to wait for a successfuldatabase connection.

Only JDBC drivers that support connection timeouts can usethis field. If the JDBC driver does not support connectiontimeouts, the value of this field is ignored. Most JDBC driverssupport connection timeouts.

Test Connection

Click the Test Connection button to test whether the specified configuration fields result in a validconnection to a database.

Using Third Party JDBC Drivers

TIBCO BusinessWorks ™ currently packages drivers for the following databases:

● PostgreSQL● Microsoft SQL Sever

In addition, the JDBC palette also supports the Oracle, MySQL, and DB2 databases.

Adding Drivers for Runtime

If you want to use other databases, than the ones mentioned in Using Third Party JDBC Drivers, youmust add them for run time separately. This is a one time process for every installation of TIBCOBusinessWorks ™ .

156


To add the drivers at run time for Oracle, MySQL, or DB2, run the bwinstall command from<BWCE_Home>/1.x/bin. Ensure that you run bwinstall with no arguments to access the help andinstructions to add the driver to the development run time.

The script creates driver bundles and adds it to that specific TIBCO BusinessWorks ™ environment.

To use another location for the drivers, a preference is provided in TIBCO Business Studio ™ which canbe updated for the JDBC palette to use drivers at design time. To change the Directory Preference, goto Windows > Preferences > BusinessWorks > Palettes > JDBC.

If you have changed the preferences and want to use other databases with the JDBC palette at designtime, place the drivers at the <BWCE_Home>/1.x/config/design/thirdparty location.

Uninstalling Drivers for Runtime

To uninstall the drivers at run time for Oracle, MySQL, or DB2, run the bwuninstall command from<BWCE_Home>/1.x/bin. Ensure that you run bwuninstall with no arguments to access the help andinstructions to uninstall the driver at run time.

JMS ConnectionJMS Connection resource describes a JMS connection. This resource is used to specify activities on theJMS palette.

General


Field Description



Basic Configuration


157


Field Description

ConnectionFactory Type

A connection factory is the object used by a client to create a connection to aprovider. Select from one of the following available options:

● JNDI: select to look up the connection factory object. Selecting this optiondisplays the Queue Connection Factory and Topic Connection Factoryfields, when the Messaging Style selected is Queue/Topic.

● Direct: select if you want to connect to the JMS server using a URL.Selecting this option displays the Provider URL field and the Supports XATransactions check box. Ensure to select the Queue/Topic in the MessageStyle.

Messaging Style The available messaging style options are:

● Generic:● Queue/Topic:

You can combine these styles in a single application or the application can useany one of these messaging styles.

Queue ConnectionFactory

This field is available when you select JNDI in the Connection Factory Typefield and Queue/Topic in the Message Style field.

The QueueConnectionFactory object stored in JNDI is used to create a queueconnection with a JMS application.

See the JNDI provider documentation for more information about creatingand storing QueueConnectionFactory objects.

Topic ConnectionFactory

This field is available only when you select JNDI in the Connection FactoryType field and Queue/Topic in the Message Style field.

The TopicConnectionFactory object stored in JNDI. This object is used tocreate a topic connection with a JMS application.

See the JNDI provider documentation for more information about creatingand storing TopicConnectionFactory objects.

ConnectionFactory JNDIName

This field is available only when you select the JNDI in the ConnectionFactory Type field and Generic in the Message Style field.

The GenericConnectionFactory object stored in JNDI is to create connectionwith JMS server.

JNDIConfiguration

A JNDI Configuration shared configuration object that specifies the JNDIconnection information. For details refer to, JNDI Configuration.

The New button is used to create a New JNDI Configuration SharedResource using the preferences set by the user.

Provider URL This field is available only when you select Direct in the Connection FactoryType field.

The URL to the JNDI service provider, for example,tcp://<host>:<port>.

158


Test Connection

Click the Test Connection button to test the connection specified in the configuration of this resource.

Security

Security section has the following field.

Field Description

Login Credentials The login credentials to log on to the JMS server. Click the Username+Password radio button, if you want to use this option for a secure login. Thisdisplays the Username and Password fields.

Advance Configuration


Field Description

Auto-generateClient-ID

Select this check box if you want to automatically generate the client ID if noclient ID is specified or if the specified ID is already in use.

When this check box is selected, a value cannot be specified for the clientID.

When an automatically generated client ID is required, the following format isused for the client ID:

BW-<projectName>-<topic or queue>-<engineName>-<timestamp>

Do not select this check box if you do not want to use the value specified in theClient ID field. If no value is specified in the Client ID field, no client ID isset. If the value specified in the Client ID field is already in use, it throws anexception.

Selecting the Auto-generate Client-ID check box generates a newClient ID every time a connection is made to the JMS Server. If youare using Durable Subscribers, manually set the client ID for theJMS Connection.

Client ID The client ID for the connection. The JMS providers have a provider-specificformat for client IDs.

See the JMS provider’s documentation for more information about client IDs.Each connection must use a unique client ID. If you do not specify a value inthis field, TIBCO ActiveMatrix BusinessWorks ensures the uniqueness of theclient ID for each connection.

SSL

Select the Confidentiality check box to configure the SSL connection parameters.

JMS Preference Page

A preference page is provided for the JMS Connection in TIBCO Business Studio. To change theDirectory Preference in TIBCO Business Studio, navigate to Windows > Preferences > BusinessWorks> Palettes > JMS

159


Field Description

One click JNDI Resourcename

The name of JNDI Connection shared resource which is auto createdwhen you click the New button. This is used only if the shared resourceuses JNDI and not Direct.

Default JNDI NamingURL

The default URL to be added in the JNDI Connection shared resourcewhen a new resource is created.

Generic ConnectionFactory Name

The value to be added in the Generic Connection Factory field when anew JMS Connection Shared Resource is created.

Queue ConnectionFactory Name

The value to be added in the Queue Connection Factory field when anew JMS Connection shared resource is created.

Topic ConnectionFactory Name

The value to be added in the Topic Connection Factory field when anew JMS Connection shared resource is created.

JNDI ConfigurationJNDI Configuration shared resource provides a way to configure the JNDI configuration that can beshared with other activities. This resource can be specified in any resource that permits JNDIconnections. For example, JDBC Connection and JMS Connection can use JNDI connections.

General


Field Description

Name The name to be displayed as the label for the shared resource


JNDI Connection


160


Field


JNDI Provider No The name of the JNDI connection.

Initial ContextFactory

Yes The initial context factory class for accessing JNDI.(com.tibco.tibjms.naming.TibjmsInitialContextFactory).

Naming ProvidingURL

Yes The name of the JNDI provider URL. For example,tibjmsnaming://localhost:7222.

Security

This section has the following field.

Field Description

Login Credentials The login details to access the JNDI connection. Select any one of thefollowing options.

● None: Selecting this radio button will not display the Username+Password option.

● Username+Password: Valid username and password to access the JNDIconnection.

Java Global InstanceYou can use Java Global Instance shared configuration resource to specify a Java object to be sharedacross all process instances in a Java Virtual Machine (JVM).

When the engine is started, an instance of the specified Java class is constructed. When the processengine is shut down, if specified, a cleanup method is invoked on the object. The object is releasedbefore the engine shuts down. Any Java Invoke activity can be configured to access the shared Javaglobal instance when the process engine runs. Any Java Invoke activity can access the shared javaglobal 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 onlyone process instance can access the object at a time. You can accomplish this by either declaring themethods of the configured class as synchronous or by using a critical section group.

General

The General field has the following fields.

Field Description


Description A short description of the resource

161


Java Global Instance

The section has the following fields.

Field Description

Class Use the Browse a Class button to locate the class you want to use.

Method Select a constructor from the drop-down list of constructors available for thisclass. This is used to construct the class when the engine is started.

This field displays only the default constructor with no parameters orconstructors that have only parameters of Java primitive types. You cannotcreate an object using a constructor that requires an object, array, or non-primitive type for a parameter.

Parameter Input The input parameters for the constructor selected in the Method field. Eachinput parameter has the following three fields:

● Parameter: the name of the parameter● Type: the datatype of the parameter● Value: specify a value for the parameter in this field

When string is the datatype for the parameter, do not use quotesaround the string when specifying the value.

Advanced Configuration


Field Description

Invoke CleanupMethod

Selecting this check box signifies that you want to invoke a method on theobject before the object is released from memory when the engineterminates. You can perform cleanup activities, such as closing connections,releasing resources, and so on.

Selecting this check box enables the Cleanup Method field.

Cleanup Method This field is only available when you select the Invoke Cleanup Methodcheck box.

You can specify the name of the method to invoke before the object inmemory is released. The method selected cannot contain any parameters,therefore only methods without parameters are listed in this field. Anyvalues returned by the selected method are ignored, but exceptions raisedby the selected method are sent to the log.

Keystore ProviderKeystore Provider shared resource provides an access to a keystore.

General


162


Field Description

Name The name to be displayed as the label for the keystore provider resource.

Description A short description of the resource.

Keystore


Field


Provider None The name of the keystore provider. Select from the followingavailable options:

● SUN● IBMJCE

Default: Empty. The first matching provider supporting theformat is selected.

URL Yes The location of the external keystore.

Password Yes The password for the keystore.

Type None The type of the keystore: JCEKS, JKS, PKCS#12.

Default: JKS

Refresh Interval Yes Refresh interval, greater than 0. If the keystore provider isaccessed after the refresh interval has expired:

● The refresh timer is reset to zero.● The operations on the keystore provider are performed on

the refreshed copy.


Proxy ConfigurationProxy Configuration shared resource is used to specify a proxy HTTP server when HTTP requests aresent outside of a firewall.

General


Field Description


Description A short description of the shared resource.

163


Proxy Connection Configuration


Field


Host Yes The host name or IP address of the proxy server.

Port Yes The port number of the proxy host.

Security


Field Description

Authentication Select the check box to specify the authentication to be used.

Identity Provider Create a UserId resource in the UserIdResource Resource Template wizard.This provides access to the username and password credentials to access theproxy connection.

SSL Client ConfigurationYou can specify SSL parameters for the HTTP client shared resource here.

SSL Client Configuration

The General section in the SSL Client Configuration has the following fields.

Field Description

Name The name to be displayed as the label of the SSL Client resource.

Description A short description of the SSL client resource.

Basic SSL Client Configuration


Field Module Property Description

KeystoreProvider AsTrust Store

No The name of a keystore provider resourceinstance that maintains a keystore thatconfirms an identity.

EnableMutualAuthentication

No Indicates whether the client in the SSLconnection authenticates to the server. Selectthis check box to enable the identity fields.

164



IdentityStoreProvider

No The name of keystore provider resource thatmaintains a keystore used to assert anidentity.

Key AliasName

Yes The name of the alias used to access theidentity.

Key AliasPassword

Yes The password for the alias.

Advanced Client SSL Configuration

This section contains the following fields.


SSLSecurityProvider

Yes Optional. The SSL security provider.

This is the name for the JSSE'scryptographic providerimplmenting SSLContext. If you areusing non-default providers, suchas PDCS#11 ones, you might wantto override it.

SSLProtocol

No The SSL protocol to use in the SSL connection:

● TLSv1● TLSv1.1● TLSv1.2● SSLv3 - Use of this protocol is discouraged.

The default is TLSv1.

Selecting a protocol implies the support ofhigher versions as well.

165



SSL CipherClass

No The number of bits in the key used to encryptdata:

● 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 keycombinations and the longer it takes to breakthe encryption.

The default is At Least 128 Bit.

ExplicitCipher List

Yes A list of ciphers. Enabled when SSL CipherClass is set to Explicit Ciphers. Use the JSSEformat for ciphers names.

VerifyRemoteHost name

No Indicates whether the name on the server'scertificate must be verified against the server'shost name. If the server's host name isdifferent than the name on the certificate, theSSL connection fails. The name on thecertificate can be verified against anothername by specifying Expected RemoteHostname.

Selecting this check box displays the ExpectedRemote Hostname field.

Default: This check box is clear.

ExpectedRemoteHostname

Yes Optional. The expected name of the remotehost.

The default is None.

Thread PoolThe thread pool is a queue of threads available to run a collection of tasks. Thread pools are used toimprove performance when executing large numbers of asynchronous tasks by reducing per taskinvocation overhead. This provides a means of bounding and managing the resources consumed whenexecuting a collection of tasks.

General


166


Field Description


Description A short description of the resource.

Thread Pool


Field


Core Pool Size Yes Must be greater than or equal to zero. The default is 5.

Max Pool Size Yes The maximum number of threads in the pool. Must be greaterthan zero and greater than or equal to core pool size.

The default is 10.

Keep AliveTime (s)

Yes The length of time an idle thread remains in the pool before beingreclaimed, if the number of threads in pool is more than core poolsize.

The default is 30 seconds.

Autostart CoreThreads

Yes Indicates to create and start the core pool size threads when thethread pool is created. Normally core threads are created andstarted only when new tasks arrive.

Thread PoolName Prefix

Yes A string prefixed to the name of each thread.

Daemon Yes Select the check box to specify whether the threads can be startedas a daemon or a user. The default is false.

Priority Yes The default priority of the threads in the pool. The default is 5.

Rejection Policy No The policy applied when no thread is available to run a task:

● BLOCKING: the task is blocked until a thread from the threadpool picks up this task.

● CALLER RUNS: the task is run in the calling thread.● ABORT: the task is aborted and an exception is thrown.

The default is BLOCKING.

167


Activity Icons Reference

Basic Activities Palette

Critical Section

Throw

For Each Iterate

Repeat Repeat on Error Scope While

Constructor

CompensateEmpty Exit

Get Context Invoke Rethrow Receive

Reply Set ContextSet EPR

General Activities Palette

Assign Timer Confirm Sleep

Get Shared Variable Inspector Log Mapper

168


General Activities Palette

Set Shared Variable

Call Process

HTTP Palette

HTTP Receiver Send HTTP Request Send HTTP Response

Java Palette

Java Invoke Java Process Starter Java To XML XML To Java

JDBC Palette

JDBC Call Procedure JDBC Query JDBC Update SQL Direct

JMS Palette

Get JMS QueueMessage

JMS Receive Message JMS Send Message Reply to JMS Message

RequestReply

169


Parse Palette

MimeParser Parse Data Render Data

REST and JSON Palette

Invoke REST API Parse JSON Render JSON

XML Activities Palette

Parse XML Render XML Transform XML

170


Date post:	03-Aug-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

TIBCO BusinessWorks Container Edition Palette Reference · Render Data ... Activity Icons...

Documents