TIBCO ActiveMatrix BusinessWorks™ Binding & Pallete ...

TIBCO ActiveMatrixBusinessWorks™Binding & Pallete ReferenceVersion 6.8.1May 2022

Copyright © 2015-2022. TIBCO Software Inc. All Rights Reserved.

TIBCO ActiveMatrix BusinessWorks™ Binding & Pallete Reference

2 | Contents

ContentsContents 2

Changing Help Preferences 9

Binding 11SOAP Binding 11

Terminology 12

SOAP Service Binding 13

SOAP Reference Binding 37

Basic Activities Palette 59Critical Section 59

Local Transaction 61

For Each 64

Iterate 65

Repeat 68

Repeat on Error 70

Scope 71

While 72

Constructor 74

Compensate 74

Empty 75

Exit 75

Get Context 75

Invoke 77

Rethrow 80

Receive 80

Reply 81


3 | Contents

Set Context 83

Set EPR 84

Throw 86

Start 87

End 88

Engine Command 89Commands 91

File Palette 102Copy File 102

Remove File 105

Create File 107

File Poller 110

List Files 115

Read File 118

Rename File 121

Write File 124

Cloud FTL Palette 128Accessing the Cloud FTL Palette 128

Cloud FTL Publisher 131

Cloud FTL Reply 133

Cloud FTL Request Reply 135

Cloud FTL Subscriber 138

FTP Palette 141FTP Change Default Directory 141

FTP Delete File 143

FTP Dir 146

FTP Get 148

FTP Get Default Directory 153

FTP Make Remote Directory 156


4 | Contents

FTP Put 158

FTP Quote 163

FTP Remove Remote Directory 166

FTP Rename File 169

FTP SYS Type 172

General Activities 175Assign 175

Call Process 176

Checkpoint 180Checkpoints and Confirm Activity 181

Confirm 181

External Command 182

Get Shared Variable 187

Inspector 188

Log 190

Mapper 193

Notify 194

Set Shared Variable 195

Sleep 197

Timer 198

Wait for Notification 202

On Notification Timeout 204

Receive Notification 206

HTTP Palette 208HTTP Receiver 208

Send HTTP Request 222Sending Data in the HTTP Request 237

Wait for HTTP Request 239

Send HTTP Response 250


5 | Contents

JAVA Palette 257Configuring JAVA in an Application Module 257

Existing Project 258

Converting JAVA Class to XML Schema 259

Creating Custom XPath Functions 260

Creating Custom XPath Functions with Multiple Java Classes 268

Using Custom XPath Function at Design Time and Run Time 270Making Custom XPath Function Available at Run Time 273

Deleting Custom XPath Functions 274

Java Invoke 274

Java Process Starter 281

Java To XML 285

XML To Java 287

JDBC Palette 290JDBC Call Procedure 290

JDBC Query 297

JDBC Update 303

SQL Direct 308

JMS Palette 313Common JMS Properties and Headers 313

Get JMS Queue Message 316

JMS Receive Message 323

JMS Request Reply 331

JMS Send Message 339

Reply to JMS Message 346

Wait for JMS Request 351

Mail Palette 360Receive Mail 360

Send Mail 366


6 | Contents

Parse Palette 372Parsing a Large Number of Records 372

MimeParser 373

Parse Data 375

Render Data 380

Rendezvous Palette 383Datatype Conversion 383

Field Names in Messages 385

Globalization Support 386

Rendezvous Publisher 387

Rendezvous Transport 390

Rendezvous Reply To Request 394

Rendezvous Subscriber 396

Rendezvous Request Reply 400

Wait for Rendezvous Message 403

REST and JSON 407BW JSON Utils 407

Invoke REST API 408

Restrictions on XML Schema 415

Parse JSON 415

Render JSON 418

Transform JSON 421

Policy Resources 423Basic Authentication 423

Basic Credential Mapping 425

WSS Consumer 426

WSS Provider 431

Shared Resources 438


7 | Contents

Data Format 438

FTP Connection 443

HTTP Client 446Persistent Connections 458

HTTP Connector 459

Identity Provider 468

JDBC Connection 469

JMS Connection 479

JNDI Configuration 486Using TIBCO Custom JMS JNDI Provider 488

Enabling custom libraries 489

Configuring and Setting up Custom Drivers for Runtime 489

Adding Multiple Initial Context Factories 490

Java Global Instance 491

Keystore Provider 493

LDAP Authentication 495

OAuth Configuration Resource 500

Proxy Configuration 502

Rendezvous Transport 503

SMTP Resource 508

SSL Server Configuration in the Cloud 510

SSL Server Configuration 510

Mashery End Point Configuration 513

SSL Client Configuration 513

Subject Provider 516

TCP Connection 518

Trust Provider 520

WSS Authentication 521

XML Authentication 523

Notify Configuration 523

Thread Pool 524


8 | Contents

TCP Palette 527TCP Properties 527

Using the TCP Palette Activities 528

Read TCP Data 528

TCP Close Connection 532

TCP Open Connection 533

TCP Receiver 536

Wait for TCP Request 538

Write TCP Data 541

XML Activities Palette 544Parse XML 544

Render XML 547

Transform XML 551

Activity Icons Reference 554

TIBCO Documentation and Support Services 558

Legal and Third-Party Notices 560


9 | Changing Help Preferences

Changing Help PreferencesBy default, documentation access from TIBCO Business Studio™ for BusinessWorks™ isonline, through the TIBCO Product Documentation website that contains the latest versionof the documentation. Check the website frequently for updates. To access the productdocumentation offline, download the documentation to a local directory or an internal webserver and then change the help preferences in TIBCO Business Studio for BusinessWorks.

Before you beginBefore changing the help preferences to access documentation locally or from an internalweb server, download the documentation.

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

2. In the Search field, enter TIBCO ActiveMatrix BusinessWorks™ and press Enter.

3. Select the TIBCO ActiveMatrix BusinessWorks™ product from the list. This opens theproduct documentation page for the latest version.

4. Click Download All.

5. A compressed .zip file containing the latest documentation is downloaded to yourweb browser's default download location.

6. Copy the .zip file to a local directory or to an internal web server and unzip the file.

To point to a custom location:

Procedure1. Perform one of the following steps in TIBCO Business Studio for BusinessWorks based

on your operating system:

l On Windows OS: Click Window > Preferences

l On macOS: Click TIBCO Business Studio > Preferences.

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

3. Click Custom Location, and then browse to the html directory in the folder where youextracted the documentation or provide the URL to the html directory on your internal

https://docs.tibco.com/



10 | Changing Help Preferences

web server.

4. Click Apply, and then click OK.


11 | Binding

BindingBindings, which are well known external communication gateways, establish connectionsbetween Service Oriented Architecture (SOA) services and their consumers.

The two types of binding components are:

l Service Binding: used to create and expose a service to the external world. Theservice can contain one or more operations. Once exposed, clients can consume theservice.

l Reference Binding: used to create a client that can connect and communicate to anexternal service.

TIBCO ActiveMatrix BusinessWorks™ supports REST as well as SOAP bindings.

For more information about REST bindings, see the ActiveMatrix BusinessWorks™ RESTReference.

SOAP BindingUse SOAP binding to create service providers and service consumers. TIBCO ActiveMatrixBusinessWorks™ 6.xTIBCO ActiveMatrix BusinessWorks™ supports SOAP 1.1 and SOAP 1.2protocols. These messages can either use HTTP or JMS for communication.

There are two types of SOAP bindings:

l Service (to create service providers)

l Reference (to create service consumers)ActiveMatrix BusinessWorks™ActiveMatrix BusinessWorks™ supports the following MessageExchange Patterns of SOAP operations:

l One-Way

l Two-Way (request-response)

l Two-Way with Fault


12 | Binding

TerminologyTIBCO ActiveMatrix BusinessWorks™TIBCO ActiveMatrix BusinessWorks™ uses specificterminology to identify the purpose of the message, that is exchanged between a serviceprovider and a service consumer.

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

The following table describes the terminology used for 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


13 | Binding

Note: Based on the definitions in the SOAP Headers table, SOAP headers can becategorized into any of the following three types of configurations:

l Described bound headers

l Described unbound headers

l Undescribed unbound headers

SOAP Attachments

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

SOAPAttachmentTypes

Description

DescribedBoundAttachments

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 anattachment is 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

This section has the following fields.


14 | Binding

Field Description

Name The name of the service binding.

Description A short description of the service getting exposed.

TargetNamespace

The Target Namespace of the service.

ExposeSecurityContext

Selecting this option exposes the transport level security context in themessage header, and places the information from the user's security context(either authentication or SSL certificate information) into the Context orSecurityContext output element.

Note: This is a fairly expensive operation and SSL certificates canconsume memory resources. Hence, select this option only if you requireinformation from the user's security context for later use in your process.

Generate Concrete WSDL

The SOAP service binding helps you to create the concrete WSDL using Concrete WSDLGeneration Wizard. 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 either Document orRPC style.

Encoding Encoding is literal.

AttachmentStyle

Select the default attachment style for all the binding operations. Can beoverridden at the operations level for each operation.


15 | Binding

Field Description

The following attachment styles are available:

l SwA - Supports both, Bound and Unbound Attachments

l MTOM

The MTOM attachment style is available if SOAP 1.1, or SOAP 1.2 specificationis used.

Transport Configuration


Field LiteralValue/ModuleProperty

Description

Transport Type None The transport over which SOAP message is sent. TheHTTP and JMS transports are supported.

ConnectorName

None The name of the shared resource. This points to eitherthe HTTP or JMS shared transport configuration.

Configuration for HTTP Transport

HTTPConnectorName

Yes Name of the HTTP Connector resource.

Tip: Click on the HTTP Connector Name field todisplay details 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.


16 | Binding


Description

Tip: Click on the JMS Connection Name field todisplay details about the JMS connector resource.

AcknowledgeMode

None The acknowledge mode for service request messages. Itcan be one of the following:

l Auto: The message is acknowledged when it isreceived by a SOAP Service Binding.

l Client: The message is not acknowledged when itis received by the SOAP Service Binding. You canconfirm the message by using the Confirmactivity in the process that is configured as anoperation implementation. If the Confirm activityis not used, the message is automaticallyacknowledged by the SOAP Service Binding whilesending the service reply.

l Dups OK:The message is acknowledgedautomatically when it is received by a SOAPService Binding. JMS provides this mode for lazyacknowledgment , but messages areacknowledged upon receipt.

l Tibco EMS Explicit: (only available for TIBCOEnterprise Message Service™)

The message is not acknowledged when it isreceived by a SOAP service binding. You canconfirm the message by using the Confirmactivity in the process that is configured as theoperation implementation.

If the Confirm activity is not used, then themessage is automatically acknowledged by theSOAP Service Binding while sending the servicereply.


17 | Binding


Description

The session is not blocked and one sessionhandles all incoming messages for each processinstance.

l Tibco EMS Explicit Dups OK: (only available forTIBCO Enterprise Message Service)

The message is not acknowledged when it isreceived by a SOAP service binding. You canconfirm the message by using the Confirmactivity in the process that is configured as theoperation implementation.

If the Confirm activity is not used, the message isautomatically acknowledged by SOAP ServiceBinding while sending the service reply.The session is not blocked and one sessionhandles all the incoming messages for eachprocess instance. The messages however, arelazily acknowledged.

Message Type None Specifies the type of the service request messages. Itcan be either Text message or Bytes message.

Messaging Style None Specifies the style of the service request messages. Itcan be Generic, Queue, or Topic.

JMSDestination

Yes Specifies the name of the destination for the servicerequest messages. The syntax of the destination nameis specific to the JMS provider you are using.

JMS ApplicationProperties

None User-defined JMS Properties expected to be available inthe service request messages.

NOTE: JMS Application properties should be defined ina schema only through a complex type. Also, all JMSApplication properties should be direct child of this


18 | Binding


Description

complex type.

JMS ApplicationProperties(Response)

None User-defined JMS Properties expected to be sent in thethe service response messages.

NOTE: JMS Application properties should be defined ina schema only through a complex type. Also all JMSApplication properties should be direct child of thiscomplex type.

Max Sessions None When the Acknowledge Mode field is set to Client, thisfield configures the maximum number of JMS sessionsthat is created for the service request messages.

When a message is received, the session is blocked untilthe message is acknowledged in the process. Ifacknowledgment is not done at process level then it isautomatically acknowledged when the SOAP ServiceBinding sends a service reply.

After reaching the maximum number of sessions, nonew incoming messages can be processed. Once anyone of the messages is processed ,the total number ofactive sessions decreases and then another incomingmessage can be processed.

Operations None This field is available only when Topic is selected in theJMS Destination Type field.

Operation Name - Specifies the operation name.

Durable Subscription - Set to true if the client is adurable subscriber.

Subscription Name - Specify the Subscription Name ifDurable Subscription is set to true.


19 | Binding

Note: Note: Imported projects display the HTTP Authentication check boxunder the Transport Configuration section if the check box was selected whenthe project was created. Authentication remains enabled on the SOAP ServiceBinding if you do not clear the check box. If you clear the Authentication checkbox, a warning message is displayed prompting you to confirm your action. Toremove authentication from the binding, click OK. Once you have removedauthentication from the SOAP Service Binding, you can reapply it using theBasic Authentication policy.

Persistence Configuration



Description

PersistenceType

None Select any one from the available Persistenceconfiguration types. 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.

ThresholdSize

Yes The maximum size of the attachment that can be kept inmemory. Attachments larger than the specified size willbe written to the disk.The file name generated forserialization is random except when the Content-disposition header is available for the attachment. Here,the name is the same as the content-disposition headervalue.

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


20 | Binding

Threading Policy Details

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

Activity Type Multi-Threaded?

Default ThreadCount

Thread Count Configuration

Transport: HTTP

ProcessStarter Yes l Minimumthread poolthreads = 10

l Maximumthread poolthreads = 75

It can be configured on the HTTPConnector shared resource usingthe following fields:

l Minimum QTP threads

l 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.

Generating Concrete WSDLYou can create the concrete WSDL using Concrete WSDL Generation Wizard and using webbrowser.

Generate Concrete WSDL Using Wizard

To generate the WSDL:

Procedure1. Click Generate Concrete WSDL.


21 | Binding

2. Click the Workspace tab to create the WSDL in your workspace and specify alocation where WSDL is to be created.

3. To select a WSDL location:

a. Click Workspace for a workspace location. Recommended: Select the ServiceDescriptor folder to contain all project-related workspace WSDLs.

b. Click File System to save the concrete WSDL on a non-workspace disk location.

c. Click Finish to generate a WSDL with default settings.

The File Name field shows the name of the WSDL, for example BooksService_gen.wsdl.Override it if necessary.

4. Click Next.

5. Select the Embed Abstract WSDL and Embed Schema check boxes.

By default the Embed Abstract WSDL and Embed Schema check boxes are selected.

With Embed Abstract WSDL check box selected, the concrete WSDL generated hasan abstract WSDL content in it.

The namespace of the concrete WSDL is the same as that of an abstract WSDL. If thecheck box is not selected, then the namespace of the concrete WSDL is different thanthat of the abstract WSDL.

When you select the Embed Schema check box, the concrete WSDL generated hasthe schema definition (mentioned in the abstract WSDL) in it. A schema without a


22 | Binding

target namespace is not supported.

Note: To avoid any namespace resolution error in the application module:If the concrete WSDL is placed in a workspace location (as mentioned inthe earlier step), clear the Embed Abstract WSDL check box.

6. For advance configuration of the concrete WSDL such as Namespace URI, ServiceName, Host, and Port (for SOAP over HTTP), click the Advance tab. Override them asper requirement.

7. Click Finish.

Generate Concrete WSDL Using BrowserThe following steps are applicable only for SOAP over HTTP service.

Before you beginSOAP service must be running.

Procedure1. Run lendpoints command on console to get the list of endpoint URLs.

2. Copy the endpoint URL obtained in the browser. Append ?wsdl string and hit enter.This generates and downloads concrete WSDL on your local disk. Since ActiveMatrixBusinessWorks 6.5.0 , the concrete WSDL is downloaded on your local disk. Use atext or an XML editor to view the concrete WSDL.

Operation ConfigurationOperation configuration enables you to set configurations at the operation level.


Field Description

Operation The name of the operation component.


23 | Binding

Field Description

Name

SOAP Action Specifies the soap action for this operation. By default it is the operationname

Style The SOAP binding style. Specify either DefaultDocument or RPC style.Configurations made at the binding level can be overidden here.

AttachmentStyle

Select the attachment style for the operations.

The default configurations for each operation can be overridden here.


l Default - The attachment style configured at the binding level.

l SwA

l MTOM

The MTOM attachment style is available if SOAP 1.1 or SOAP 1.2 specificationis used.

Request Message ConfigurationRequest Message Configuration can be used to configure request message contents likeSOAP header, SOAP body, and attachments.

Message Part Configuration

Configure the WSDL Input message parts as body, header (bound) or attachment for aservice request.

The Attachment option, configures a SwA attachment (bound). This is available only forWSDL message parts that are of type base64binary.

This section has the following fields:


24 | Binding

Field Description

Part Name Specifies the part name of the WSDL message as configured in the WSDL.

Part Type To configure the WSDL message part use any of the following:

l Header - Configures the WSDL part as a SOAP Header.

l Body - Configures the WSDL part as SOAP Body.

l Attachment - Configures the WSDL part as a SwA attachment.

Unbound Header Configuration

This section explains the configuration of the SOAP Headers for service requests. The WSDLmessage's part, other than the input WSDL message can be configured as a SOAP header.The WSDL messages can be in an external WSDL.

Configurations done in this section appears in the Concrete WSDL in the SOAP headerelement.

Select Unbound Header

Use the Add icon to select and add this configuration. Select the WSDL, the messageand then the part.


Field Description

Message Specifies the WSDL message name as configured in the WSDL.

Part Specifies the part name of the WSDL message as configured in the WSDL.

Delete Unbound Header

To delete an unbound header, select the required row and click the icon.


25 | Binding

Undescribed Header Configuration

You can configure SOAP Headers for service requests in this section. The WSDL message'spart, other that the input WSDL message, can be configured as SOAP header here. TheWSDL messages can be in an external WSDL. These headers are undescribed headers anddo not appear in the Concrete WSDL.

Add Undescribed Header

To add an undescribed header, use the Add icon to select and add this configuration.Click the icon and select the WSDL, the message and then the part.


Field Description

Header Name Specifies the WSDL message name as configured in the WSDL.

Header Part Specifies the part name of the WSDL message as configured in the WSDL

Cardinality Configure the cardinality of the configured SOAP header as one of thefollowing:

l Optional(?) - The SOAP header is optional.

l Required - The SOAP Header is required and must be supplied when theprocess is called.

l Repeating (*) - Zero or more SOAP headers must be supplied arepresent when the process is called.

Delete Undescribed Header

To delete an undescribed header, select the required binding and click the Delete Binding

icon .

Attachment Configuration

If a part is configured as an attachment in the Message Configuration section, then theattachment's content type is configured here. This section has the following fields:


26 | Binding

Field Description

Part Specifies the WSDL message name as configured in the WSDL.

This corresponds to the part that is configured as an attachment in the MessagePart Configuration section.

ContentType

Indicates the media type of the attachment received. An example of the mediatype is text/html.

Response Message ConfigurationResponse Message Configuration enables you to configure response message contents likethe SOAP header, SOAP body, and attachments.



Field Description


Part Type You can configure the WSDL message part as any of the following:

l Header - Configures the WSDL part as a SOAP Header

l Body - Configures the WSDL part as SOAP Body



You can configure SOAP Headers in this section. The WSDL message part, other than theinput WSDL message, can be configured as a header here. The WSDL messages can be inan external WSDL.

Configurations done in this section appear in the Concrete WSDL in the SOAP headerelement.


27 | Binding

Add Unbound Header

Use the Add icon to select and add this configuration. Click the icon and select theWSDL, the message and then the part.


Field Description

Message Specifies the part name of the WSDL message as configured in the WSDL.

Part You can configure the WSDL message part as any of the following:


l Body - Configures the WSDL part to SOAP Body

l Attachment -Configures the WSDL part as a SwA attachment.


You can delete an unbound header. Select the required header and click the icon.


You can configure SOAP Headers in this section. WSDL message's part, other that the inputWSDL message, can be configured as soap headers in this section. The WSDL messages canbe in an external WSDL. These headers are undescribed headers and do not appear in theConcrete WSDL.





28 | Binding

Field Description

Header Name Specifies the message name.

Header Part Specifies the message part.



l Required - The Soap Header is required and must be supplied when theprocess is called.



You can delete an undescribed header. Select the required header and click the icon.



Field Description



ContentType

Indicates the media type of the entity body sent to the receiver. An example ofthe media type is text/html.

Context MappingUsing Context Mapping you can map data between the context activities used in a process,and the request response or fault message.


29 | Binding

Note: Transport headers are supported when mapping the fault context for aSOAP Service Binding, and undescribed headers are supported when mappingthe fault context for a SOAP Reference Binding.

Request ContextUsing Request Context you can map data from the Request Message to the Get ContextActivity used in the process.

Data Source

Displays the data source schema tree for the input context parameters. All elements in thistree are available to drag and drop into the XPath Expression field. The followingelements are populated from the request message:

Elements of RequestMessage

Description

Transport Properties Transport related information for HTTP headers when theTransport is HTTP, or JMS properties when the Transport is JMS,are populated from the request message.

l method: The method specified in the request. For example,GET and POST.

l requestURI: The address portion of the request. This is theportion before the question mark (?).

l httpversion: Version field of the HTTP request.

l querystring: The query string portion of the request. This isthe portion after the question mark (?).

l header: The header of the HTTP request.

l protocol: Can be either HTTP or HTTPS depending uponthe protocol used by the request.

l port: Port number on which the request was received.

l remoteAddress: The IP address of the client that submitted


30 | Binding


Description

the HTTP request.

Headers Headers from the request message.

l accept: This field specifies media types that are acceptablefor response messages for the incoming request. Forexample, text/*,text/html. Media types are described in theHTTP specification.

If no Accept header field is present, then it is assumed thatthe client accepts all media types.

l accept-charset: This field specifies the character sets thatare acceptable for response messages for the incomingrequest. For example, iso-8859-5, unicode-1-1. Charactersets are described in the HTTP specification.

If no Accept-Charset header is present, then it is assumedthat the client accepts any character set.

l accept-encoding: This field specifies the content-codingvalues that are acceptable for response messages. Forexample, compress, gzip. See the HTTP specification for moreinformation about this header field.

l content-type: This field indicates the media type of theentity body sent to the receiver. For example, text/html;charset=ISO-8850-4. Media types are described in the HTTPspecification.

l content-length: This field indicates the size of the entitybody (in decimal number of OCTETs) sent to the receiver.

l connection:Use this field to specify options required forthis connection. For example, the close option specifiesthat you want the connection to be closed when therequest is complete.

l pragma: This field is used to include implementation-specific directives that might apply to the receiver. See theHTTP specification for more information about using this


31 | Binding


Description

field.

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

Dynamic Headers The dynamic header is an additional header parameter to addruntime headers to the outgoing HTTP messages. TheDynamicHeaders consists of the following information:

l Name: the name of the header

l Value: the value of the header

Headers The header of the request.

Undescribed Headers Undescribed headers from the request message.

mimeEnvelopeElement Information about the attachments that are present in therequest message. Individual attachment information is populatedunder one mimepart element.

Note: If the attachment size increases the threshold valueconfigured at the binding level, the file name of the serializedattachment is populated.

mimeHeader This element contains the mime header for each mimePart. Mimeheaders can contain the following information:

l content-disposition — To suggest a filename for anattachment, use "*;filename=<filename>" in this element.Note: HTTP servers may alter or choose to ignore thesuggested name.

o content-type

o content-transfer-encoding

o content-id


32 | Binding


Description

o other mime header informationSee http://www.faqs.org/rfcs/rfc2045.html for moreinformation about MIME headers and their syntax.

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

binaryContent |textContent | fileName

This element contains the mime attachment. The element can beone of the following:

l binaryContent — content of the attachment when theattachment is binary data.

l textContent — content of the attachment when theattachment is text data.

l fileName — the file name of the attachment written to thedisk.

Functions

Displays the available XPath functions. These are categorized into groups and eachfunction can be dragged from the function list into the XPath Expression field.

When the function is placed into the XPath Expression, placeholders are displayed for thefunction’s parameters. You can drag and drop schema elements from the Data Source tabinto the function’s placeholders.

Filter

Use this field for a refined function search in the mapper. Clicking the Functions tabdisplays the Filter field. For example, type "time" in the Filter field to obtain consolidatedresults relating to "time" function.


33 | Binding

Constants

Displays the constants available for use in XPath expressions. These are categorized intogroups and each constant can be dragged from the constants list into the XPathExpression field. Constants are useful for inserting special characters, such as quotes,symbols, and so on, into XPath formulas. Constants are also defined for commonly useditems, such as date/time formats.

Constants can also be used for inserting TIBCO BW Predefined Module Properties, suchas Activity Name, Application Name, Domain Name, and so on.

XPath Expression

Displays the XPath formula you want to create. You can drag and drop items from the DataSource tab or the Functions tab to create the formula.

Response ContextResponse Context enables you to map data from the Set Context Activity to the responsemessage.

Data Source

Displays the data source schema tree for the output context parameters. All elements inthis tree are available to drag and drop into the XPath Expression field.

The following are the response message entities:


34 | Binding

Elements of SetContext/ ResponseMessage

Description

Headers Headers of the response message.

l pragma: This field is used to include implementation-specific directives that might apply to the receiver. See theHTTP specification for more information about using thisfield.

l location: This field is used to redirect the receiver to alocation other than the Request-URI for completion of therequest or for identification of a new resource.




Headers The fields of the header specified on the Input Headers tab.

Undescribed Headers Undescribed headers of the response message.

mimeEnvelopeElement Information about the attachements that are present in theresponse message. Individual attachment information ispopulated under one mimepart element. All attachments areconfigured as SwA unbound attachments.

Note: If the attachment size increases the threshold valueconfigured at the binding level, the file name of the serializedattachment will be populated.


l content-disposition — To suggest a filename for anattachment, use "*;filename=<filename>" in this element.


35 | Binding


Description

Note: HTTP servers may alter or choose to ignore thesuggested name.

o content-type


o content-id








Functions



36 | Binding


Constants


XPath Expression


Fault ContextFault Context enables you to configure the SOAP Fault data.

Data Source

Displays the data source schema tree for the SOAP fault message. All elements in this treeare available to drag and drop into the XPath Expression field. The following elements arethe fault message entities:

Elements of FaultMessage

Description

SOAPFaultContext The SOAP fault schema describes information about the fault sentback to the user.

Functions



37 | Binding


Filter


Constants



XPath Expression

Displays the XPath formula you want to create. Drag and drop items from the Data Sourcetab or the Functions tab to create the formula.

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


38 | Binding

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.

AttachmentStyle

The attachment style for the incoming and outgoing messages. The followingattachment styles are available:

l SwA

l MTOM

The MTOM attachment style is available if SOAP 1.1, or SOAP 1.2 specificationis used.

Transport Configuration



Description

TransportType

None The transport over which the SOAP message is sent.HTTP and JMS transports are supported.


39 | Binding


Description

Application for HTTP Transport

DefaultHost/Port

None Specifies the default host and port configurationavailable in the concrete WSDL.

HTTP ClientName

None Name of the HTTP Client resource.

Endpoint URI Yes The endpoint of the service through which SOAP clientscan access the service.

Application for JMS Transport

JMSConnectionName

None Name of the JMS Connector resource

Tip: Click on the JMS Connection Name field todisplay details about the JMS Connector resource.

JMSDestination

Yes Specifies the name of the destination for the incomingJMS messages. The syntax of the destination name isspecific to the JMS provider you are using.

MessagingStyle

None Specifies the style of the incoming messages on thespecified destination. It can be Generic, Queue, or Topic.

Message Type None Specifies the type of the incoming messages on thespecified destination. It can be either Text Message orBytes Message.

Delivery Mode No The delivery mode of messages.

l Persistent Messages are stored and forwarded.

l Non-Persistent Messages are not stored and canbe lost due to failure.


40 | Binding


Description

The default is Persistent.

Expiration Yes The length of time a message can remain active. 0 meansthat the message does not expire.

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

The default is 4.

JMSApplicationProperties

None The user-defined JMS Properties required to be availablein the incoming message.

JMSApplicationProperties(Response)

None The user-defined JMS Properties required to be sent inthe outgoing message.

Persistence Configuration



Description

PersistenceType

None Select any one from the available persistenceconfiguration types.

l None

l File

Selecting the File option displays the Directory, Create


41 | Binding


Description

Directories, and Threshold Size fields.

Directory Yes The directory to write attachments that exceed thespecified threshold size.

CreateDirectories

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

ThresholdSize

Yes The maximum size (in bytes) of an incoming messageattachment that can be kept in memory. Attachmentslarger than the specified size are written to a file in thespecified directory.

The file name is the output, so that subsequent activitiesin the process can access the file and read its contents.

Operation ConfigurationOperation configuration enables you to set configurations at the operation level.


Field Description

OperationName

The name of the operation component.

SOAP Action Specifies the soap action for this operation. By default it is the operationname

Style The SOAP binding style. Specify either DefaultDocument or RPC style.Configurations made at the binding level can be overidden here.

Attachment Select the attachment style for the operations.


42 | Binding

Field Description

Style The default configurations for each operation can be overridden here.


l Default - The attachment style configured at the binding level.

l SwA

l MTOM

The MTOM attachment style is available if SOAP 1.1 or SOAP 1.2 specificationis used.

Request Message ConfigurationRequest Message Configuration can be used to configure request message contents likeSOAP header, SOAP body, and attachments.


Configure the WSDL Input message parts as body, header (bound) or attachment for aservice request.

The Attachment option, configures a SwA attachment (bound). This is available only forWSDL message parts that are of type base64binary.


Field Description


Part Type To configure the WSDL message part use any of the following:

l Header - Configures the WSDL part as a SOAP Header.

l Body - Configures the WSDL part as SOAP Body.



43 | Binding


This section explains the configuration of the SOAP Headers for service requests. The WSDLmessage's part, other than the input WSDL message can be configured as a SOAP header.The WSDL messages can be in an external WSDL.

Configurations done in this section appears in the Concrete WSDL in the SOAP headerelement.

Select Unbound Header

Use the Add icon to select and add this configuration. Select the WSDL, the messageand then the part.


Field Description

Message Specifies the WSDL message name as configured in the WSDL.

Part Specifies the part name of the WSDL message as configured in the WSDL.


To delete an unbound header, select the required row and click the icon.


You can configure SOAP Headers for service requests in this section. The WSDL message'spart, other that the input WSDL message, can be configured as SOAP header here. TheWSDL messages can be in an external WSDL. These headers are undescribed headers anddo not appear in the Concrete WSDL.


To add an undescribed header, use the Add icon to select and add this configuration.Click the icon and select the WSDL, the message and then the part.


44 | Binding


Field Description

Header Name Specifies the WSDL message name as configured in the WSDL.

Header Part Specifies the part name of the WSDL message as configured in the WSDL



l Required - The SOAP Header is required and must be supplied when theprocess is called.



To delete an undescribed header, select the required binding and click the Delete Binding

icon .


If a part is configured as an attachment in the Message Configuration section, then theattachment's content type is configured here. This section has the following fields:

Field Description



ContentType

Indicates the media type of the attachment received. An example of the mediatype is text/html.


45 | Binding

Response Message ConfigurationResponse Message Configuration enables you to configure response message contents likethe SOAP header, SOAP body, and attachments.



Field Description


Part Type You can configure the WSDL message part as any of the following:


l Body - Configures the WSDL part as SOAP Body



You can configure SOAP Headers in this section. The WSDL message part, other than theinput WSDL message, can be configured as a header here. The WSDL messages can be inan external WSDL.

Configurations done in this section appear in the Concrete WSDL in the SOAP headerelement.

Add Unbound Header




46 | Binding

Field Description

Message Specifies the part name of the WSDL message as configured in the WSDL.

Part You can configure the WSDL message part as any of the following:


l Body - Configures the WSDL part to SOAP Body

l Attachment -Configures the WSDL part as a SwA attachment.


You can delete an unbound header. Select the required header and click the icon.


You can configure SOAP Headers in this section. WSDL message's part, other that the inputWSDL message, can be configured as soap headers in this section. The WSDL messages canbe in an external WSDL. These headers are undescribed headers and do not appear in theConcrete WSDL.




Field Description





47 | Binding

Field Description








Field Description



ContentType

Indicates the media type of the entity body sent to the receiver. An example ofthe media type is text/html.

Fault Operation ConfigurationFault Operation Configuration enables you to configure fault messages.




48 | Binding

Field Description

Part Name Specifies the part name of the WSDL message.

Part Type The body of the SOAP message.


Configure SOAP Headers in this section. WSDL message's part, other than the input WSDLmessage, can be configured as SOAP header here. The WSDL messages can be in anexternal WSDL file.


Use the Add icon to select and add this configuration. Click the icon and select theWSDL, the message, and then the part.


Field Description






l Repeating (*) - Zero or more SOAP headers must be supplied arepresent when tha process is called.




49 | Binding

Context MappingUsing Context Mapping you can map data between the context activities used in a process,and the request response or fault message.

Note: Transport headers are supported when mapping the fault context for aSOAP Service Binding, and undescribed headers are supported when mappingthe fault context for a SOAP Reference Binding.

Response ContextResponse Context enables you to map data from the Set Context Activity to the responsemessage.

Data Source

Displays the data source schema tree for the output context parameters. All elements inthis tree are available to drag and drop into the XPath Expression field.

The following are the response message entities:


Description

Headers Headers of the response message.


l location: This field is used to redirect the receiver to alocation other than the Request-URI for completion of therequest or for identification of a new resource.

Dynamic Headers The dynamic header is an additional header parameter to addruntime headers to the outgoing HTTP messages. The


50 | Binding


Description

DynamicHeaders consists of the following information:



Headers The fields of the header specified on the Input Headers tab.

Undescribed Headers Undescribed headers of the response message.

mimeEnvelopeElement Information about the attachements that are present in theresponse message. Individual attachment information ispopulated under one mimepart element. All attachments areconfigured as SwA unbound attachments.

Note: If the attachment size increases the threshold valueconfigured at the binding level, the file name of the serializedattachment will be populated.



o content-type


o content-id



51 | Binding


Description







Functions



Constants



52 | Binding

XPath Expression


Request ContextUsing Request Context you can map data from the Request Message to the Get ContextActivity used in the process.

Data Source

Displays the data source schema tree for the input context parameters. All elements in thistree are available to drag and drop into the XPath Expression field. The followingelements are populated from the request message:


Description

Transport Properties Transport related information for HTTP headers when theTransport is HTTP, or JMS properties when the Transport is JMS,are populated from the request message.

l method: The method specified in the request. For example,GET and POST.

l requestURI: The address portion of the request. This is theportion before the question mark (?).

l httpversion: Version field of the HTTP request.

l querystring: The query string portion of the request. This isthe portion after the question mark (?).

l header: The header of the HTTP request.

l protocol: Can be either HTTP or HTTPS depending uponthe protocol used by the request.

l port: Port number on which the request was received.

l remoteAddress: The IP address of the client that submittedthe HTTP request.


53 | Binding


Description

Headers Headers from the request message.

l accept: This field specifies media types that are acceptablefor response messages for the incoming request. Forexample, text/*,text/html. Media types are described in theHTTP specification.

If no Accept header field is present, then it is assumed thatthe client accepts all media types.

l accept-charset: This field specifies the character sets thatare acceptable for response messages for the incomingrequest. For example, iso-8859-5, unicode-1-1. Charactersets are described in the HTTP specification.

If no Accept-Charset header is present, then it is assumedthat the client accepts any character set.

l accept-encoding: This field specifies the content-codingvalues that are acceptable for response messages. Forexample, compress, gzip. See the HTTP specification for moreinformation about this header field.

l content-type: This field indicates the media type of theentity body sent to the receiver. For example, text/html;charset=ISO-8850-4. Media types are described in the HTTPspecification.

l content-length: This field indicates the size of the entitybody (in decimal number of OCTETs) sent to the receiver.

l connection:Use this field to specify options required forthis connection. For example, the close option specifiesthat you want the connection to be closed when therequest is complete.



54 | Binding


Description

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




Headers The header of the request.

Undescribed Headers Undescribed headers from the request message.

mimeEnvelopeElement Information about the attachments that are present in therequest message. Individual attachment information is populatedunder one mimepart element.

Note: If the attachment size increases the threshold valueconfigured at the binding level, the file name of the serializedattachment is populated.



o content-type


o content-id

o other mime header informationSee http://www.faqs.org/rfcs/rfc2045.html for more


55 | Binding


Description

information about MIME headers and their syntax.







Functions



Filter



56 | Binding

Constants



XPath Expression


Fault Context (Fault)Fault Context enables you to configure the SOAP Fault data.

Data Source

Displays the data source schema tree for the SOAP fault message. All elements in this treeare available to drag and drop into the XPath Expression field. The following elements arethe fault message entities:


57 | Binding

Elements of Fault Message Description

HTTPReferenceInputContext/

JMSReferenceInputContext

The reference input context depending on the transportselected.

SOAPFaultContext The SOAP fault schema describes information about thefault sent back to the user.

Functions



Filter


Constants



58 | Binding


XPath Expression



59 | Basic Activities Palette

Basic Activities PaletteBasic activities are a simple means of interacting with a service, manipulating the passingdata, or handling exceptions. They also contain Loops that are Groups with Conditions,which follow a pattern at run time such as, initialize the loop, update the loop at eachiteration, and test conditions for the loop to stop iterating.

The available types of loops are:

l Local Transaction

l For Each

l Iterate

l Repeat

l Repeat On Error

l Scope

l While

Critical SectionCritical Section groups are used to synchronize process instances. At run time, multipleprocess instances can be executed concurrently. You can use Critical Section groups tosynchronize the set of actions performed in the process across multiple process instances.Only one process instance can execute the Critical Section group and its contents at anyspecified time. Other concurrently running process instances that are associated with thecorresponding Critical Section group wait at the start of the Critical Section group, untilthe 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.

GroupType

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

Timeout(msec)

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

The timeout field can be used to avoid deadlock situations.

SharedLock

Select this check box to synchronize multiple critical section groups that use thesame shared variable as a lock.

SharedVariableType

This field appears only when the Shared Lock check box is selected.

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

l 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 instances.

These Critical Section groups can be in the same process or in anotherprocess, provided all processes are contained within a TIBCO ActiveMatrixBusinessWorks™ module.

l 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 canbe in the same process or in an another process, provided all processinstances are part of the same job.

SharedVariable

This field appears only when the Shared Lock check box is selected.

Name of the Module Shared Variable or Job Shared Variable.



Description

Provide a short description for the Critical Section group.

Variables

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

You can select from the following available Variable Type options:

l String

l Integer

l Decimal

l Boolean

l Date&Time

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see the ActiveMatrix BusinessWorksError Codes guide.

Fault Generated When..

ActivityTimedOutException A timeout has been reached.

Local TransactionUse Local Transaction group for multiple activities to be part of a local transaction. A localtransaction group ensures that all participants of the transaction are rolled back together.A single resource performs all its transaction work.

Not all TIBCO BusinessWorks™ Container Edition activities can participate in the localtransaction.

The following core activity types have local transactional capabilities:



l JMS

l JDBC

A Local Transaction group has to be further configured as a specific type of a LocalTransaction or Transaction Transport. The Transaction Transport type determines theactivities that can participate in this local transaction group. For example, "JDBC"transaction transport only provides transaction support for certain JDBC activities.

If a Call Process activity is used within the local transaction group, then the directsubprocesses called are also part of the local transaction.

For more information about Call Process activity, see Call Process.

General


Name Description

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

TransactionTransport

The transport type. Select from the following available transactiontransport types:

l None

l JMS: To configure a JMS local transaction, select JMS as thetransaction type of the group.

l JDBC: To configure a JDBC transaction, select JDBC as thetransaction type of the group.

JMS

JMS activities participate in a transaction using the JMS local transaction. A JMS session,when specified as transacted, supports a single series of JMS operations. The localtransaction group enlists a set of produced messages and a set of consumed messages intoa unit of work. JMS local transactions use the underlying JMS sessions to group togetherall the activities that are part of the transaction group into one unit of work.

All activities using the same JMS connection are part of one transaction. If a transactiongroup contains activities that use more than one JMS connection, for example, a JMS Send



Message activity using connection 1 and another JMS Send Message activity usingconnection 2, there are two underlying transactions created.

Furthermore, activities must use the same messaging styles to be in the same transaction.

Possible deadlock situation: A deadlock situation arises if you have JMS Send Messageand Get JMS Queue Message activities performing JMS operations on the same queue. Amessage not sent out until a commit is performed, keeps Get JMS Queue Message activitywaiting indefinitely.

Important: It is recommended not to have a design that sends and receivesmessages on the same destination using the same session in a singletransaction.

When a transaction commits, its input is acknowledged and the associated output is sent.When a transaction rollback is done, all the produced messages (output stream) aredestroyed and the consumed messages (input stream) are automatically recovered. Youcan use the JMS sender activities with the JMS local transaction. At run time, theunderlying JMS activities use the same transacted JMS session to provide transactionsemantics for messages sent and received by the JMS activities.

For more information about JMS palette and activities, see JMS Palette.

JDBC

Using the JDBC transaction and multiple JDBC activities, you can access the samedatabase connection to participate in a transaction. Only JDBC activities that use the sameJDBC Connection participate in this transaction type. However, other activities can be partof the transaction group. If the transaction commits, all JDBC activities using the sameJDBC connection in the transaction group commit. If the transaction rolls back, all JDBCactivities using the same JDBC connection in the transaction group roll back.

The transaction group commits automatically, if all activities in the group complete thetransaction and a non-error transition is taken out of the transaction group. If any erroroccurs while processing the activities in the group, including errors in non-JDBC activities,it rolls back the transaction and returns an error. Individual JDBC activities can overridethe default transaction behavior and commit separately.

For more information about JDBC palette and activities, see JDBC Palette.



For EachThe For Each group is a loop element that can be used for iterating through arrayelements. The For Each activity is very useful to determine these array elementsdynamically 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.

Note: Note: Select the Global check box to make the index variableavailable for the activities outside the loop.

Start CounterValue

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

Final CounterValue

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 typein the request message.

AccumulateOutput

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

The output of the selected activity accumulates each time the activity isexecuted.

OutputActivity

Select the activity from the group of activities for an output reference whenexecuting the loop.

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



Field Description

ResetVariables

The variable to be reset during each iteration of the For Each group.

Click the Add icon, and select the variable to be reset.To delete the variable, click the variable in the Reset Variables field. The

Removeicon with a tooltip 'Remove

<variable name>'' is displayed. Click

theRemove

icon to remove the variable from theReset Variables

field.

Description

Provide a short description for the For Each activity.

Variables

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


l String

l Integer

l Decimal

l Boolean

l Date&Time

IterateAn Iterate group repeats the series of grouped activities once for every item in an existingsequence or list. The list can be items of any datatype. The loop executes for the numberof iterations specified.



This process performs the following operations:

1. A JDBC Query activity (CustomerQuery) is used to query a database and populate alist of customer records. The customer records are then passed to a group containingthe Log activity.

2. The Log activity writes the name and address of each customer to a log and appendsto the log as each record is written.

3. The group iterates once for every customer record returned by the CustomerQueryactivity.

4. The process then reads the log that was written for its data to be available to theprocess, and then transitions to a SendMail activity to send the contents of thecustomer list through email.

General


Field Description


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

Index Name The index name.




Field Description

Variable List This field is an XPath expression. XPath is used to specify the schemaelement you 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 morecomplex one and only process certain items in the list.

IterationElement

Provide a name for a process variable containing the current iterationelement in this field.

Note: Note: Select the Global check box to make the Iteration Elementavailable for the activities outside the loop.

For more information, see Call Process

AccumulateOutput


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

OutputActivity



ResetVariables

The variable to be reset during each iteration of the Iterate group.



<variable name>'is displayed. Click

theRemove


field.

Description

Provide a short description for the Iterate activity.



Variables

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


l String

l Integer

l Decimal

l Boolean

l Date&Time

RepeatThe Repeat group activity is responsible for repeating the series of grouped activities untilthe specified condition evaluates to true. The activities are always executed once beforechecking whether the condition is true. After executing the series of activities, the initialevaluation of the condition is done, and it does not repeat when the condition evaluates astrue. The Repeat activity evaluates the loop's conditional statement to determine whetheror 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.



Field Description


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

AccumulateOutput



OutputActivity



ResetVariables

The variable to be reset during each iteration of the Repeat group.



<variable name>' is displayed. Click

theRemove


field.

Description

Provide a short description for the Repeat group.

Variables

A group of shared variables. The Container displays the group. This depends on the groupselected in Group Type. For example, if the Repeat group is selected in the Group Typefield, it displays Repeat in Container. You can add multiple variables of complex or simpletype.




l String

l Integer

l Decimal

l Boolean

l Date&Time

Repeat on ErrorUsing the Repeat on Error group, you can repeat a series of activities when anunmanageable error occurs. The activities in this group are executed once. If there are nounmanageable errors, the loop terminates. If an error occurs for which there is no errortransition, the condition of the loop is evaluated. If the condition is true, the loopterminates. If the condition is false, the loop repeats until there is no error or the conditionis true.

General


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 areperformed repeatedly until the condition evaluates to false.

Description

Provide a short description for the Repeat on Error group.



Variables

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


l String

l Integer

l Decimal

l Boolean

l Date&Time

ScopeThe Scope group comprises a collection of nested activities. Scope group is shared by allthe nested activities. You can use a Scope to contain a unit of work, by making it easy tomanage, execute, and revert. For example, if a customer cancels an online order, themoney must be returned and the online order canceled, without affecting other orders. Youcan 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 Scope group.



Variables

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


l String

l Integer

l Decimal

l Boolean

l Date&Time

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

General


Field Description


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





Field Description

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

AccumulateOutput



OutputActivity



ResetVariables

The variable to be reset during each iteration of the While group.



<variable name>' is displayed. Click

theRemove


field.

Description

Provide a short description for the While group.

Variables

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


l String

l Integer



l Decimal

l Boolean

l Date&Time

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

CompensateCompensate activity is executed only from the compensation handlers when a fault isencountered outside a scope (this scope has compensation handler defined). This activitytriggers compensation handler for a scope present only on the same level. All activitiespresent in scope get executed successfully.

The compensation handlers are defined per scope. The compensation handlers of scopesthat are directly enclosed by the scope and contain Compensate activity, can be executed.The handlers execute in reverse order, so the handler of the last completed scope isexecuted first. The compensation handlers can only be defined on scope level.

General


Field Description


Description

Provide a short description for the Compensate activity.



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

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

ExitExit activity is a synchronous activity that cancels any asynchronous activities that are in awaiting state and terminate the process instance. You can specify the Name andDescription, but there is no input or output for this activity.

Get ContextThe Get Context activity retrieves the value of the specified context parameter. This isuseful if your process requires some context information from a request or a response.

The Get Context activity must be placed after the Invoke or the Receive activity.

General


Field Description


Use Shared Context Select the check box to use a job shared variable to share the context.

Shared Context This field is displayed when the Use Shared Context field is selected.Select the Go to icon to locate the required job shared variable.



Field Description

Direction This field is displayed when the Use Shared Context field is clear.Select from the following available options to specify from where thecontext information should be fetched:

l Receive Service: pulls context information from a servicerequest. Selecting this option displays the Service field.

l Return from Reference: pulls context information from areference response. Selecting this option displays the Referencefield.

l Fault from Reference: pulls context information from areference fault response.

Service/Reference Select the targeted portType and operation from where the contextinformation is to be picked.

Fault This field is displayed when Fault from Reference option is selected inthe Direction field.

Description

Provide a short description for the Get Context activity.

Output

The following is the output for the activity.

OutputItem

Datatype Description

<schema> varies The value of the context resource specified in the Directionfield on the General tab is the output for this activity. Theschema specified for the context resource determines theschema for the output.



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

Note: The Call Process activity serves a similar purpose as the Invoke activity.The Call Process activity only calls non-WSDL-based subprocesses, or directsubprocesses, and the Invoke activity only calls WSDL-based subprocesses, orservice subprocesses.

General


Field Description


Service Select the service for which to specify an operation.

Description

Provide a short description for the Invoke activity.

Advanced

The Advanced tab has the following field.

Input item LiteralValue/ModuleProperty

Description

ActivityTimeout(seconds)

Yes The Invoke activity timeout in seconds. You can eitherselect a preset timeout (Default Timeout, 30, 60,or 120seconds) or specify a custom timeout in seconds.



Input item LiteralValue/ModuleProperty

Description

Important: If the Invoke activity is configured to beDefault Timeout, then the timeout value equates to "3"minutes by default. However this default value (3minutes) can be modified to be a different value bysetting the AppSpace config.ini propertybw.engine.activity.async.waitTime.

Note: When the Invoke activity timeouts, the in-linesubprocess instance called by the Invoke activity can becancelled before the subprocess instance completes.Hence, the business logic in the cancelled processinstance may not be executed to its entirety.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the TIBCO ActiveMatrixBusinessWorks™TIBCO ActiveMatrix BusinessWorks™ Application Development guide.

Input

The following is the input for the activity.

Input item Datatype Description

inputmessage

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

Output




Outputitem


outputmessage

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

Fault




Note: When used to invoke REST service with REST reference binding, it containsadditional elements such as clientFault and serverFault.

Invoke for SOAP with HTTP

When used to invoke SOAP service, it displays the faults defined in the WSDL file along withthe following exceptions:


HTTPClientException The HTTP server responds with a message containing the4XX status code.

HTTPServerException The HTTP server responds with a message containing the5XX status code.

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

To send HTTP responses logging on the wire, set the following logger in the logback.xml file:



<logger name="org.apache.http"><level value="DEBUG"/></logger>

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

ReceiveReceive activity initiates the process execution based on the receipt of a request messagefor an operation of the process service. The Receive activity can be configured to act as aprocess starter or a signal-in activity.

General


Field Description


CreateInstance

Select this check box if you want to start a process.

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

Description

Provide a short description for the Receive activity.



Output Editor

The schema of the process variable must match the schema of the output of the activityshown on the Output tab.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the ActiveMatrix BusinessWorks ApplicationDevelopment guide.

Output

OutputItem


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.

ReplyReply activity is a synchronous activity that sends a message in response to a requestmessage that was received for an operation of a process service. This activity can be usedto 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.

ReplyWith

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

l Output Message

l Undeclared Fault - This field does not appear when the value in the Servicefield is not provided.

Description

Provide a short description for the Reply activity.

Input Editor

The schema of the process variable must match the schema of the input for the activityshown on the Input tab.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the ActiveMatrix BusinessWorks ApplicationDevelopment guide.

Input

InputItem


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



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

The Set Context activity must be placed before the Invoke or the Receive activity.

General


Field Description


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

l Invoke Reference: Selecting this option displays the Referencetab.

l Reply to Service: sends context information to a service.Selecting this option displays the Service field.

l Reply to Service with Fault: sends context information for aservice fault reply.

Use Shared Context Select the check box to use a job shared variable to share the context.

Shared Context This field is displayed when the Use Shared Context field is selected.

Select the Go to icon to locate the required job shared variable.

Service/Reference Select the targeted portType and operation where you want to supplythe context information.

Fault This field is displayed when the Reply to Service with Fault option isselected in the Direction field.

Description

Provide a short description for the activity.



Input

The following is the input for the Set Context activity.

Input Item Datatype Description

inputmessage

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

Output

OutputItem


<schema> varies The value of the context resource specified in the Directionfield on the General tab is the output for this activity. Theschema specified for the context resource determines theschema for the output.

Set EPRSet EPR activity is a dynamic alternative to the static service element defined in theWSDL.This activity determines which service to be invoked in an application.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 aresource in a SOAP header. If you use an incoming message, an EPR schema should bedefined as a part of the message in WSDL.

General




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

Note: The service name must be unique for every application.

Description

Provide a short description for the Set EPR activity.

Input


Input Item Description

SimpleEndpointReference Contains endpoint address information for the destination ofthe outgoing message

Output


Output Item Description

EndpointReference Contains the following elements:

l Address: Endpoint address

l Interface: The name of the dynamic target interface for whichthis task is supplying the service name and namespace



ThrowThe Throw activity throws the specified fault and the control is passed to any error-handling routine defined to handle the error. This activity is useful in a group or in a calledprocess. You can use this activity to catch and raise your own error conditions. The Throwactivity is useful if an error in the business logic occurs during processing.

General


Field Description


DefaultFault

This field is displayed when you use the Throw activity in a service process or aservice subprocess. Select this check box if you want the default message textand the error code for the error message.

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

FaultSchema

This field is displayed when you use the Throw activity in a direct subprocess.

Select a fault schema to send to the parent process. In a direct subprocess, faultschemas are defined on the Fault Editor tab of the End activity.

If you select the - Default - option, the $_error process variable is propagated.

Description

Provide a short description for the Throw activity.

Input Editor

Selecting the Default Fault check box displays the message and the msgCode elements inthe 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. Click on this tab to view fault schemas specifiedon the Input tab.

StartThe Start activity is the first activity, and acts as the starter activity, in a direct subprocessdefinition. A direct subprocess can be called from a parent process, and the Start activity isused to define the input expected by the process.

General


Field Description


Description

Provide a short description for the Start activity.

Output Editor

Use the Output Editor tab to define data for the subprocess to use as input. Any processthat calls this process definition must supply the data specified on the Output Editor tab.You can define your own datatype on this tab, and can reference an XML schema stored inthe project. Once defined, the data specified on the Output Editor tab becomes the output



schema of the Start activity. This data then becomes available to other activities in theprocess definition.

Tip: Tip: From the Select Schema Element Declaration window, select IncludeWSLD Inline Schemas to display inline schemas from the WSDLs in the module.

Output

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

EndThe End activity is the last activity in a direct subprocess definition. When a directsubprocess is called from another process, the direct subprocess provides output data tothe calling process. You can map data from other activities in the process to an outputschema specified on the End activity. This becomes the output of the process.

General


Field Description


Description

Provide a short description for the End activity.

Input Editor

Use the Input Editor tab to define ouput data for the subprocess. Any process that callsthis process definition receives this data after the process call completes.



You can define your own datatype on this tab, and reference an XML schema stored in theproject. Once defined, the data specified on the Input Editor tab becomes the inputschema of the End activity. You can then map data from other activities in the process tothe End activity’s input, and this becomes the output of the process when the processcompletes.

Tip: Tip: From the Select Schema Element Declaration window, select IncludeWSLD Inline Schemas to display inline schemas from the WSDLs in the module.

Input

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

Fault Editor

Use the Fault Editor tab to specify possible faults for the direct subprocess to throw.

Engine CommandThe Engine Command activity allows you to retrieve statistics and information aboutprocess definitions, process instances, and activities for the application and the appnodethat is executing the command. This activity also lets you perform job maintenance, suchas suspending and resuming the process instances.

Some commands require memory and processor overhead for gathering statistics forretrieving information on the current state of the process. Because of the performanceimplications, certain instrumentation is disabled by default.

General


Field Description

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



Field Description

CommandTo Execute

The command to execute.

ProcessDefinitionName

Certain commands accept a process definition name. This field allows you tospecify the process definition name that applies to the selected command.This field only appears when the one of the following commands is selected inthe Command to Execute field:

l GetActivityStats

l GetProcessDefinitionStats

l GetProcessInstanceInfo

l ResumeProcessStarter

l SuspendProcessStarter

Note: Note: If the Process Definition name is not defined in either theGeneral tab or in the Input field, the command is executed for allprocesses in the application.

Description

Provide a short description of the End Command activity.

Input

The input for the activity is the following.

Field Description

Name The input for this activity varies depending upon the command selected in theCommand to Execute field on the Configuration tab. For more information aboutthe input for each command, see Commands.

Output

The output for the activity is the following.



Field Description

Name The output for this activity varies depending upon the command selected in theCommand to Execute field on the Configuration tab. For more information aboutthe input for each command, see Commands.

CommandsThe following commands can be executed by the Engine Command activity.

GetActivityStats

Retrieves information about the activities that have been executed for a given processdefinition from the time the process instrumentation statistics have been turned on. Theprocess instrumentation statistics can be turned on in any of the following ways:

l using the StartStatsCollection command

l from the command line using the enablestats command

l from the Admin UI to set the Process Instrumentation propertyFor information on using the command line and the Admin UI, see Enabling and DisablingProcess Statistics in the TIBCO ActiveMatrix BusinessWorks™ Administration guide.

The activity information is cumulative. A single activity name represents all executions ofthat activity.

The ExecutionTime computation for the Call Process activity includes the sum of theexecution times for all activities in the called process, not just the execution time for theCall Process activity itself.

Note: If the Process Definition Name is not defined in either the General tab orin the Input field, the command is executed for all processes in the application.


ProcessDefinitionName string Name of the process definition.




Specifying a value for this element overrides theprocess definition specified on the General tab.

Output Item Datatype Description


ActivityName string Name of the activity.

ExecutionCount long Number of times the activity has beenexecuted.

ElapsedTime long Elapsed time of an activity is the timedifference (in milliseconds) between start timeand end time of the activity. Between the startand end time, control may get switched withother activities from the other jobs. This is thetime taken to execute an activity plus all thedelays in acquiring resources like enginethreads, JDBC connections, network, and soon.

The elapsed time includes the execution timeplus time taken for evaluating all the forwardtransitions from that particular activity andgetting the next activity ready to execute,which includes executing its input mapping ifall dependencies are met.

ExecutionTime long The Execution Time for an activity is the actualtime (in milliseconds) required by the activityto complete while using the engine thread.Asynchronous activities may use other threadsnot included in this time.

ErrorCount long Total number of executions of the activity thathave returned an error.




LastReturnCode string Status code returned by most recent executionof this activity.

MinElapsedTime long Elapsed clock time (in milliseconds) of theactivity execution that has completed in theshortest amount of elapsed time.

MaxElapsedTime long Elapsed clock time (in milliseconds) of theactivity execution that has completed in thelongest amount of elapsed time.

MinExecutionTime long Execution time (in milliseconds) of the activityexecution that has completed in the shortestamount of execution time.

MaxExecutionTime long Execution time (in milliseconds) of the activityexecution that has completed in the longestamount of execution time.

MostRecentElapsedTime long Elapsed clock time (in milliseconds) of themost recently completed activity execution.

MostRecentExecutionTime long Execution time (in milliseconds) of the mostrecently completed activity execution.

ExecutionCountSinceReset long Number of times the activity has beenexecuted since the last reset of the statistics.

GetProcessDefinitionStats

Retrieves information about process definitions. The process instrumentation statistics canbe turned on in any of the following ways:

l using the StartStatsCollection command

l from the command line using the enablestats command

l from the Admin UI to set the Process Instrumentation propertyFor information on using the command line and the Admin UI see Enabling and Disabling



Process Statistics in the TIBCO ActiveMatrix BusinessWorks™ Administration guide.



ProcessDefinitionName string Name of the process definition. Specifying a valuefor this element overrides the process definitionspecified on the General tab.



NumberCreated long Number of process instances created forthis process definition.

NumberSuspended long Number of times process instances havebeen suspended.

NumberAborted long Number of times process instances havebeen aborted.

NumberCompleted long Number of process instances that havesuccessfully completed.

TotalExecutionTime long Total execution time (in milliseconds) for allsuccessfully completed process instances.

AverageExecutionTime decimal Average execution time (in milliseconds) forall successfully completed processinstances.

TotalElapsedTime long Total elapsed time (in milliseconds) for allsuccessfully completed process instances.




AverageElapsedTime decimal Average elapsed clock time (in milliseconds)for all successfully completed processinstances.

MinElapsedTime long Elapsed clock time (in milliseconds) of theprocess instance that has completed in theshortest amount of elapsed time.

MaxElapsedTime long Elapsed clock time (in milliseconds) of theprocess instance that has completed in thelongest amount of elapsed time.

MinExecutionTime long Execution time (in milliseconds) of theprocess instance that has completed in theshortest amount of execution time.

MaxExecutionTime long Execution time (in milliseconds) of theprocess instance that has completed in thelongest amount of execution time.

MostRecentExecutionTime long Execution time (in milliseconds) of the mostrecently completed process instance.

MostRecentElapsedTime long Elapsed clock time (in milliseconds) of themost recently completed process instance.

NumberCompletedSinceReset long Number of process instances that havecompleted since the last reset of thestatistics.

GetProcessInstanceInfo

The values of the input elements for this command specify for which process instances youwant to retrieve information. If you specify more than one input element, the values aretreated as an AND condition. For example, If you specify the process definition name andthe minimum duration, information for process instances for the specified processdefinition that meet the minimum duration time is returned.





ProcessId string ID for the process instance.

ProcessDefinitionName string Name of the process definition. Specifying a valuefor this element overrides the process definitionspecified on the General tab.

MinimumDuration string Minimum time (in milliseconds) in elapsed clocktime since the process instance started. All processinstances with greater elapsed times are retrieved.




Status string Status of the process.

StartTime string Time (in milliseconds) when the processinstance started.

ElapsedTimeSinceStarted long Elapsed clock time (in milliseconds) since theprocess instance started.

MainProcessName string Name of the main process definition. If theprocess is a regular process, or a spawnedsubprocess, the name of the process is returned.If the process is an in-line subprocess, the nameof the root process that initiated the subprocesscall is returned.




ParentProcessName string Name of the parent process. If the process is aregular process, or a spawned subprocess, theparent process name is null. If the process is aninline-subprocess, the name of the immediateparent process is returned.

SubProcessName string Name of the subprocess. If the process is aregular process, or a spawned subprocess, thesubprocess name is null. If the process is aninline-subprocess, the name of the subprocess isreturned.

GetProcessStarterStats

Retrieves information about either active or inactive process starters. The information iscumulative. A single process starter name represents all executions of that process starter.


ProcessName String Name of the process definition.

NumberCreated integer Number of process instances created by thisprocess starter.

NumberCompleted integer Number of process instances that havecompleted.

NumberRunning integer Number of process instances currentlyexecuting.

NumberCreatedPerHour integer Number of process instances per hour createdby this process starter.

StartTime String Time at which the process starter was started.

ElapsedTimeSinceStarted integer Elapsed clock time since the process starter




was started.

ProcessStarterName String Name of the process starter. It is of the formprocessName+ProcessStarterName

Status String Status of the process starter. The status can beCANNOT_START, STARTED, or STOPPED.

RestartedFromCheckpoint boolean True if the process was restarted from acheckpoint.

GetRecoverableProcesses

Retrieves the process instances that can be recovered. Use the returned process ID in theRestartRecoverableProcess or RemoveRecoverableProces commands.




Status string Status of the process.

KillProcessInstance

Kills the specified process instance. The process instance is stopped immediately andpermanently removed from the engine.


ProcessId string Process ID of the process instance you want to kill.



RemoveRecoverableProcess

Removes the specified recoverable process instance from the list of potential recoverableprocesses. After executing this command, the checkpoint data of the specified processinstance is removed and the process instance can no longer be recovered.


ProcessId string Process ID of the checkpointed process instance you want toremove.

Obtain the process ID of the recoverable process with theGetRecoverableProcesses command.

RestartRecoverableProcess

Restarts the specified recoverable process instance.


ProcessId string Process ID of the checkpointed process instance you want torestart.

Obtain the process ID of the recoverable process with theGetRecoverableProcesses command.

ResumeProcessInstance

Resumes the specified process instance.


ProcessId string Process ID of the process instance you want to resume.

ResumeProcessStarter

Resumes the specified process starter.



Note: If the Process Definition Name is not defined in either the General tab orin the Input field, the command is executed for all process starters in theapplication.


ProcessDefinitionName string The name of the process definition whose processstarter you want to resume.


StartStatsCollector

Enables process instrumentation statistics for the application in the current appnode.

StopStatsCollector

Disables process instrumentation statistics for the application in the current appnode.

StopApplication

Gracefully stops the application.

SuspendProcessInstance

Suspends the specified process instance.


ProcessId string Process ID of the process instance you want to suspend.

SuspendProcessStarter

Suspends the specified process starter.



Note: If the Process Definition Name is not defined in either the General tab orin the Input field, the command is executed for all process starters in theapplication.


ProcessDefinitionName string The name of the process definition whose processstarter you want to suspend.



102 | File Palette

File PaletteThe File palette is used to read, write, delete, or create files. You can use the processstarter present in this palette to poll for files and start a process based on the available file.

Copy FileThe Copy File is a synchronous activity that you can use to copy files and directories to anew location.

General


Field Literal Value/ProcessProperty/ModuleProperty

Description

Name None The name to be displayed as the label of the activityin the process.

FromFilename

Yes The path and name of the file or directory to copy.

For directories, you must specify an absolute path.You may use wildcards when specifying files within adirectory.

For example, to copy a directory, specifyc:\myDirectory. To copy all text files in a directory,specify c:\myDirectory\*.txt.

To Filename Yes The destination for the copy operation. This must be


103 | File Palette


Description

an absolute path.

Do not use wildcard characters in this element.

Overwrite Literal Value Select this check box to overwrite the existing filewith the same name, if it exists.

The activity raises an exception if the specified file ordirectory exists and this check box is not selected.

Create Non-ExistingDirectories

Literal Value When this check box is selected, the activity createsall directories in the specified path, if they do notalready exist.

If this check box is not selected with non-existingone or more directories in the specified path, itdisplays an exception.

Include Sub-Directories

Literal Value Includes all sub-directories in the source directory,when the source to copy is a directory.

Description

Provide a short description for the Copy File activity.

Input



fromFileName string The path and name of the file or directory to copy.

For directories, specify an absolute path. You may usewildcards when specifying files within a directory. For


104 | File Palette


example:

l To copy a directory, specify c:\myDirectory.

l To copy all text files in a directory, specifyc:\myDirectory\*.txt.

toFileName string The destination for the copy operation. This must be anabsolute path and wildcards cannot be used in thiselement.

Note: The Input field always takes precedence for all File palette activities withrespect to the field equivalent on the General tab.

Fault



FileNotFoundException The file does not exist. The source file or the destination is notfound and the Create Non-Existing Directories check box isnot selected on the General tab.

IllegalCopyException The destination exists but its type is different than the type ofthe specified source.

For example, in the activity input, fromFileName is a directoryand toFileName is a file.

FileAlreadyExistsException The file already exists at the destination where you areattempting to copy the file and the Overwrite field is notselected on the General tab.


105 | File Palette


FileIOException There is an input/output error. For example, the file ordirectory already exists and it is write-protected.

Remove FileThe Remove File activity is a synchronous activity that removes the specified files from thedirectory. If the specified directory is not empty, it generates an exception.

General


Field Literal Value/ ProcessProperty/ Module Property

Description

Name None The name of the file to be displayed as thelabel of the activity in the process.

FileName Yes The path and name of the file to be removedfrom the directory.

IncludeTimestamp

None Select the check box to display timestamp,in addition to the date.

Description

Provide a short description of the Remove File activity.

Input



106 | File Palette


fileName string The path and name of the file to be removed from the directory.

Output



fileInfo complex This element contains the fullName, fileName,location, type, readProtected, writeProtected, size,and lastModified data.

fullName string The name of the file (or empty directory) and the filepath information.

fileName string The name of the file (or empty directory) without filepath information.

location string The path to the file or the empty directory.

ConfiguredFileName string An optional element. This element is not populatedby this activity.

type string The file type.

readProtected boolean Signifies whether the file or (or empty directory) isprotected from reading

writeProtected boolean Signifies whether the file or (or empty directory) isprotected from writing

size integer The size of file in bytes.

lastModified string The timestamp indicating when the file was lastmodified.


107 | File Palette

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action, see the ActiveMatrix BusinessWorks Error Codesguide.


FileNotFoundException The file does not exist.

FileIOException An input/output exception occurs, when trying to remove the fileor empty directory.

Create FileThe Create File is a synchronous activity that creates a new file or directory with thespecified name at specified location.

General



Description

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

Filename Yes The path and name of the file to create.

Select the Is a Directory check box on the Generaltab to specify the name of the directory to create.

Overwrite None Overwrites the existing file with the same name, if itexists.


108 | File Palette


Description

The activity throws an exception, if the specified fileexists and this check box is not selected.

Is a Directory None When this check box is selected, the activity createsa directory instead of a file.


None When this check box is selected, the activity createsall directories in the specified path, if they do notalready exist.

If this check box is not selected and one or moredirectories in the specified path do not exist, itthrows an exception.

IncludeTimestamp

None Select the check box to display timestamp, inaddition to the date.

Description

Provide a short description for the Create File activity.

Input



fileName string The path and name of the file to create.

Select the Is a Directory field check box on the General tab tospecify the name of the directory to create.

Output



109 | File Palette


fileInfo complex The element containing fullName, fileName,location, configuredFileName, type, readProtected,writeprotected, size, and lastModified

fullName string The name of the file or directory, including the pathinformation

fileName string The name of the file or directory without the pathinformation

location string The path to the file or directory

configuredFileName string This element is optional and it is not populated bythis activity

type string The type of the file

readProtected boolean Signifies whether the file or directory is protectedfrom reading

writeProtected boolean Signifies whether the file or directory is protectedfrom writing

size integer The size of the file (in bytes)

lastModified string The time stamp indicating when the file was lastmodified

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action, see the TIBCO ActiveMatrix BusinessWorks™Error Codes guide.


110 | File Palette


FileAlreadyExistsException The file already exists at the destination where you areattempting to copy the file. The Overwrite check box is notselected on the General tab.

FileIOException There is an Input/Output error. For example, the file ordirectory already exists and is write-protected.

File PollerThe File Poller activity is a process starter activity that polls for files or directories with thespecified name and starts a process, when a change (creation, modification, or deletion) isdetected.

General


Field LiteralValue/ProcessProperty/ModuleProperty

Description

Name None The name to be displayed as the label for the activityin the process.

Filename Yes The path and name of the file or directory to monitor.

You can also use wildcard characters to monitor adirectory for files that match the providedspecification. For example, C:\files\*.log must match anychange to a file in the files directory with an extensionof .log.

PollingInterval(sec)

Yes The polling interval (in seconds) to check for thespecified file.


111 | File Palette


Description

IncludeExisting Files

None Check for the specific file among the files that existedbefore the process engine starts.

l When selected - the existing file matching thespecification in the Filename field creates anew process instance, when a process enginestarts.

l When not selected - any existing file matchingthe specification in the Filename field isignored, unless there is a change in the file.

Exclude FileContent

None Specifies not to load the data from the file into thisactivity’s output. If selected, the contents of the fileare not available to the subsequent activities in theprocess.

Content as Yes The type of content in the file which can be eitherText or Binary. This field is available only when theExclude File Content check box is not selected.

Encoding Yes The character encoding for the file (when Text isspecified in the Content as field). This field is visibleonly when Content as value is set to Text.

IncludeTimestamp

None Select the check box to display timestamp, in additionto the date.

Description

Provide a short description of the File Poller activity.

Advanced

The Advanced tab has the following fields.


112 | File Palette

Field Description

SequenceKey

This field can contain an XPath expression that specifies which processesshould run in order. Process instances with sequencing keys that evaluate tothe same value are executed sequentially in the order the process instancewas created.

Custom JobId

This field can contain an XPath expression that specifies a custom ID for theprocess instance.

Poll forCreateEvents

Select this check box to start a new process when a file or directory matchingthe specification in the Filename field is created.

If not selected, the newly created files or directories are ignored.

Poll forModifyEvents

Select this check box to start a new process when a file or directory matchingthe specification in the Filename field is modified.

If not selected, the modifications to the files or directories are ignored.

Poll forDelete Events

Select this check box to start a new process when a file or directory matchingthe specification in the Filename field is deleted.

If not selected, deletions of files or directories are ignored.

Include Sub-Directories

Select this check box to enable monitoring of the events that occur insubdirectories of the specified directory.

If not selected, only the directory is monitored and subdirectories are ignored.

Mode Select the type of polling to perform from the following modes in the drop-down list:

l Only Files: only tracks the specified changes for files.

l Only Directories: only tracks the specified changes for directories.

l Files and Directories: tracks the specified changes for both files anddirectories.

Sort by Specifies the order in which the files should be processed, if more than onefile is detected. You can sort by File Name, Date Modified, or None.


113 | File Palette

Field Description

The files are processed as the polling interval occurs. Hence, the Sort By fieldapplies to all files that have changed since the last polling interval. The field isuseful for processing the files in a specific order when the process enginestarts and the Include Existing Files field is selected (then all existing files areprocessed in the specified order).

Note: The File Poller activity starts process instances based on thespecified Sort By order, but the process instances may not complete in thesame order. If you want to guarantee that processes start and complete ina specified order, specify Max Jobs = 1, and set the engine persistencemode to group or datastore.

Sort Order Specifies whether the order specified in the Sort By field is Ascending orDescending. This field is only applicable if the Filename or Date Modified isselected in the Sort By field.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the TIBCO ActiveMatrixBusinessWorks™TIBCO ActiveMatrix BusinessWorks™ Application Development guide.

Output


Output item Datatype Description

action string The occurred event to trigger the File Poller activity.The possible values are: create, remove, or modify.

timeOccured integer The time when the File Poller activity detected thechange in the file.

The time is defined as the amount of time in


114 | File Palette


milliseconds. For example, since midnight, January 1,2013 UTC.

fileInfo complex This element contains the fileName, location, type,readProtected, writeProtected, and size data.

fullName string The name of the file, including the path information.

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

location string The path to the file.

configuredFileName string The name of the file or directory this activity isconfigured to operate on.




size integer The size of the file in bytes.


fileContent complex The element containing the textContent andbinaryContent data.

textContent string The content of the file (text files), if the Exclude FileContents check box is not selected on the Generaltab.

binaryContent binary The content of the file (binary files), if the ExcludeFile Contents check box is not selected on the


115 | File Palette


General tab. Only available only if type is set tobinary.

encoding string The character encoding for the file. This field ispresent only if Content as field is set the value asText.

List FilesThe List Files activity is a synchronous activity that returns information about files ordirectories, or a listing of all the files in the specified directory.

General



Description


Filename Yes The path and name of the file or directory to monitor.

You can also use wildcard characters to monitor adirectory for files that match the providedspecification. For example, C:\files\*.log must match anychange to a file in the files directory with an extensionof .log.

Mode None The type of listing you want to retrieve. You can selectfrom the following options:


116 | File Palette


Description

l Only Files

l Only Directories

l Files and Directories

IncludeTimestamp


Description

Provide a short description for the List Files activity.

Input



fileName string The path and name of the directory with files or subdirectoriesto list. Providing a file or directory name returns the informationabout that file or directory. You can use wildcards to list files ordirectories that match the provided specification. For example:

l C:\files\*.log lists any file in the files directory that have a .logextension.

l C:\files\mylogs\*.* lists all files in the directory mylogs.

Output

The following is the output of the activity.


117 | File Palette


fileInfo complex Element containing the fullName, fileName,location, configuredFileName, type, readProtected,writeProtected,size, and lastModified data.

This is a repeating element. Each item in the elementis a file or directory included in the specified directorymatching the provided criteria.


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

location string The name of the file or directory this activity isconfigured to operate on.

configuredFileName string The path to the file.

type string The type of the file.




lastModified string The timestamp indicating when the file was lastmodified. You can compare values in this elementusing the compare-dateTime() XPath function.

For example, compare-dateTime($List-Files/ListFilesActivityOutput/files/fileInfo[fileName="myFile.txt"]/lastModified,current-dateTime())


118 | File Palette

Fault



FileNotFoundException The file does not exist and the specified path is either incorrect ornot found.

Read FileThe Read File activity is a synchronous activity that is used to read a file and place itscontents into the output of the activity.

General



Description


Filename Yes The name of the file.

Exclude FileContent

None Specifies not to load the data from this file intothe output of the activity.

If selected, the contents of this file are notavailable to the subsequent activities in theprocess.

Read as Literal Value This field is available only if the Exclude File


119 | File Palette


Description

Content check box is not selected.

The type of the content in the file. It can beeither Text or Binary.

IncludeTimestamp

None Select the check box to display timestamp, inaddition to the date.

Description

Provide a short description for the Read File activity.

Input

The following is the input of the activity.


fileName string The name and path of the file to read.

encoding string The character encoding of the text files.

This element is available only when the Read as field on theGeneral tab is set to Text.

You can specify the encoding names supported by Java in thiselement. If this element is not specified, the default encoding ofthe Java Virtual Machine used by the process engine is used.

Output



120 | File Palette


fileInfo complex This element contains fullName, fileName, location,type, readProtected, writeProtected, size, andlastModified data.

fullName string The name of the file with the path information.



configuredFileName string An optional element. It is not populated by thisactivity.






fileContent complex The element containing the textContent data.

textContent string The content of the file (text files), if the Exclude FileContent check box is not selected on the Generaltab.

binaryContent binary The content of the file (binary files), if the ExcludeFile Content check box is not selected on theGeneral tab. Only available when Content as is set toBinary.


121 | File Palette


encoding string The character encoding for the file when the valuespecified in the Read as field in the General tab isText.

Fault




UnsupportedEncodingException The content of the text file is invalid, and the content ofthe file is read into the process data.

FileIOException An input/output exception occurred when trying to readthe file.

Rename FileThe Rename File activity is a synchronous activity that is used to rename or move files.This activity can also rename directories. However, you cannot use this activity to move thedirectory to a new location.

General

The General tab consists of the following fields.


122 | File Palette


Description

Name None The name to be displayed as a label of the activity inthe process.

FromFilename

Yes The path and name of the file to rename or move, orthe path and name of the directory to rename.

The value in this element must be an absolute path.

To Filename Yes The new name and location of the file or directory.The files can be moved to a new location, but thedirectory location remains unchanged.

The value of this element must be an absolute path.

Overwrite None Select this check box to overwrite the existing file withthe same name when renaming or moving.

If not selected, the activity raises an exception, if thespecified file or directory exists.


None When this check box is selected, the activity createsall directories in the specified path, if they do notalready exist.

If not selected and one or more directories in thespecified path do not exist, it throws an exception.

IncludeTimestamp


Description

Provide a short description for the Rename File activity.

Input



123 | File Palette


fromFileName string The path and name of the file to rename or move, or thepath and name of the directory to rename.

The value in this element must be an absolute path.

toFileName string The new name and location of the file or directory. The filescan be moved to a new location, but the directory locationremains unchanged.

The value of this element must be an absolute path.

Output



fileInfo complex This element contains the fullName, fileName,location, type, readProtected, writeProtected, size,and lastModified data.

fullName string The name of the file (or directory) including the pathinformation.

fileName string The name of the file (or directory) without the pathinformation.

location string The path to the file or the directory.

configuredFileName string An optional element. This element is not populatedby this activity.




124 | File Palette



size integer The size of file in bytes.


Fault




IllegalRenameException The destination file exists and its type is different than thetype of the source file.

FileAlreadyExistsException The file already exists.

FileIOException An input/output exception occurred when trying to renamethe file or directory.

This exception is also encountered while attempting to move adirectory.

Write FileThe Write File activity is a synchronous activity that writes content to the specified file.

General



125 | File Palette


Description


Filename Yes The path and name of the file.

Wildcards are not permitted in this field.

Append None Appends the contents to an existing file. Not selectingthis check box overwrites the file.

Write as Literal Value Specify whether Text or Binary.


None When selected, the activity creates all directories inthe specified path, if they do not already exist.

If this check box is not selected with one or more non-existing directories in the specified path, it throws anexception.

Compress None This field specifies whether to compress the outputfile using GZip format. Specify None for nocompression or GZip for a compressed output file.

When you specify GZip for this field, rename the file touse the .gz suffix and use gunzip to decompress thefile.

IncludeTimestamp


Description

Provide a short description for the Write File activity.

Input



126 | File Palette


fileName string The path and name of the file.


textContent string The contents of the file (text files). This field is presentwhen Write as is set to Text. When Write as is set toBinary, this field is replaced by the fieldbinaryContent.

addLineSeparator boolean This specifies whether to add a carriage return aftereach input line. This field is present when the value ofthe Write as field on the General tab is set to Text.

encoding string The character encoding for text files.

This element is available only when Text is specified inthe Write as field on the General tab.

You can specify encoding names supported by Java inthis element. If this element is not specified, the defaultencoding of Java Virtual Machine is used.

Output



fileInfo complex This element contains the fileName, location, type,readProtected, writeProtected, and size data.




configuredFileName string An optional element. This element is not populated


127 | File Palette


by this activity.






Fault




UnsupportedEncodingException The encoding is not valid.

FileIOException An input/output exception occurs when trying to write tothe file.


128 | Cloud FTL Palette

Cloud FTL PaletteTIBCO Cloud™ Integration applications can use the Cloud FTL palette to send and receivemessages. The messaging capability is powered by TIBCO FTL and comes pre-configuredfor all users. Refer to the TIBCO FTL Concepts manual to understand general FTL concepts.

Note: Applications built using Cloud FTL Palette activities cannot run in debugmode in TIBCO Business Studio for BusinessWorks. Cloud FTL provides a zero-configuration experience such that you can directly deploy the applications inTIBCO® Cloud Integration and start publishing and subscribing messages usingCloud FTL.

Important:l Publishers and subscribers of a message must reside within the same

sandbox in order to be able to send and receive messages.

l Publishers and subscribers of a message must reside in separateapplications.

l If you move an application to another sandbox, the application will getrestarted.

l If you scale up an FTL-enabled application, the message will be broadcastand received to all instances of the application. For example, if you scaleup the subscriber application, the published message will be received byall the subscribers.

l The Cloud FTL feature, which enables BusinessWorks apps in a sandbox touse the Cloud FTL palette for inter-app communication, is no longerturned on by default. You must enable this at sandbox creation, with anoption on the Create Sandbox dialog box; it cannot be enabled later.

Accessing the Cloud FTL PaletteThe Cloud FTL palette is a separate connector, which must be installed after you haveinstalled the TIBCO Business Studio™ for BusinessWorks™. Download the connector



binaries from http://update.tibco.com/eclipse/bw/<BW_version> site.

Follow the instructions in the "Installation" topic under Connectors for TIBCO BusinessStudio™ for BusinessWorks™ section for instructions to install the connector. In the AvailableSoftware dialog, select TIBCO ActiveMatrix BusinessWorks(TM) Plug-in for FTL <plug-in_version> as shown below:

Note: The TIBCO ActiveMatrix BusinessWorks™ Plug-in for FTL <plug-in_version> contains the binaries for both the TIBCO ActiveMatrix BusinessWorks™Plug-in for FTL® and TIBCO ActiveMatrix BusinessWorks™ Plug-in for Cloud FTL.You must configure TIBCO Business Studio™ for BusinessWorks™ in order todisplay the Cloud FTL palette.

Configuring TIBCO Business Studio™ for BusinessWorks™ to Display theCloud FTL Palette

After installing the TIBCO ActiveMatrix BusinessWorks™ Plug-in for Cloud FTL connector,follow these steps to configure TIBCO Business Studio™ for BusinessWorks™ to display theCloud FTL palette:



If you have an existing project, follow these steps:

1. In TIBCO Business Studio™ for BusinessWorks™ right-click the project name.

2. Select Configure > Configure Deployment Target.

3. Select only the Tibco Cloud deployment target.

Important: Make sure that no other deployment targets are selected otherthan Tibco Cloud.

4. Click OK.The Cloud FTL palette should now appear in the palettes pane.

If you are creating a new project, select only the Tibco Cloud deployment target in thefollowing dialog:



Important: Make sure that no other deployment targets are selected other thanTibco Cloud.

Modifications to Enable an FTL Connection

To enable an FTL connection:

Mac:

1. Add the following text to the TIBCOBusinessStudio.ini file: -Djava.library.path=<FTL_INSTALL_LOCATION>/ftl/<FTL_VERSION>/lib

2. Add the following text to the VM arguments: -Djava.library.path=<FTL_INSTALL_LOCATION>/ftl/<FTL_VERSION>/lib

3. Restart Studio and test connection.Alternatively, add the following entry to the DYLD_LIBRARY_PATH environment variable inthe debug configuration: <FTL_INSTALL_LOCATION>/ftl/<FTL_VERSION>/lib

Windows:

1. Open the Run Configuration.

2. Find the path value in the Environment section.

3. In the path variable, add a colon after the FTL_HOME/bin value.

Replace this:

${env_var:FTL_HOME}/bin

With this:

${env_var:FTL_HOME}/bin:

4. Restart Studio and test the connection.

Cloud FTL PublisherCloud FTL Publisher is a synchronous activity that publishes (sends) a message over atransport. The transport details are pre-configured in TIBCO FTL Realm Server running inTIBCO® Cloud Integration.



General



Description

Name No The name to be displayed as label of the activity in theapplication.

Format No Defines the set of fields in the message that is sent by the FTLPublisher activity. The form of each FTL message (its fieldnames and their value datatypes) is governed by a format.The supported formats are:

l Custom: can be defined by using the Input Editor. TheInput Editor is enabled only for the Custom formatoption.

l Keyed Opaque: is a built-in format that contains a textkey field and a binary (opaque) data field.

l Opaque: is a built-in format that contains a binary(opaque) data field.

FormatName

Yes The name of the Custom format.

This field is displayed when the Custom format is selected.

Description

Provide a short description of the activity here.

Input Editor

The Input Editor gets enabled only when Custom format is chosen in the General tab. Theschema must match the schema of the input for the activity shown on the Input tab.




MessageType complex The message type used in the application.

From the Schemas folder, drag the Message : MessageTypeelement on to the process editor.

Input

The input for the activity depends on the Format you select in the General tab. If youselect the Custom format, the input is a data element defined in the Input Editor tab.

Fault

The Fault tab lists the possible exceptions thrown by this activity.

Fault Thrown when...

FTLPublisherActivityFault FTL Publisher fails to publish a message due to a runtime error.

FTLCreateMessageFault The FTL message could not be created.

FTLSendMessageFault The FTL message could not be published.

Cloud FTL ReplyCloud FTL Reply is a synchronous activity that can send reply to message receivedthrough the Cloud FTL Subscriber activity.

General




Field Description

Name The name to be displayed as label of the activity in the application.

Reply For Specifies the Cloud FTL Reply message for Cloud FTL Subscriber.

Format Defines the set of fields in the message that is sent by the Cloud FTL Replyactivity. The form of each FTL message (its field names and their value datatypes)is governed by a format. The supported formats are:

l Custom: can be defined by using the Input Editor. The Input Editor isenabled only for the Custom format option.

l Keyed Opaque: a built-in format that contains a text key field and a binary(opaque) data field.

l Opaque: a built-in format that contains a binary (opaque) data field.

FormatName

The name of the Custom format.


Description


Input Editor

The Input Editor gets enabled only when you select Custom format in the General tab.The schema must match the schema of the input for the activity shown on the Input tab.


MessageType complex The message type used in the application.

From the Schemas folder, drag the Message : MessageTypeelement on to the process editor.



Input

The input for the activity depends on the Format chosen by the user in the General tab. Ifyou select the Custom format, the input is a data element defined in the Input Editor tab.

Fault


Fault Thrown when...

FTLReplyActivityFault The FTL Reply activity fails to reply due to a runtime error.

FTLCreateReplyMessageFault The FTL reply message could not be created.

FTLSendReplyMessageFault The FTL reply message is not published.

Cloud FTL Request ReplyCloud FTL Request Reply is an asynchronous activity that is used to send a request to anFTL application and wait for a response.

General



Description

Name No The name to be displayed as label of the activity in theapplication.

RequestFormat

No Defines the set of fields in the message that is sent by theCloud FTL Request Reply activity. The form of each FTLmessage (its field names and their value datatypes) is




Description

governed by a format. The field is pre-set to Custom and canbe defined by using the Input Editor.

RequestFormatName


ReplyFormat

Yes Defines the set of fields in the message that is sent by theFTL Request Reply activity. The form of each FTL message(its field names and their value datatypes) is governed by aformat. The supported formats are:

l Custom: can be defined by using the Input Editor.The Input Editor is enabled only for the Customformat option.

l Keyed Opaque: is a built-in format that contains a textkey field and a binary (opaque) data field.


ReplyFormatName



Description


Advanced





Description

ActivityTimeout(msec)

Yes It is the amount of time Cloud FTL Request Replyactivity waits to get the reply from the Cloud FTLSubscriber.

Note: Note: When the Cloud FTL Request Replyactivity timesout, the in-line subprocess instancecalled by the Cloud FTL Request Reply activity canbe cancelled before the subprocess instancecompletes. Hence, the business logic in the cancelledprocess instance may not be executed to its entirety.

Input Editor

The Input Editor gets enabled only when Custom format is chosen in the General tab. Theschema must match the schema of the input for the activity shown on the Input tab.

Output Editor

The Output Editor tab defines the schema to use for reply messages. This tab gets enabledonly when you select the Custom format.

Input

The input for the activity depends on the Format you select in the General tab. If youselect Custom format, the input is a data element defined in the Input Editor tab.

Output

Shows the output reply message. The output reply message depends on the format youselect in Reply Format with the message metadata and reply message.

Fault




Fault Thrown When...

FTLRequestReplyActivityFault The Cloud FTL Request Reply activity fails due to aruntime error.

FTLCreateRequestMessageFault The FTL request message could not be created.

FTLSendRequestMessageFault The FTL request message could not be published.

FTLProcessReplyMessageFault The FTL reply message could not be processed.

ActivityTimedOutException The timeout is reached.

Cloud FTL SubscriberCloud FTL Subscriber is a process starter activity that starts the process based on thereceipt of a message over a transport. The transport details are pre-configured in TIBCOFTL Realm Server running in TIBCO® Cloud Integration.

General



Description

Name No The name to be displayed as the label of the activity inthe application.

ContentMatcher

Yes Specifies Cloud FTL Subscriber activity's interest inmessages based on their content. The syntax for exampleis, {"My-Long":123}.

A content matcher selects a subset of messages from amessage stream according to the fields and values in




Description

those messages.

Format No Defines the set of fields in the message that is sent by theFTL Publisher activity. The form of each FTL message (itsfield names and their value datatypes) is governed by aformat. The supported formats are:

l Custom: can be defined by using the Input Editor.The Input Editor is enabled only for the Customformat option.

l Keyed Opaque: is a built-in format that contains atext key field and a binary (opaque) data field.


FormatName

Yes The name of the format of the Cloud FTL Subscribermessage. This field is visible only when the Customformat is selected.

Description


Advanced



Description

Sequence No This field can contain an XPath expression that




Description

Key specifies which processes should run in sequence.Process instances with sequencing keys that evaluateto the same value are executed sequentially as theprocess instance was created.

Custom JobId

No This field can contain an XPath expression thatspecifies a custom ID for the process instance.

FTL QueueDispatcherThreads

Yes Specifies the number of threads to use for dispatchingevents from the FTL event queue.

FTL QueueSize

Yes Size of FTL event queue.

FTL QueueOverflowPolicy

Yes This field is enabled when the queue size is greaterthan zero. It is pre-set to Discard None.

ActivityWorkerThreads

Yes Must be greater than zero. By default, the equivalent ofhalf of the TIBCO® Cloud Integration engine threadpool is created.

For example, if the engine thread pool is eight, thenthe Cloud FTL Subscriber activity creates four threadsfor processing the incoming FTL message.

Output Editor

The Output Editor tab defines the schema to use for incoming messages. This tab getsenabled only when you select the Custom format.

Output

The output for the activity depends on the Format you select in the General tab. If youselect the Custom format, the output is a data element defined in the Output Editor tab.


141 | FTP Palette

FTP PaletteThe FTP palette is used to issue FTP commands.

FTP Change Default DirectoryFTP Change Default Directory is a synchronous activity that changes the current defaultdirectory on the remote machine to the specified directory path.

General


Field LiteralValue/ModuleProperty/ProcessProperty

Description


FTPConnection

Yes The path to the shared configuration resourcecontaining the user information such as host name,port, username, and password.

Quit (post-command)

None Select this check box to specify that the FTPconnection should be closed after completing thiscommand.

The FTP Connection remains open, if this check boxin not selected. As a result, all the FTP activities thatspecify the same FTP session (that is, the same host,port, username, and password), share the FTP sessionuntil the connection is closed.


142 | FTP Palette

Description

Provide a short description of the FTP Change Default Directory activity.

Input

The Input tab has the following fields.


Host string The name of the FTP server.

This overrides the value specified in the FTP Connectionproperty.

Port integer The port number for incoming FTP requests on the FTPserver.


Username string The username for logging into the FTP server.


Password string The password for logging into the FTP server.


NewDefaultDir string The path to the new default directory on the FTP server.

Timeout integer The amount of time to wait for the FTP server to respond.This timeout is used, when the FTP server places the FTPconnection used by this activity into a waiting state.



143 | FTP Palette

Output

This activity produces no output.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective actions to take, see the ActiveMatrix BusinessWorksError Codes guide.


CommandExecutionException An error occurred while executing the FTP command.

ConnectionErrorException An error occured while connecting to the FTP server.

FTP Delete FileFTP Delete File is a synchronous activity that issues an FTP delete or mdelete command todelete one or more files from the remote server.

General



Description

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

FTPConnection

Yes The path to the shared configuration resource containingthe user information such as host name, username, andpassword.


144 | FTP Palette


Description

Quit (post-command)

None Select this check box to specify that the FTP Connectionshould be closed after completing this command.

The FTP connection remains open, if this check box innot selected. As a result all the FTP activities that specifythe same FTP session (that is, the same host, port,username, and password), share the FTP session until theconnection is closed.

Description

Provide a short description of the FTP Delete File activity.

Input







UserName string The username for logging into the FTP server.




145 | FTP Palette



RemoteDirectory string An optional element. The path to the directorycontaining the files to be deleted.

This element is concatenated with the RemoteFileNameelement to provide the complete path to the files to bedeleted.

RemoteFileName string The path and name of the file to delete on the remoteserver. This field permits wildcards (? for any onecharacter, * for one or more characters).

You can specify an absolute or relative path for theremote file name. Relative paths are relative to the pathspecified in the RemoteDirectory element or in the user’shome directory, if RemoteDirectory is null.

Timeout integer This timeout is used, when the FTP server places the FTPConnection used by this activity, into a waiting state.

Output


Fault



CommandExecutionException An error occurred when executing the FTP command.

ConnectionErrorException An error occurred when connecting to the FTP server.


146 | FTP Palette

FTP DirFTP Dir is a synchronous activity that provides a sequential list of files in the specifieddirectory of the FTP server.

General

The Genaral tab has the following fields.


Description


FTPConnection

Yes The path to the shared configuration resourcecontaining the user information such as host name,username, and password.

Quit (post-command)


The FTP connection remains open, if this check box innot selected. As a result, all FTP activities that specifythe same FTP session (that is, the same host, port,username, and password), share the FTP session untilthe connection is closed.

NLST None Selecting this check box specifies to use the NLSTcommand instead of the DIR command.

The DIR command produces verbose output includingthe file size, modification time, and permissions.

NLST produces only a list of file names.


147 | FTP Palette

Description

Provide a short description of the FTP Dir activity.

Input





Port integer The port number for the incoming FTP requests on the FTPserver.






DirParameters string The command parameters to pass to the DIR or NLSTcommand.

Directory string An optional parameter. The path to the directory in whichyou want to list the files.

If null, the current remote directory is listed.

Timeout integer The amount of time to wait for the FTP server to respond.This timeout is used, when the FTP server places the FTPconnection used by this activity into a waiting state.


148 | FTP Palette



Output



ItemCount integer The number of entries returned from the remote directorylisting.

DirectoryItems string A repeating element containing the list of items returned.

Fault



CommandExecutionException An error occurred while executing the FTP command.

ConnectionErrorException An error occured while connecting to the FTP server.

FTP GetFTP Get is a synchronous activity that issues an FTP get or mget command to the specifiedserver. The content of the remote files can be placed in the output of the activity or writtendirectly to the local storage. If you select to place the contents of a remote file into theoutput of the activity, you can only retrieve one remote file (FTP get command) and thefile’s content is stored in memory as part of the output of the activity. If you write the


149 | FTP Palette

contents of the retrieved files to the local storage, you can retrieve one or more files (FTPget or mget commands).

General



Description


FTPConnection


Quit (post-command)


The FTP connection remains open, if this check box innot selected. All the FTP activities that specify thesame FTP session (that is, the same host, port,username, and password), can share the FTP sessionuntil the connection is closed.

Use ProcessData

None Specifies to write contents of the file retrieved fromthe FTP server to the process data.

The output of the activity includes an element thatcontains the remote file’s contents, and the data canbe used by subsequent activities in the process.


150 | FTP Palette


Description

Caution: Do not use this option if you areretrieving multiple files. You can only write onefiles's contents to this output of the activity.Selecting this check box with wildcards specifiedin the RemoteFileName input element returns anerror.

Binary None Specifies whether to retrieve the file content in binaryor ASCII mode (selected signifies binary).

Using ASCII mode automatically handles thedifferences in line endings between the FTP serverand the machine executing the FTP command.

The ASCII mode implies text data. This text data canbe encoded in a character encoding other than ASCII(such as UTF-8 or Latin-1).

OverwriteExisting File

None This check box if selected, and the Use Process Datacheck box not selected, overwrites any existing localfiles, if the FTP command returns the files with samenames.

If this check box is not selected, any attempt to writea file to the disk with the same name as an existingfile, results in an exception.

Description

Provide a short description of the FTP Get activity.

Input



151 | FTP Palette


RemoteFileName string The path and name of the file to retrieve from theremote server. Wildcards (? for any one character, * forone or more characters) are permitted in this field.

You can specify an absolute or relative path for theremote file name. Relative paths are relative to the pathspecified in the RemoteDirectory element or the currentdirectory, if RemoteDirectory is null.

Note: Do not specify wildcards for this element, ifUse Process Data check box is selected.

LocalFileName string This input item is available only if the Use Process Datacheck box on the General tab is not selected and onlyone remote file is retrieved.

This input item specifies the name and path of the localfile for the contents of the retrieved file to be written.

If more than one remote file is retrieved, the local filesare named to match the remote file names.





Username string The username for logging into the FTP server.




152 | FTP Palette



Encoding string When the retrieved file is not binary and the UseProcess Data check box on the General tab is selected,this specifies the character encoding of the retrieved file.

If this is not specified, it is assumed that the encoding ofthe file is the same encoding of the machine where theFTP command is executed. If the encoding of the localmachine and the FTP server are different, specify theencoding used by the FTP server in this element and theactivity converts the retrieved file into the localmachine’s encoding.

Timeout integer The amount of time to wait for the FTP server torespond.

This timeout is used when the FTP server places the FTPconnection used by this activity into a waiting state.

Output

The following is the output for this activity.


FileTransferred complex When one or more remote files are retrieved and writtento the local storage, this element contains a list of theretrieved remote filenames. This element contains thefollowing two elements:

l Name

l NumOfBytes

If an error occurs while retrieving the files, the activityoutput is not available. However, the Fault tab lists thesuccessfully transferred files and the files that failed to be


153 | FTP Palette


transferred.

Name string The name of the retrieved remote file.

NumOfBytes integer The number of bytes comprised in the associated filename.

Fault

The Fault tab lists the following possible exceptions generated by this activity. For moreinformation about error codes and the corrective actions to take, see the ActiveMatrixBusinessWorks Error Codes guide.


GetFilesException An error occurred during the FTP get operation.



ConnectionTimeoutException The connection to the FTP server is timed out before thecommand execution is complete.

FTP Get Default DirectoryFTP Get Default Directory is a synchronous activity that retrieves the name of the currentremote directory. The default remote directory is operating system dependent anddetermined by the remote FTP server. On UNIX systems, the default remote directory isusually the home directory of the user account that is used to establish an FTP connection.

General



154 | FTP Palette


Description


FTPConnection


Quit (post-command)

None Select this check box to specify that the FTPConnection should be closed after completing thiscommand.

The FTP connection remains open if this check box innot selected. All the FTP activities that specify thesame FTP session (that is, the same host, port,username, and password), can share the FTP sessionuntil the connection is closed.

Description

Provide a short description of the FTP Get Default Directory activity.

Input





Port integer The port number for incoming FTP requests on the FTP server.


155 | FTP Palette







Timeout integer The amount of time to wait for the FTP server to respond.



Output



CurrentDirectory string The directory currently set on the remote FTP server.

By default, this directory is set by the FTP server.However, you can use the FTP Quote activity to issue anFTP command to change to another directory.

Fault



156 | FTP Palette



ConnectionErrorException The connection to the FTP server is timed out before thecommand execution is complete.

FTP Make Remote DirectoryFTP Make Remote Directory is a synchronous activity that creates the specified directoryon the remote server.

General

The General tab consists of the following fields.


Description


FTPConnection


Quit (post-command)


The FTP connection remains open, if you do notselect this check box. All the FTP activities thatspecify the same FTP session (that is, the same host,port, username, and password), can share the FTPsession until the connection is closed.


157 | FTP Palette

Description

Provide a short description of the FTP Make Remote Directory activity.

Input




This overrides the value specified in the FTPConnection property.

Port integer The port number for the incoming FTP requestson the FTP server.






RemoteSITECommand string An optional element. This is a system-specificcommand to execute before creating thedirectory.

ParentRemoteDirectory string An optional element. The path to the remotedirectory to create.

This element is concatenated with theRemoteDirName element to provide the completepath to the directory to create.


158 | FTP Palette


RemoteDirName string The name of the remote directory to create.

You can optionally include the complete path ofthe directory to create.


This timeout is used when the FTP server placesthe FTP connection used by this activity into awaiting state.


Output


Fault





FTP PutFTP Put is a synchronous activity that issues an FTP put or mput command to the specifiedserver. You can use the process data as the file content to send to the remote server orsend the files to the local disk storage. Select Use Process Data to place only one file on


159 | FTP Palette

the remote server (FTP put command). To use locally stored files for placing more than onefiles on the remote server (FTP mput command).

General



Description


FTPConnection


Quit (post-command)



Use ProcessData

None Specifies to use the process data as the file contentto place on the remote server.

Select this check box to place only one file on theremote server.

Binary None Specifies whether to send the file content in binary orASCII mode (selected signifies binary).

When ASCII mode is used, the differences in line-endings between the FTP server and the machineexecuting the FTP command are automatically


160 | FTP Palette


Description

handled. This mode also implies text data, and thatdata can be encoded in a character encoding otherthan ASCII (such as UTF-8 or Latin-1).

OverwriteExisting File

None Selecting this check box overwrites any existing fileson the FTP server, if the FTP command sends fileswith the same names.

If this check box is not selected, any attempt to senda file to the remote server with the same name as anexisting file, results in an exception.

Append None This element specifies whether to append the data toan existing file. Select this check box to append thedata to the file, if the specified file exists on the FTPserver.

If not selected, the file is overwritten if it exists on theFTP server.

Timeout(msec)

None The amount of time to wait (in milliseconds) for theFTP server to respond.

This timeout is used when the FTP server places theFTP connection used by this activity into a waitingstate.


Description

Provide a short description of the FTP Put activity.

Input



161 | FTP Palette


RemoteFileName string The path and name of the file to place onto the remoteserver.


LocalFileName string The path and name of the local file to use in the FTP putcommand.

This element is available only if the Use Process Datafield is not selected.



Port integer The port number for the incoming FTP requests on theFTP server.




Password string The password for logging into the FTP Server.


Encoding string Encoding of the data to be put on the FTP server. Thisfield is present when the Use Process Data check box isselected on the General tab.


This timeout is used when the FTP server places the FTP


162 | FTP Palette


connection used by this activity into a waiting state.


Output



FileTransferred string A repeating string element containing a list of names offiles that were transferred. This element contains thefollowing two elements:

l Name

l NumOfBytes

If an error occurs while transferring files, the activityoutput is not available. However, the Fault tab lists thesuccessfully transferred files and the files that failed to betransferred.

Name string The name of the retrieved remote file.

NumOfBytes integer The number of bytes comprised in the associated filename.

Fault



163 | FTP Palette


PutFilesException An error occurred during the FTP Put operation.



ConnectionTimeoutException The connection to the FTP server is timed out before thecommand execution is complete.

FTP QuoteFTP Quote is a synchronous activity that sends an arbitrary command to the FTP server.FTP commands vary by their operating system, FTP version, and configuration. Beforeusing this activity, check for the availability of the commands on the remote server.

General



Description

Name None The name to be displayed as label of the activity inthe process.

FTPConnection


Quit (post-command)



164 | FTP Palette


Description


Has SocketData

None If selected, the FTP server returns the data as a resultof executing the command.

Description

Provide a short description of the FTP Quote activity.

Input

The following is the input for this activity.




Port integer The port number for the incoming FTP requests onthe FTP server.





165 | FTP Palette




RemoteSITECommand string Optional. The system-specific command to beexecuted before the executing the specifiedcommand.

ValidReturnCodes string The optional list of valid return codes to validatethe reply. Codes are three-digit numbers.

To specify multiple codes, separate each code witha comma or a space.

If the remote server returns a code not specified inthis list, the activity raises an exception.

RemoteCommand string The command to be executed on the remote FTPserver.




Output



CommandItems string Each element in this repeating element is a returnedvalue from the command executed on the remote server.


166 | FTP Palette

Fault





FTP Remove Remote DirectoryFTP Remove Remote Directory is a synchronous activity that deletes the specifieddirectory from the remote FTP server.

General



Description


FTPConnection


Quit (post-command)



167 | FTP Palette


Description


Description

Provide a short description of the FTP Remove Remote Directory activity.

Input





Port integer The port number for the incoming FTP requestson the FTP server.





This overrides the value specified in the FTP


168 | FTP Palette


Connection property.

ParentRemoteDirectory string An optional element. The path to the remotedirectory you want to remove.

This element is concatenated with theRemoteDirName element to provide the completepath to the directory to remove.

RemoteDirName string The name of the remote directory you want toremove.

You can optionally include the complete path ofthe directory to remove.




Output


Fault



169 | FTP Palette




FTP Rename FileFTP Rename File is a synchronous activity that renames the specified file on the remoteFTP server.

General



Description


FTPConnection


Quit (post-command)




170 | FTP Palette

Description

Provide a short description of the FTP Rename File activity.

Input





Port integer The port number for the incoming FTP requests onthe FTP server.






OldRemoteDirectory string An optional element. The path to the remote fileyou want to rename.

This element is concatenated with theOldRemoteFileName element to provide thecomplete path to the file to rename.

OldRemoteFileName string The name of the remote file you want to rename.

You can optionally include the complete path of thefile to rename.


171 | FTP Palette


NewRemoteDirectory string An optional element. The new path for the file torename.

This element is concatenated with theNewRemoteFileName element to provide thecomplete path to the file to rename.

NewRemoteFileName string The new name for the remote file.

You can optionally include the complete path of thefile.


This timeout is used when the FTP server places theFTP connection used by this activity into a waitingstate.


Output


Fault






172 | FTP Palette

FTP SYS TypeFTP Sys Type is a synchronous activity that retrieves the operating system of the FTPserver.

General



Description


FTPConnection


Quit (post-command)



Description

Provide a short description of the FTP SYS Type activity.

Input



173 | FTP Palette




Port integer The port number for the incoming FTP requests on the FTPserver.






Timeout string The amount of time to wait for the FTP server to respond.



Output



SystemType string The FTP server type.


174 | FTP Palette

Fault






175 | General Activities

General ActivitiesGeneral Activities palette comprises various general purpose activities and processstarters. For example, Timer, a process starter activity, is used to start a process at aspecific time.

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

When the Assign activity is used inside the For Each, Iterate, Repeat or While activities,and the Accumulate Output check box is selected on the General tab of these activities,the Output Activity field does not list the Assign activity.

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 Assign activity.



Input Item Description

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

Output

The schema specified for the process variable determines the schema for the output.

Call ProcessThe Call Process activity calls and executes an existing direct subprocess. Input dataspecified on the called subprocess is used by the Call Process activity.

General


Field Description


ProcessName

The subprocess you want to call. Click the Look Up icon or the Go To

icon to select a direct subprocess.



Field Description

Tip: An alternative way to call a subprocess contained in the same project,enter the name of the package and the name of the subprocess, separatedby a period, in this field. In this example, <PackageA> is the name of thepackage, and <Process1> is the name of the subprocess.

<PackageA>.<SubProcess1>

To call a subprocess in a separate project, enter the name of the project, thename of the package, and the name of the subprocess, separated by periods,in this field. In this example, the name of the project is<ProjectB>, the nameof the package is <PackageB>, and the name of the subprocess is<SubProcess2>.

<ProjectB>.<PackageB>.<SubProcess2>

ProcessNameDynamicoverride

Configuring this field is optional. Use this field to dynamically determine thesubprocess to call when the process instance is running. Click the Edit XPathExpression icon to specify a value for this field in the XPath Builder wizard.For more information, see Dynamically Determining the Process to Call.

Spawn Optional. If you select the Spawn check box, the parent process does not waitfor the called subprocess to complete, the subprocess is executed in a separateprocess instance, and the parent process cannot access the output of the calledprocess.

CustomIcon

Provide the location of icon image file.

Click the Choose a custom icon button to select the icon image file from

your current workspace.

Click the Import an icon from the file system button to select an icon

image from your file system.

Select the Clear Value button to remove the field value.

Important: TIBCO recommends to use image file of size 48 by 48 pixels andof the form .png, .jpg, or .jpeg.



Description

Provide a short description of the Call Process activity.

Input


InputItem


input varies The input to the called process is defined in the Output Editor tabof the Start activity of the called process.

Output


OutputItem


output varies The output of the called process is defined in the Input Editor tabof the End activity of the called process.

Fault

The Fault tab lists faults that the called subprocess might throw with a Throw activity. Todeal with these faults, add a Catch Specific, or Catch All block to the Call Process activity.

Dynamically Determining the Process to Call

You can use the Process Name Dynamic Override field on the General tab to specify anXPath expression that determines which direct subprocess to call. This is useful for callinga different direct subprocess depending upon the value of the XPath expression. Forexample, you have an incoming HTTP request that contains an attribute namedorderAmount

For all incoming orders over $10,000, you want to call a direct subprocess that includesactivities in the Manual Work palette to obtain the proper approvals. For orders under



$10,000, you want to call a direct subprocess that handles the order automatically. You cancreate the following expression that resolves to the proper direct subprocess name foreach type of order:

if($IncomingOrer/orderAmount > 10000) thenthen 'MyProject.manualApproval' else'MyProject.processOrder'

Use the full path and name of the direct subprocess file as stored in the project directory.

When you use the Process Name Dynamic Override field, you must also specify a directsubprocess to call in the Process field. The input, output, and error definitions of thespecified direct subprocess must be the same as any direct subprocess that the expressionin the Process Name Dynamic Override field can evaluate to.

Note: It may be helpful to create process definitions that act as programmaticinterfaces when using the Process Name Dynamic Override field. In theexample above, you may create a direct subprocess namedorderProcessOrApprove. The only purpose of this direct subprocess is forspecifying the input, output, and error schemas. Place this direct subprocess inthe Process Name field of the General tab of the Call Process activity. Then,create the manualApproval and processOrder process definitions as copies ofthe orderProcessOrApprove direct subprocess. The Call Process activity then hasthe correct input, output, and error schemas for all direct subprocesses that canbe called.

To dynamically call a direct subprocess, that has been created inside of a Shared Module,from an Application Module, use the following syntax:

'SM_Name/Package_Name.SubProcess_Name

Note: When the Call Process activity is in a local JDBC or JMS transaction, andthe Spawn check box is not selected, the direct subprocesses called by the CallProcess in the Local Transaction are also a part of the same local transaction.



CheckpointCheckpoint is an asynchronous activity that executes a checkpoint in a running processinstance. A checkpoint saves the current process data that can be recovered, if the eventfails. If a process engine fails, all the process instances can be recovered and resume theexecution of their last checkpoint in the process. Configuring the process engine tocheckpoint data for the failed process helps optionally, to recover the process instance at alater stage. This happens if the process fails due to an exception that cannot be handled orterminated manually.

General


Field Description


Timeout This field specifies the amount of time (in milliseconds) to wait before and afterthe checkpoint. If a process engine fails, all the process instances can berecovered. These recovered process instances resume the execution of theirlast checkpoint in the process.

DuplicateKey

A key value that is used to compare with other process instances to determinewhether another process instance with the same Duplicate Key value alreadyexists.

When multiple Checkpoint activities exist in the process, there is no need toset Duplicate Key values for the subsequent Checkpoint activities.

When the Duplicate Key values set for the subsequent Checkpoint activities,the values must be equal to the Duplicate Key value specified for the firstCheckpoint activity.

Note: Note: An error is generated if the Duplicate Key values are differentfor the subsequent Checkpoint activities

Description




Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective actions to take, see the TIBCO ActiveMatrixBusinessWorks™ Error Codes guide.


DuplicateKeyException Duplicate Key values are different for the subsequentCheckpoint activities.


Checkpoints and Confirm ActivityIn the case of confirmable messages (for example, a confirmable TIBCO Rendezvous® isreceived), consider the consequences of performing a checkpoint before or after a Confirmactivity.

If the checkpoint is taken before the Confirm activity, a crash occurs after a checkpoint butbefore a confirm, the original message is resent. In this case, the restarted process can nolonger send the confirmation. However, a new process is started to handle the resentmessage, and you can implement your process to handle the restarted and new processesappropriately.

If the checkpoint is taken after a Confirm activity, there is potential for a crash to occurafter the confirm but before the checkpoint. In this case, the message is confirmed andtherefore not redelivered. The process instance is not restarted, because the crashoccurred before the checkpoint.

You must consider the type of processing your process performs to determine when acheckpoint is appropriate if your process receives confirmable messages.

ConfirmConfirm is a synchronous activity that confirms any confirmable message received by theprocess instance.



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

Provide a short description of the Confirm activity.

External CommandExternal Command is a synchronous activity that executes the command on the operatingsystem. This activity waits for the command to complete before transition to the nextactivity. Optionally, the command output and errors can be included in this activity'soutput schema, written to a file, or both.

General





Description

Name None The name to be displayed as a label for the activity ina process.

CommandTo Execute

Yes The command line to execute. You can also specify anyinput and command-line arguments to the commandin this field.

You cannot specify more than one command by pipingoutput from one command to another (for example, ls |more is not allowed).

ProvideCommandOutput

None Selecting this check box specifies that the output sentto the standard output and standard error bycommand is available in the output schema of thisactivity.

Caution: Do not select the check box for thecommands that produce a large amount of output.Instead, write the output to a file. This savesmemory and you can use other activities, such asRead File andParse Data, to handle the output filemore efficiently.

RemoveParameterQuotes

Yes If this check box is selected, the quotes surroundingthe parameters are removed. The quotes are removedeven if the parameter contains space(s).

By default, this check box is clear.

OutputFilename

Yes The name and location of the file for storing anyoutput or errors produced by the command. If thisfield is blank, no output file is created.

Output LineSplitting

None Controls whether the command output and errors aresplit into multiple strings.




Description

Select any one from the following available options:

l None: This activity produces a single stringcontaining the command’s output or errors. Thisstring includes line end characters.

l At Operating System Line End: This activityproduces a repeating string element with onestring element per output line. The lines are splitby default on the carriage return/line feedcharacter, depending on the operating system.The line end characters are not included in theoutput.

l At Specified Token: The lines are split whereverthe specified token occurs. The token is specifiedas an activity input element, and the token is notincluded in the output.

Description

Provide a short description of the activity.

Input

The following is input for this activity.


command string The command to execute, including any input orcommand-line arguments.

Specifying this input item overrides the commandspecified on the General tab.




input string An input string to supply to the command’s standardinput.

This schema item attains the same result as entering thecommand from a command prompt and then typing theinput without specifying a carriage return.

outputFile string The file containing the output produced by thecommand for sending it to stdout.

environment string The environment variable settings used to run thecommand. This element is specified as a comma-separated list of <name>=<value> pairs where:

l <name> is the name of the environment variable

l <value> is the value of the environment variable

If no value is specified for this element, the command isexecuted with the environment variable settingsspecified in the login scripts, for the user account usedto execute the process engine.

If a value is specified, the value of this element replacesany environment settings for the user account used torun the process engine.

That is, the user environment is ignored and thiselement’s value is used instead.

workingDirectory string The working directory for the command process.

If not specified, the command process inherits itsworking directory from the process engine.

Output





returnCode integer The numeric return code returned by the command.

Typically, a value of 0 (zero) in this element signifies asuccessful command execution.

A non-zero value usually indicates termination of thecommand due to an error.

output string Any output produced by the command and sent to stdout.This output item is available only when you select the ProvideCommand Output check box on the General tab.

This is a repeating element, if the line split configurationsetting causes the command’s output to be split into severallines.

error string Any errors produced by the command and sent to stderr. Thiselement is only available if you select the Provide CommandOutput check box on the General tab.

This is a repeating element, if the line split configurationsetting causes the command’s output to be split into severallines.

Fault



CommandExecutionError The command could not be executed.

FileIOError There was an error when attempting to write the output to afile.

Ensure that the user running the ActiveMatrix BusinessWorksengine, has the write permission to the output file.




InvalidInputException An error in the activity’s configuration or input mappingprevents the command from being executed.

Get Shared VariableGet Shared Variable is a synchronous activity that retrieves the current value of a moduleshared variable or job shared variable. To use this activity to retrieve the value of a sharedvariable, use a Critical Section group to ensure that no other process instances alter thevalue of the shared variable at the same time.

General


Field Description


Shared VariableType

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

Shared VariableName

The module shared variable or job shared variable whose value you wantto retrieve.

Description

Provide a short description of the Get Shared Variable activity.

Output




OutputItem

Description

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

The schema for the output is determined by the schema specified for the sharedvariable.

InspectorInspector activity is used to write the output of any or all activities and module propertiesto a file or stdout. This is particularly useful when debugging processes and you want tosee the entire schema instead of mapping specific elements to the Write File activity.

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

General


Field Description


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

l All

l ModuleProperties

l _processContext

Only activities that have output and are executed prior to the Inspector activity



Field Description

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 toFile

Select this check box to specify that the output is appended to the file specifiedin this activity’s input.

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

SuppressHeader

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

Provide a short description of the Inspector activity.

Input



fileName string The absolute path to the file you want to write. This file containsthe output of the specified activity or module property.

Output

The following is the output of this activity.



OutputItem


output string The output of the module property or activity specified on theGeneral tab in string form.

You can use this output in subsequent activities, in addition towriting the output to a file or stdout. For example, you can usethis output as the body of a TIBCO Rendezvous message.

LogLog is a synchronous activity that writes a message to the log file. For each AppNode andapplication, there is a log file.

General


Field Description


LoggerName

The name of a logger used in the logback.xml file. The value for the LoggerName is case sensitive and can be a single name or a hierarchical name.

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

l Error: logs error conditions and messages.

l Warning: is the warning message of an unexpected error in the process.

l Info: logs informational messages highlighting the application/engineprogress.

l Debug: can be used for debug-level messages.

SuppressJob Info

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



Field Description

If not selected, each log message appends JobId, ProcessInstanceId, ActivityName, Deployment Unit Name, and Version name to the message text.

ControlLogs byEvent Type

Use this option to group log messages from different Log activities using thesame event type.

Select this option to generate a log file with the name <EventType>.log

When you select this option, the Logger Name field is disabled, theloggerName element is removed from the Input tab, and a new elementeventType is added to the Input tab.

By default, the check box is clear.

EnhanceLog Control

Use this option to group log messages from different Log activities of the sameapplication, or process.When you select this check box, the Logger Name field is disabled, theloggerName element is removed from the input schema, and the Control Byfield is displayed.


Control By Use this field to select whether messages are to be added to the log file at anapplication level, or at a process level.

The Control By field has following options:

l Application: Select this option to generate a log file with the name<ApplicationName>.log

l Process: Select this option to generate a log file with the name<ApplicationName>.<ProcessName>.log

By default, the Application option is selected.

Description

Provide a short description of the Log activity.

Input




Input Iten Datatype Description

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

loggerName string The name of a logger used in the logback.xml file. The valuefor loggerName is case sensitive and can be a single name ora hierarchical name.

If you specify a value in the input schema, that valueoverrides the value specified for the Logger Name field onthe General tab.

logLevel string Select one of the following log levels recognized by theprocess engine.

l Error: logs error conditions and messages.

l Warning: is the warning message of an unexpectederror in the process.

l Info: logs informational messages highlighting theapplication/engine progress.

l Debug: can be used for debug-level messages.

If you specify a value in the input schema, that valueoverrides the value specified for the Log Level field on theGeneral tab.

message string The message to be displayed in the log.

Note: If the message contains non-ASCII data, the defaultencoding of the Java Virtual Machine (JVM) used by theprocess engine, is used for text encoding, when writing tothe log file.

eventType string Specify an event type. This parameter is used to group logmessages from different Log activities using the same eventtype.

This field is mandatory.



Input Iten Datatype Description

The field appears when you select the Control Logs By EventType check box on the General tab.

The name of the log file depends on the option selected inthe Control By field on the General tab, and the event type.

If you select the Application option of the Control By fieldon the General tab, the name of the log file is:<EventType>.<ApplicationName>.log

If you select Process option of the Control By field on theGeneral tab, the name of the log file is:<EventType>.<ApplicationName>.<ProcessName>.log

MapperMapper is a synchronous activity that adds a new process variable to the process. Thisvariable can be an inline schema, primitive element, or a complex element. You can mapthe data values from the current list of process variables to the elements of the variablewith the Mapper activity.

General

Specify the name of the activity here.

Description

A short description of the Mapper activity.

Input Editor

The Input Editor tab defines the structure of the process variable to add to the process.You can use a simple datatype, or you can define a group of data elements on this tab.

You can also reference an XML schema stored in the project. The data specified herebecomes the input and output schema of the Mapper activity. This data is then availableto 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 Editortab.

NotifyThe Notify activity allows a process instance to send data to a corresponding processinstance containing a Wait for Notification activity or the Receive Notification processstarter. The Notify Configuration resource and the key specified on the General tab,create the relationship between the Notify activity and the corresponding Wait forNotification activity or Receive Notification activity.

General


Field Description


SharedConfiguration

The Shared Configuration resource that defines a data schema for thisactivity.

The Shared Configuration resource is required, but the schema can beempty if you do not want to pass data between processes.

Key The key that coordinates a Notify activity with the corresponding Wait forNotification or Receive Notification activity.

NotificationTimeout (msec)

The timeout (number of milliseconds) to keep the information for thisNotify activity.



Description

Provide a short description of the Notify activity.

Input

This activity contains an input only if there is a schema defined on the NotifyConfiguration shared resource.

OutputItem


schema complex The schema specified by the Notify Configuration sharedresource on the General tab.

This schema is used to pass data from the process instancecontaining the Notify activity into the process instance containingthe related Wait for Notification activity or Receive Notificationactivity.

Output


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

General


Field Description




Field Description

Shared VariableType

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

Shared VariableName

The module shared variable or job shared variable whose value you wantto retrieve.

Description

Provide a short description of the Set Shared Variable activity.

Input


InputItem

Description

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

The schema for the input is determined by the schema specified for the sharedvariable.

Output



schema orno output

The value of the shared variable specified in the Shared Variable field of theGeneral 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 forthe specified time. For a process with multiple control flows, only the current executionbranch of the process is suspended.

General


Field Description


Description

Provide a short description of the Sleep activity.

Input



IntervalInMillisec integer The amount of time interval, in milliseconds, to suspendthe current branch of the process. The default timeinterval is 3 minutes.


The following are the details about the Sleep activity threading policy.




DefaultThreadCount


Asynchronous No 1 Not applicable.

The activity does not create simultaneousprocess instances due to the single threadingmechanism. You cannot alter the defaultthread count for this activity.

TimerTimer is a process starter activity that starts the process at a specific time. You can alsospecify the processes to be started periodically.

General



Description


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

The local machine’s time zone is used to determine theprocess start. If the project is running on machines indifferent time zones, the time zone of the machine wherethe project was saved, is used. Use a process property inthis field to provide start times relative to the time zone




Description

where the project is deployed. If you provide a processproperty for this field, the format of the specified timemust be: yyyy MMM dd HH:mm:ss z

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

If you do not select this check box, the Time Interval andInterval Unit fields are displayed that you can use tospecify the frequency of the process.

Use localtime

None On selecting this check box, the local time of thecontainer is considered.

TimeInterval

Yes The integer indicating the number of units specified inthe Interval Unit field. For example, if a value of 1 isspecified and the Interval Unit field is specified as Hour,a new process is started every hour beginning at the timespecified in the Start Time field.

l If a value of 2 is specified and the Interval Unitfield is specified as Month, a process is startedevery other month, beginning at the time specifiedin the Start Time field.

l If the value specified is less than one second (1000milliseconds), the timer ignores the specifiedinterval and is triggered once every second.

Note: Using Literal Value, Module Property, andProcess Property in this field, specifies the timeinterval in milliseconds and the Interval Unit field isnot displayed.

IntervalUnit

None The unit of time to use with the Time Interval field to




Description

determine how often to start a new process. The unitscan be: Millisecond, Second, Minute, Hour, Day, Week,Month, and Year.

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

l Never: Click the Never radio button if you want tocontinuously execute the process instance. Forexample, if the Time Interval value specified is 5and the Interval Unit specified is Second, theprocess instance executes every 5 seconds.

l Occurrences: Clicking the Occurrences radiobutton displays the Occurrences field. Specify thenumber of occurrences of the process instanceexecution. This field can be configured with LiteralValue, Module Property, and Process Property.

l End Time: Clicking the End Time radio buttondisplays the End Time field. Specify the end timeand date when you want the process to end. Thisfield can be configured with Literal Value, ModuleProperty, and Process Property.

Description

Provide a short description of the Timer activity.

Advanced




Field Description

SequencingKey

This field contains an XPath expression that specifies which processes shouldrun in sequence. Process instances with sequencing keys evaluating to thesame value, are executed sequentially in the sequence the process instancewas created.

Custom JobId

This field contains an XPath expression that specifies a custom job ID forevery job in the process instance.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.

Output



TimerOutputSchema The time the process instance started.

The time is represented by several items in the output schemaindicating:

l Now

l Hour

l Minute

l Second

l Week

l Month

l Year

l Date




l Time

l DayOfMonth

Each of these items uses the appropriate datatype.


The following are the details about the Timer activity threading policy.


DefaultThreadCount


ProcessStarter No 1 Not applicable.

The Timer process starter does not generatemultiple events concurrently. You cannotalter the default thread count for thisactivity.

Wait for NotificationThe Wait for Notification activity suspends execution of the process instance and waits fora Notify activity with a matching key to be executed in another process instance. The keyspecified in the General tab and the Notify Configuration resource, creates a relationshipbetween the Wait for Notification activity and the corresponding Notify activity.

General




Field Description

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

SharedConfiguration

The shared configuration resource that defines a data schema for thisactivity.

The shared configuration resource is required, but the schema can beempty if you do not want to pass data between processes.

Key The key to coordinate a Wait for Notification activity with thecorresponding Notify activity.

Activity Timeout(msec)

The timeout (number of milliseconds) for this Wait for Notificationactivity.

Description

Provide a short description of the Wait for Notification activity.

Input

This activity has no input.

Output

This activity contains an output only if there is a schema defined on the NotifyConfiguration shared resource.


OutputItem


schema complex The schema specified by the Notify Configuration sharedresource on the General tab.

This schema is used to pass data from the process instancecontaining the related Notify activity into the process instancecontaining the related Wait for Notification activity.



Fault




On Notification TimeoutThe On Notification Timeout process starter specifies a process to execute, when atimeout is reached for storing notification data for a Notify activity.

You can specify an On Notification Timeout process for a specific shared configurationresource. The process with the On Notification Timeout process starter executes, when aNotify activity with a matching shared configuration undergoes a timeout.

It is recommended that you do not create more than one process for the same sharedconfiguration resource. If a Notify activity experiences a timeout of it's stored notificationinformation, that timeout can only apply to one On Notification Timeout process.

When the notification expires on timeout, the On Notification Timeout process starter isnot triggered immediately. A background thread runs at a regular interval, and checks forexpired messages. This thread runs at the default time interval of 30 minutes. To changethis default time interval, which is specified in minutes, change the value in the optionalproperty bw.engine.activity.signalin.eventTimeout.purge.interval=30

Note: Note: If the engine is running in memory mode, set the interval time to bebetween one to five minutes. If the engine is running in datastore mode, set theinterval time to be anywhere from five to thirty minutes.

To change the default value, uncomment the property in the AppSpace config.ini file or passit as a VM argument in TIBCO Business Studio for BusinessWorks.

You can also specify the On Notification Timeout process to apply to any Notify activityexperiencing a timeout. If there is no On Notification Timeout specified for the shared



configuration resource of the Notify activity, the process engine calls the On NotificationTimeout process with the Any Notify Config field selected.

General


Field Description

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

SharedConfiguration

This field is enabled only when the Any Notify Config check box is notselected.

This field allows you to specify the shared configuration that this processapplies to. Only timeouts for Notify activities with a matching sharedconfiguration starts a process instance.

Only one On Notification Timeout process can correspond to any sharedconfiguration. You cannot create multiple processes using the same sharedconfiguration.

Any NotifyConfig

Selecting this check box disables the Shared Configuration field.

When the check box is selected, notifications from any Notify activity,associated with any shared configuration trigger the On NotificationTimeout process starter.

When this check box is not selected, notifications from any Notify activityassociated with the same shared configuration as specified on the activitytriggers the On Notification Timeout process starter.

Do not select this check box, if you want to specify a process for a specificshared configuration resource.

Description

Provide a short description of the On Notification Timeout activity.

Output





notificationOutput object This element contains the schema specified in theshared configuration of the Notify activity that hastimed out.

Receive NotificationThis is a process starter activity. The Receive Notification activity starts a process whenanother process executes a Notify activity with a matching key and a shared configurationresource.

The key specified in the Key field of the General tab creates a relationship between theReceive Notification process starter and the corresponding Notify activity. The sameshared configuration (Notify Configuration) resource must be specified by thecorresponding Receive Notification and Notify activities to pass the data from the processcontaining the Notify activity to the process started with Receive Notification. Theschema in the shared configuration resource however can be empty, if you do not want topass data between processes.

General


Field Description


SharedConfiguration

The shared configuration resource that defines a data schema for thisactivity.

The shared configuration resource is required, but the schema can beempty if you do not want to pass data between processes.

Key The key that coordinates a Receive Notification process starter with thecorresponding Notify activity.

The key must be a fixed string.



Description

Provide a short description of the Receive Notification activity.

Advanced


Field Description

SequencingKey

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

Custom JobId

This field contains an XPath expression that specifies a custom job ID forevery job in the process instance.

Output


OutputItem


schema complex The schema specified in the Shared Configuration field on theGeneral tab.

This schema is used to pass data from the process instancecontaining the Notify activity into this process instance.


208 | HTTP Palette

HTTP PaletteUsing 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 ofan HTTP request.

Note: When configuring an HTTP activity, configuring an HTTP Connectorshared resource as the value for a module property is not supported. Configure aliteral value instead.

General


Field LiteralValue/ModuleProperty/Processproperty

Description


HTTP Connection Yes The HTTP Connector resource describes thecharacteristics of the connection used to receiveincoming HTTP requests.

For more information about specifying sharedresources, see HTTP Connector.

Context Path Yes This is the prefix of a URL path that is used to


209 | HTTP Palette


Description

select the contexts to which an incoming requestis passed.

You can either specify both Context Path andPath Spec, any, or none of these elements. Forexample, the path displays as thehttp://hostname.com/contextPath/pathSpec format.

If the Context Path is not specified, the ContextPath is referred to as the root context.

In a Send HTTP POST request where a Path Specis not provided, add a forward slash (/) after theContext Path (for example:http://<host>:<port>/<contextPath>/). If you do not addthe forward slash, the POST request is redirectedas a GET request for the resource at /<context_path>.

In a Send HTTP POST request where a Path Specis provided no forward slash (/) is required (forexample:http://<host>:<port>/<contextPath>/<pathSpec>).

Path Spec Yes If specified, it is added as a prefix of a URL of theform http://hostname.com/contextPath/pathSpec.

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

Note: If you are running POST/PUT requestsusing HTTP 2.0 (a binary protocol), you mustset this field to Binary.

Parse PostMethod Data

None Specifies to parse the message body of the HTTPrequest into a schema for the output of theactivity.


210 | HTTP Palette


Description

When this check box is selected, the parametersspecified in the Parameters field are used tovalidate the incoming request and parse it into theoutput schema. This field is present only when theOutput Style is String.

Note: For an incoming GET request, there is nomessage body, so this field has no effect on theincoming GET requests.

Parameters None The parameters of the incoming HTTP request.

If you specify parameters in this table, theincoming request is parsed and represented as aschema in this output of the activity. For eachparameter, you must provide a name, datatype,and whether the field is Optional, Required, orRepeating.

Use the and buttons to the right of theparameter table to add and remove parameters.

Note: Specifying parameters in this field parsesthe query string of the request into the outputschema, regardless of whether the Parse PostMethod Data check box is selected. Selectingthe Parse Post Method Data check box andspecifying parameters here is required to parsethe message body along with the query stringof the request.

HTTPAuthentication

None Specifies that the client sending the HTTP requestmust be authenticated. The user name andpassword specified in the incoming request mustexist in the LDAP server configured on HTTP


211 | HTTP Palette


Description

Connector

Expose SecurityContext

None Places the information from the user’s securitycontext (either authentication or SSL certificateinformation) into the Context or SecurityContextoutput element.

This is a fairly expensive operation and SSLcertificates can consume memory resources.Hence, select this option only if you requireinformation from the user’s security context forlater use in your process.

Default Encoding Yes Specifies the encoding to use if no charset isspecified in the Content-Type header of themessage. This encoding is used for the messagebody and URL.

However, when URIEncoding is specified in theHTTP Connector shared resource, the DefaultEncoding parameter specified here applies to thecontentType alone and not to the URIEncodingproperty.

Note: Imported projects display the HTTP Authentication check box under theGeneral section if the check box was selected in a previous version TIBCOCloud™ Integration 6.x. Authentication remains enabled on the HTTP Recieveractivity if you do not clear the check box. If you clear the Authentication checkbox, a warning message is displayed prompting you to confirm your action. Toremove authentication from the activity, click OK. Once you have removedauthentication from the HTTP Reciever activity, you can reapply it using theBasic Authentication policy.


212 | HTTP Palette

Description

Provide a short description for the HTTP Receiver activity.

Advanced


Field ProcessProperty/ModuleProperty

Description

Fill StandardHeaders

None When this check box is selected, additional headerssuch as Authorization, User-agent, and Host arepopulated in the Dynamic Headers element in theserver response received from the client.

Write to File None Select this check box to write incoming requests thatexceed the specified threshold size to a file instead ofstoring the request in memory. You can accept largeincoming requests without consuming a great deal ofmemory. Selecting this check box displays theDirectory, Creating Non-Existing Directories, andThreshold Data Size(bytes) fields.

Note: This option is not intended to be used withthe Parse Post Method Data option on theGeneral tab. When you select Write to File, thePostData output element becomes a choiceelement containing either the output fileName orthe PostData. 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.


213 | HTTP Palette


Description

Note: After writing, the files created using thisoption are not deleted automatically. You mustmanage the storage used by these files and deletethem when they are no longer used.

Directory Yes The directory to write messages that are above thespecified threshold. The process engine does notattempt to create the directory if the specifieddirectory does not exist. Therefore, create the directorybefore starting the process engine.


None When this check box is selected, all directories in thepath specified in the Directory field are created, ifthey do not already exist.

If this check box is not selected and there are one ormore directories in the specified path in the Directoryfield that do not exist, an exception is raised.

ThresholdData Size(bytes)

Yes The maximum size (in bytes) of an incoming requestthat can be kept in the memory. Requests larger thanthe specified size are written to a file in the specifieddirectory. The file’s name is output so that subsequentactivities in the process can access the file and read itscontents.

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

SequenceKey

None This field can contain an XPath expression thatspecifies which processes should run in sequence.Process instances with sequencing keys that evaluateto the same value are executed sequentially in thesequence the process instance was created.

Custom JobId

None This field can contain an XPath expression thatspecifies a custom ID for the process instance.


214 | HTTP Palette

Special Characters in HTTP Requests

Depending upon the content type of the data for the request, the request can contain URL-encoded data and the server is expected to decode the data. For example, an incomingrequest may have the following message body:

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

If the message body is not parsed (Parse Post Method Data check box is not selected onthe General tab), the body of the message remains URL-encoded in the PostData outputelement. If the message body is parsed, the data is decoded before being placed in thePostData output element, and that element would display as follows:

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

Note: The sequence of the parameters may not be the same in the PostDataoutput element as the sequence in the original HTTP request sent by the clientwhen the message body is parsed.

The PostData output element can contain different data and be a different lengthdepending upon whether the message body is parsed. Hence, ensure that you obtain datafrom the parameters output element when the message body is parsed.

Output Editor

The Output Editor tab describes the data structure for the headers of the HTTP request.You can use the default structure, or you can alter the structure, if the incoming requesthas a specific data structure for the header of the request.

The header structure is defined by the HTTP protocol. For more information about thefields and content of the header of an HTTP request, see the HTTP specification at w3.org.

OutputHeaderElement


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 at w3.org.

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




215 | HTTP Palette

OutputHeaderElement


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

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 at w3.org.

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.

For more information about this header field, see the HTTPspecification at w3.org.

Content-Type string This field indicates the media type of the entity body sent tothe receiver. For example, text/html; charset=ISO-8850-4. Mediatypes are described in the HTTP specification at w3.org.

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.

For more information about when the message body is URLencoded, see Special Characters in HTTP Requests.

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 whenthe request is complete.

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





#SECTION_D40D76A736BE4227996E603660F27FAB


216 | HTTP Palette

OutputHeaderElement


Note: For correct parsing and processing of cookies, inputmust be in the format "key=value".

For more information about this field, see the HTTPspecification at w3.org.

Pragma string This field is used to include implementation-specific directivesthat might apply to the receiver.

For more information about this field, see the HTTPspecification at w3.org.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see ActiveMatrix BusinessWorks ApplicationDevelopment guide.

Output



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

RequestURI string The address portion of the request. At runtime itwill contain the Query String after the questionmark (?), if it is sent in the HTTP Request.

HTTPVersion string The version field of the HTTP request.






217 | HTTP Palette


PostData orBinaryContent orFileName

string The message body of the HTTP request. Thecontent of this element depends upon whether themessage body is parsed. Parsing behavior iscontrolled by the Parse Post Method Data fieldon the General tab.

The content of this element is PostData if theOutput Style field selected is of type String, andthe element is BinaryContent if the Output Stylefield selected is of type Binary.

For more information, see Special Characters inHTTP Requests.

If the Write to File field is selected on theAdvanced tab, and the incoming message exceedsthe specified threshold size, the PostData field canalso contain the file name of the file containingthe message.

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

Header string The header of the HTTP request.

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

Port string The port number on which the request wasreceived. This is the port number configured in theHTTP Connector resource.

Headers complex The fields of the header specified on the OutputEditor tab.

For more information about these items, see thedescription of the Output Editor tab.

Parameters complex The parameters for the incoming request. These



#SECTION_10223162896048DE8281CE213F9A0A80


218 | HTTP Palette


parameters are configured in the Parameters fieldon the General tab.

When the Parse Post Method Data check box onthe General tab is selected, the parametersinclude the parameters in the query string andmessage body of the incoming HTTP request.

When the Parse Post Method Data check box isnot selected, the parameters include only thequery string of the incoming request.

DynamicHeaders complex The dynamic header is an additional headerparameter to receive header parameters fromincoming HTTP requests. This element is specifiedin the Output Editor tab. The DynamicHeadersconsists of the following information:

l Name: the name of the header (caseinsensitive)


The following overriding conditions can beconsidered:

l Overrides the value of HeaderName with thevalue found in DynamicHeaders, if it is anon-repeating header. If more than oneoccurrence of this header is found underDynamicHeaders, it generates the "Theheader [ headerName ] is defined as non-RepeatingHeader in Input Headers. This header cannot havemultiple occurences in DynamicHeaders."exception.

l If it is a repeating element, add therespective name value pairs under dynamicheaders, which is added to the existing listmaintained for this element.


219 | HTTP Palette


l For a repeating element, if the new headername is not found under the Headerssection declared through TIBCO BusinessStudio for BusinessWorks, the following isadded into the HTTP Headers.

o Shows only one value, if found oncein DynamicHeaders.

o Shows array of values, if foundrepeating in DynamicHeaders.

mimeEnvelopeElement complex This element contains the message attachments.

This element contains a repeating element namedmimePart that contains each mime attachment.

mimeHeaders complex This element contains the mime header for eachmimePart. Mime headers can contain thefollowing information:

l content-disposition: To suggest a filenamefor an attachment, use"*;filename=<filename>" in this element.

Note: HTTP servers may alter or ignorethe suggested name.

l content-type

l content-transfer-encoding

l content-id

l any element

For more information about MIME headers andtheir syntax, seehttp://www.faqs.org/rfcs/rfc2045.html.

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


220 | HTTP Palette


Note: When the content type is specified as"text/*" (for example, "text/xml"), theattachment content is expected to be in eitherthe textContent input element or the file namestoring the attachment is expected to be in thefileName input element. When the contenttype is anything other than "text/*", theattachment content is expected to be in eitherthe binaryContent input element or the filename storing the attachment is expected to bein the fileName input element.

binaryContent |textContent | fileName |mimeEnvelopeElement

choice This element contains the mime attachment.

The element can be one of the following:

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

l textContent: content of the attachmentwhen the attachment is text data.

l fileName: the file name of the attachmentwritten to the disk.

l mimeEnvelopeElement: If a server sends aresponse with nested attachments, it willreflect in this part at runtime. This elementcontains the message attachments. Thiselement contains a repeating elementnamed mimePart that contains each mimeattachment.

Note: To see this element in existingapplications, we have to modify theactivity to enable the Save button.

Context complex Contains information about the client’senvironment.


221 | HTTP Palette


This element holds the optional RemoteAddresselement.

RemoteAddress string The IP address of the client that submitted theHTTP request.


The following are the details about the HTTP Receiver activity threading policy.


Default ThreadCount


ProcessStarter Yes l MinimumQTPThreads =10

l MaximumQTPThreads =75

It can be configured on the HTTPConnector shared resource usingthe following fields:



Policy

Activities that support policies display the Policy tab. To associate a new or existing policy

with the HTTP Receiver activity, click the Add Policy to Activity icon. To edit policy

details, click Go to selected Policy icon. The Policy tab has the following fields.

Field Description

Name The name of the policy.


222 | HTTP Palette

Field Description

Type The type of policy associated with the activity. The HTTP Receiver activitycan support the Basic Authentication policy.

Description A description of the policy.

Send HTTP RequestSend HTTP Request is an asynchronous activity that sends an HTTP request and waits fora response from the web server. This activity sends a request to a server that is compliantwith either the HTTP 1.0, 1.1, or 2.0 specification. HTTP 2.0 is supported only when theHTTP version at the client shared resource is set to HTTP 2. ActiveMatrix BusinessWorksautomatically sends the request using the correct version based on the version supportedby the HTTP server. Therefore, do not specify the HTTP version of the server you aresending the request to.

Note: When configuring an HTTP activity, configuring an HTTP Connector sharedresource as the value for a module property is not supported. Configure a literalvalue instead.

General


Field Description


HTTP Client Specifies the HTTP Client shared resource. For more information, see HTTPClient.

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

l Parameter Name


223 | HTTP Palette

Field Description

l Parameter Type as string

l Parameter Cardinality as Optional, Required, or Repeating

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

Post DataType

The body of the HTTP message. You can select either String or Binary format.

Description

Provide a short description for the Send HTTP Request activity.

Advanced



Description

ProvideClientResource

None Select this check box to dynamically select the needed HTTPclient resource. When you select this check box, Host and Portfields disappear, and the ClientResource field appears in theInput tab.

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. Selectingthis check box displays the Directory and Threshold Data Sizefields.


224 | HTTP Palette


Description

Note:l To keep the incoming requests in memory, do not

select this check box.

l 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.

CreatingNon-ExistingDirectories

None 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, raises anexception.


Yes The maximum size (in bytes) of an incoming request to be keptin memory. Requests larger than the specified size are writtento a file in the specified directory. The file’s name is the outputso that subsequent activities in the process can access the fileand read its contents.

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

Write NonMIMEContent

None Select this check box to save the non-MIME attachments ordata downloaded from the server to a disk.


225 | HTTP Palette

Input Editor

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

Note: If you add a new primitive element, and that element is not a definedHTTP standard header, the server lists the element in the DynamicHeaderssection.

InputHeader


Accept string This field specifies media types that are acceptable for responsemessages for the request. For example, text/*, text/html. Mediatypes are described in the HTTP specification at w3.org.

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 described in the HTTPspecification at w3.org.

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 are acceptablefor response messages. For example, compress and gzip.

For more information about this header field, see HTTPspecification at w3.org.

Content-Type

string This field indicates the media type of the entity body for theoutgoing message and the incoming response. Media types aredescribed in the HTTP specification at w3.org. An example of themedia type is text/html; charset=ISO-8850-4.




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




226 | HTTP Palette

InputHeader


Cookie string A name and value pair (also known as a cookie) containinginformation that the HTTP server may be expecting. For correctparsing and processing of cookies, input must be in the format"key=value".

You can set the cardinality for this element to Repeating (*) tospecify more than one cookie. You can also specify multiplename or value pairs in a single non-repeating element byseparating each pair with a comma (for example, "name1=value1,name2=value2").


For more information about this field, see the HTTP specificationat w3.org.

Output Editor

Output Editor comprises the data structure of the headers of the HTTP request and HTTPreply message. You can either use the default structure or modify the structure, if theoutgoing request or the reply to the request has a specific data structure for the header.

The HTTP protocol defines the header structure. For more information about the fields andcontent of the header of an HTTP request, see the HTTP specification at w3.org.

OutputHeader


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 types aredescribed in the HTTP specification at w3.org.

An example of the media type is text/html; charset=ISO-8850-4






227 | HTTP Palette

OutputHeader


.

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 to becompressed without losing the identity of its underlying mediatype.


Date string The date and time when the response message was sent.

Location string This field is used to redirect the receiver to a location other thanRequestURI for completion of the request or for identification ofa new resource.

Set-Cookie string The cardinality for this field is set to Repeating (*).












228 | HTTP Palette

Input



ClientResource string This field appears when you select the ProvideClient Resource check box on the Advanced tab.Provide the HTTP client shared resource name towhich you want to connect dynamically.

The client resource name to be provided in theinput tab should be of the form <PackageName>.<Resource Name>.

Note: Do not provide .httpClientResourceextension in the client resource name.

Host string The HTTP host you want to connect to. Specifyinga value for this input item overrides any valuespecified on the General tab.

Port string The port number that the HTTP server uses forincoming requests. Specifying a value for thisinput item overrides any value specified on theGeneral tab.

Method string The HTTP method to use for the request. All HTTP1.1 methods are supported, but the connectmethod is unnecessary because TIBCO® CloudIntegration automatically uses the CONNECTmethod when connecting through a proxy server.

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

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


229 | HTTP Palette


PostData string The message body of the HTTP request. Do notspecify this element when the method of therequest is GET.

For more information about this input element,see Sending Data in the HTTP Request

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


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

Headers complex The header fields to send for the request. Whenthis element is specified on the Input Editor tab,you can use this input item to provide values forthe header when sending the request.

DynamicHeaders complex The dynamic header is an additional headerparameter to add runtime headers to the outgoingHTTP messages. This element is specified in theInput tab.

Note: You can use only US-ASCII characters inDynamicHeaders.

The DynamicHeaders consists of the followinginformation:



You can consider the following overridingconditions.

l Overrides the value of HeaderName with the


230 | HTTP Palette


value found in DynamicHeaders if it is anon-repeating header. If more than oneoccurrence of this header is found underDynamicHeaders, it generates the followingexception.

The header [ headerName ] is defined asnon-Repeating Header in Input Headers.This header cannot have multipleoccurences in DynamicHeaders.

l If it is a repeating element, add therespective name value pairs under dynamicheaders, which is then added to the existinglist maintained for this element.

l For a repeating element, if the new headername is not found under the "Headers"section declared through TIBCO BusinessStudio for BusinessWorks, the following isadded into HTTP headers.


o Shows an array of values, if foundrepeating in DynamicHeaders.

If you add any Standard HTTP Header as a namevalue pair in the Dynamic Header section in theclient end, on the server side this is listed underthe Headers section.

parameters complex This element contains parameters added in theParameters field in the General tab.




231 | HTTP Palette


mimeHeaders complex This element contains the mime header for eachmimePart. mimeHeaders can contain thefollowing information:

l content-disposition: To suggest a filenamefor an attachment, use"*;filename=<filename>" in this element.

Note: The HTTP servers may alter orignore the suggested name.

l content-type


l content-id


Note: When the content type is specified as"text/*" (for example, "text/xml"), theattachment content is in either thetextContent input element or the file namestoring the attachment is in the fileName inputelement. When the content type is anythingother than "text/*", the attachment content isin either the binaryContent input element orthe file name storing the attachment is in thefileName input element.




l binaryContent: content of the attachmentwhen the attachment is binary data.




232 | HTTP Palette





Output



Header complex The fields of the header specified on the OutputEditor tab.

For more information about these items, see thedescription of the Output Editor tab.

statusLine complex This field is the first line of the response message.This consists of the protocol version, a numericstatus code, and the text phrase explaining thestatus code.

For more information about status codes in theHTTP responses, see the HTTP specification atw3.org.

httpVersion string The HTTP method to use for the request. All HTTP

#SECTION_10223162896048DE8281CE213F9A0A80




233 | HTTP Palette


1.1 methods are supported, but the connectmethod is unnecessary because ActiveMatrixBusinessWorks automatically uses the CONNECTmethod when connecting through a proxy server.

If no method is specified in this element, bydefault the GET method is used.

statusCode string HTTP status codes in output represents the statusof the service. The codes also help to identify theproblems caused. For more information on thestandard HTTP status codes, see Status Code andReason Phrase at w3.org.

reasonPhrase string The message body of the HTTP request. Do notspecify this element when the method of therequest is GET.


binaryContent string The binary content of the response to the requestfrom the HTTP server.

asciiContent integer The ASCII content of the response to the requestfrom the HTTP server.

filePath string The location of the file on the disk at which thenon-MIME attachment is written.

Headers complex The header fields of the reply. The structure of thisoutput item is specified on the Output Headerstab.

DynamicHeaders complex The dynamic header is an additional headerparameter to add runtime headers to the outgoingHTTP messages. This element is specified in theInput tab.

https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1

https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1


234 | HTTP Palette


Note: You can use only US-ASCII characters inDynamicHeaders.

The dynamic headers consist of the followinginformation:



You can consider the following overridingconditions.

l Overrides the value of HeaderName withthe value found in DynamicHeaders if it is anon-repeating header. If more than oneoccurrence of this header is found underDynamicHeaders, it generates the followingexception.

The header [ headerName ] is defined as non-Repeating Header in Input Headers. This headercannot have multiple occurences inDynamicHeaders.

l If it is a repeating element, add therespective name or value pairs underDynamicHeaders, which is added to theexisting list maintained for this element.

l For a repeating element, if the new headername is not found under the Headerssection declared through TIBCO BusinessStudio for BusinessWorks, the following isadded into HTTP headers.




235 | HTTP Palette




mimeHeaders complex This element contains the mime header for eachmimePart. mimeHeaders can contain the followinginformation:

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


l content-type


l content-id


Note: When the content type is specified as"text/*" (for example, "text/xml"), theattachment content is expected to be in eitherthe textContent input element or the file namestoring the attachment is expected to be in thefileName input element. When the contenttype is anything other than "text/*", theattachment content is in either thebinaryContent input element or the file namestoring the attachment is in the fileName inputelement.






236 | HTTP Palette







Fault




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

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.


237 | HTTP Palette


The following are the details about Send HTTP Request activity threading policy.


DefaultThreadCount


Asynchronous Yes Dynamic This field can be configured by using theThread Pool shared resource.

Policy


with the Send HTTP Request activity, click the Add Policy to Activity icon. To edit

policy details, click Go to selected Policy icon. The Policy tab has the followingfields.

Field Description


Type The type of policy associated with the activity. The Send HTTP Requestactivity can support the Basic Credential Mapping policy.


Sending Data in the HTTP RequestYou can use several HTTP methods in an HTTP request. Each method sends data in therequest in a different manner. For example, the GET method uses the query string of theRequestURI to pass parameter and value pairs. Other methods use the HTTP message bodyto send data in the request.


238 | HTTP Palette

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

l Post Data: corresponds to the body of the HTTP message. All methods except theGET method accept data in this element.

l Query String: corresponds to the query string of the RequestURI. You can use thisinput element to dynamically construct the query string using an XPath expressionwhen you do not know the names or number of the input parameters for the requestuntil the activity executes.

l Parameters: corresponds to the parameters defined in the Parameters field on theGeneral tab. This is useful if you have a fixed set of parameters to send with therequest. For requests using the GET method, these parameters are passed as thequery string of the RequestURI. For requests using the POST method, theseparameters 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 POSTrequests, you can either specify parameters on the General tab and in the parametersinput element or you can specify a PostData input element. However, do not specify bothinput elements. In the case of a POST request, the PostData input element is ignored whenyou specify parameters on the General tab.

For GET requests, you can either specify the parameters on the General tab and in theparameters input element or you can specify a QueryString input element. If you know thelist of parameters for the request, configure the parameters on the General tab. If the listof parameters is not known until the activity executes, use the QueryString element.

However, when you specify all parameters on the General tab as Optional, you can usethe QueryString input element instead of the parameters input element. If any element inthe parameters element contains an expression, the QueryString element is ignored.

Special Characters in HTTP Requests

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

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


239 | HTTP Palette

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.

Wait for HTTP RequestWait for HTTP Request is a signal-in activity that waits for an incoming HTTP request in aprocess. The process instance suspends until the incoming HTTP request is received.

General



Description


HTTP Connection Yes HTTP Connector shared resource that describesthe host name and the port number on which theprocess waits for the incoming message.

For more information about specifying sharedresources, see HTTP Connector .

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

You can either specify both Context Path andPath Spec, any, or none of these elements. Forexample, the path displays inhttp://hostname.com/contextPath/pathSpec format.

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

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


240 | HTTP Palette


Description

In a Send HTTP POST request where a Path Specis not provided, add a forward slash (/) after theContext Path (for example:http://<host>:<port>/<contextPath>/). If you do not addthe forward slash, the POST request is redirectedas a GET request for the resource at <context_path>.

In a Send HTTP POST request where a Path Specis provided no forward slash (/) is required (forexample:http://<host>:<port>/<contextPath>/<pathSpec>).

Path Spec Yes If specified, it is added as a prefix of a URL of theform http://hostname.com/contextPath/pathSpec.

Output Style None The output message format. You can select eitherString or Binary format for the output messages.

Parse PostMethod Data

None Specifies whether the message body of the HTTPrequest should be parsed into a schema for theout of the activity.

When you select this check box, the parametersspecified in the Parameters field are used tovalidate the incoming request and parse it into theoutput schema. This field is present only when theOutput Style is String.

Note: For an incoming GET request, there is nomessage body, so this field has no effect on theincoming GET message body requests.

Parameters None The parameters of the incoming HTTP request. Youcan specify parameters in this table for theincoming request to be parsed and represented as


241 | HTTP Palette


Description

a schema in this output of the activity. For eachparameter, you must provide a name, datatype,and whether the field is Required, Optional, orRepeating.

Use the button to add parameters andbutton to remove parameters. Use the up anddown arrows to move parameters to new positionsin the table.

Note: Specifying parameters in this field parsesthe query string of the request into the outputschema, regardless of whether the Parse PostMethod Data check box is selected. Selectingthe Parse Post Method Data check box andspecifying the parameters in this field isrequired to parse the message body along withthe query string of the request.

HTTPAuthentication

None Specifies that the client sending the HTTP requestmust be authenticated. The user name andpassword specified in the incoming request mustexist in the LDAP server configured on HTTPConnector.

Expose SecurityContext

None Select this check box meant for Security ContextPropagation and Security Context, to make itavailable as a transport data in the mapping panel.

Default Encoding Yes Specifies the encoding to use, if no charset isspecified in the Content-Type header of themessage. This encoding is used for the messagebody and URL.


242 | HTTP Palette

Note: Imported projects display the HTTP Authentication check box under theGeneral section if the check box was selected in a previous version TIBCOActiveMatrix BusinessWorks™ 6.x. Authentication remains enabled on the Waitfor HTTP Request activity if you do not clear the check box. If you clear theAuthentication check box, a warning message is displayed prompting you toconfirm your action. To remove authentication from the activity, click OK. Onceyou have removed authentication from the Wait for HTTP Request activity, youcan reapply it using the Basic Authentication policy. For more information, see"Enforcing Basic Authentication" in the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Description

Provide a short description for the activity in this field.

Event

Field Description

EventTimeout(seconds)

This field specifies the amount of time (in seconds) a message waits, if it isreceived before this activity is executed. If the event timeout expires, an error islogged and the event is discarded. If no value is specified in this field, themessage waits indefinitely. If zero (0) is specified, the event is discarded.


A file change may occur before this activity is executed. This field specifies theamount of time (in milliseconds) to wait, if the file change occurs before thisactivity is executed in the process instance. If the event timeout expires, anerror is logged and the event is discarded.

Advanced



243 | HTTP Palette


Description

Fill StandardHeaders

None When this check box is selected, additional headerssuch as Authorization, User-agent, and Host arepopulated in the Dynamic Headers element in theserver response received from the client.

Write to File None Select this check box to specify that the incomingmessages whose body and attachments exceed thespecified threshold size, should be written to a fileinstead of stored in memory. With this you can acceptlarge incoming messages without consuming a greatdeal of memory.

Selecting this check box displays the Directory, CreateNon-Existing Directories, and Threshold Size fields.Keep this check box clear if you want to keep theincoming messages in memory.

Note: The files created using this option after theyare written, are not deleted automatically. Youmust manage the storage used by these files anddelete them when they are no longer in use.

Directory Yes The directory to write messages that are above thespecified threshold. The process engine does notattempt to create the directory if the specifieddirectory does not exist. Therefore, create the directorybefore starting the process engine.


None When you select this check box is, all directories in thepath specified in the Directory field are created, ifthey do not already exist.

If you do not select check box and there are one ormore directories in the specified path in the Directoryfield that do not exist, an exception is raised.


244 | HTTP Palette


Description


Yes The maximum size (in bytes) of an incoming messagethat can be kept in memory. Messages larger than thespecified size are written to a file in the specifieddirectory. The name of the file is the output so thatsubsequent activities in the process can access the fileand read its contents.

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

Output Editor

Output Editor tab describes the data structure for the HTTP request headers. You can usethe default structure, or you can alter the structure, if the incoming request has a specificdata structure for the header of the request.

Header Datatype Description

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

If no Accept header field is present, the client accepts allmedia types.

Accept-Charset

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

If no Accept-Charset header is present, the client accepts anycharacter set.

Accept-Encoding

string This field specifies the content-coding values that areacceptable for response messages. For example, compress, gzip.





245 | HTTP Palette


For more information about this header field, see the HTTPspecification at w3.org.

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

Content-Length

string This field indicates the size of the entity body (in decimalnumber of OCTETs) sent to the receiver. It also accounts forencoding the message body. For more information aboutwhen the message body is URL encoded, see SpecialCharacters in HTTP Requests.

Connection string Use this field to specify options required for this connection.For example, the close option specifies that you want theconnection to be closed when the request is complete.

Cookie string For more information about this field, see the HTTPspecification at w3.org.


Pragma string This field is used to include implementation-specific directivesthat might apply to the receiver. For more information aboutusing this field, see the HTTP specification at w3.org .

Conversations

You can join the conversation here. Click the Joining existing conversation button tojoin multiple conversations. For more information about conversations, see ApplicationDevelopment.

Output

The following is output for the activity.









246 | HTTP Palette


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

RequestURI string The address portion of the request. At runtime itwill contain the Query String after the questionmark (?), if it is sent in the HTTP Request.

HTTP-Versions string The version field of the HTTP request.

PostData orBinaryContent orFileName

string The message body of the HTTP request. Thecontent of this element depends upon whether themessage body is parsed. The parsing behavior iscontrolled by the Parse Post Method Data fieldon the General tab.

For more information, see Special Characters inHTTP Requests.

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

Header string The header of the HTTP request.

Protocol string This can be either HTTP or HTTPS, dependingupon the protocol used by the request.

Port string The port number on which the request wasreceived. This is the port number configured in theHTTP Connector shared resource.

DynamicHeaders complex The dynamic header is an additional headerparameter to add runtime headers to the outgoingHTTP Messages. This element is specified in theInput tab. DynamicHeaders consists of thefollowing information:




247 | HTTP Palette


You can consider the following overridingconditions:

l Overrides the value of HeaderName withthe value found in DynamicHeaders if it is anon-repeating header. If more than oneoccurrence of this header is found underDynamicHeaders, it generates the followingexception: "The header [ headerName ] isdefined as non-Repeating Header in InputEditor. This header cannot have multipleoccurences in DynamicHeaders."

l If it is a repeating element, add therespective name value pairs underDynamicHeaders. This is added to theexisting list maintained for this element.

l For a repeating element, if the new headername is not found under the "Headers"section declared through TIBCO BusinessStudio™ for BusinessWorks™, the following isadded to the HTTP Headers.


o Shows array of values, if foundrepeating in DynamicHeaders.



mimeHeaders complex This element contains the mime header for eachmimePart. Mime headers can contain thefollowing information:

l content-disposition: to suggest a filenamefor an attachment, use


248 | HTTP Palette


"*;filename=<filename>" in this element.

Note: HTTP servers may alter or ignorethe suggested name.

l content-type


l content-id

l any element


Note: When the content type is specified as"text/*" (for example, "text/xml"), theattachment content is in either thetextContent input element or the file namestoring the attachment is in the fileName inputelement. When the content type is anythingother than "text/*", the attachment content isin either the binaryContent input element orthe file name storing the attachment is in thefileName input element.


complex This element contains the mime attachment.





l mimeEnvelopeElement: If a server sends a



249 | HTTP Palette


response with nested attachments, it willreflect in this part at runtime. This elementcontains the message attachments. Thiselement contains a repeating elementnamed mimePart that contains each mimeattachment.


Context complex Contains information about the environment ofthe client.

This element holds the optional RemoteAddresselement.

RemoteAddress string The IP address of the client that submitted theHTTP request.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see the TIBCO ActiveMatrixBusinessWorks™ Error Codes guide.




The following are the details about Wait for HTTP Request activity threading policy.


250 | HTTP Palette

ActivityType

Multi-Threaded?

Default ThreadCount


Signal-in Yes l MinimumQTPThreads =10

l MaximumQTPThreads =75

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



Policy


with the Wait for HTTP Request activity, click the Add Policy to Activity icon. To

edit policy details, click Go to selected Policy icon. The Policy tab has the followingfields.

Field Description


Type The type of policy associated with the activity. The Wait for HTTP Requestactivity supports the Basic Authentication policy.

Note: Credentials authenticated on this activity are not used forpropagation during credential mapping.


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


251 | HTTP Palette

Note: When configuring an HTTP activity, configuring an HTTPConnector SharedResource as the value for a module property is not supported. Configure a literalvalue instead.

General


Field Description


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

FlushResponse

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 thereare a large number of Send HTTP Response activities in a job. In such cases,the Close Connection check box is selected in the last activity to indicate theresponse is complete.

However, selecting the Flush Response check box overrides this behaviorand causes the response to be flushed after each Send HTTP Responseactivity.

CloseConnection

Specifies that this activity contains the last part of an HTTP response. Thisfield is used when you have more than one Send HTTP Response activities ina process and each activity sends a part of the response to the client. AllSend HTTP Response activities in a process should have this check boxclear, except the last Send HTTP Response activity. Select this check box forthe last Send HTTP Response activity to indicate the response is complete.

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

Description



252 | HTTP Palette

Input Editor

Input Editor tab describes the data structure for the headers of the HTTP response. Youcan use the default structure, or you can alter the structure, if the outgoing response has aspecific data structure for the header of the request.

The header structure is defined by the HTTP protocol. See the HTTP Protocol specificationfor more information about the fields and content of the header of a HTTP request. Youcan obtain this specification at www.w3.org.

The following are the default header fields.


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 using thisactivity and the Retrieve Resources activity to retrieve a WSDLfile, you should set the type to text or xml when specifyingvalues 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-specific directivesthat might apply to the receiver. See the HTTP specification formore 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.

http://www.w3.org/


253 | HTTP Palette

Input



binaryContent binary The binary content of the response to therequest.

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

Headers complex The fields of the header specified on the InputEditor tab. See the description of the InputEditor tab for more information about theseitems.

Note: Only the first Send HTTP Responseactivity in the process can set the Headerselement. If your process contains multipleSend HTTP Response activities, the headersare set by the first activity and this element isignored for all subsequent activities.

DynamicHeaders complex The dynamic header is an additional headerparameter to add runtime headers to theoutgoing HTTP messages. This element isspecified on the Input tab. DynamicHeadersconsists of the following information:



You can consider the following overridingconditions:

l Overrides the value of the HeaderNamewith the value found in theDynamicHeaders, if it is a non-repeatingheader. If more than one occurrence of this


254 | HTTP Palette


header is found under DynamicHeaders, itthrows the following exception: The header[ headerName ] is defined as non-RepeatingHeader in Input Editor. This header cannothave multiple occurences inDynamicHeaders.

l If it is a repeating element, add therespective name value pairs underDynamicHeaders. This is added to theexisting list maintained for this element.

l For a repeating element, if the new headername is not found under the "Headers"section in TIBCO Business Studio™, thefollowing is added into the HTTP headers.

o Shows only one value, if found oncein the DynamicHeaders.



This element contains a repeating elementnamed mimePart that contains each mimeattachment.

mimeHeaders complex This element contains the mime header for eachmimePart. mimeHeaders can contain thefollowing information:

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


l content-type


255 | HTTP Palette



l content-id

l any element

See http://www.faqs.org/rfcs/rfc2045.html formore information about MIME headers and theirsyntax.

Note: When the content type is specified as"text/*" (for example, "text/xml"), theattachment content is either the textContentinput element or the file name storing theattachment is in the fileName input element.When the content type is anything other than"text/*", the attachment content is in eitherthe binaryContent input element or the filename storing the attachment is in thefileName input element.

binaryContent |textContent | fileName |mimeEnvelopeElements

choice This element is the content of the attachment.when the attachment is binary data. This elementcontains the mime attachment. The element canbe one of the following:




l mimeEnvelopeElement: If a server sends aresponse with nested attachments, it willreflect in this part at runtime. This elementcontains the message attachments. Thiselement contains a repeating elementnamed mimePart that contains each mime



256 | HTTP Palette


attachment.


Fault

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

Fault Thrown When..

HttpCommunicationException An HTTP exception occurred when sending the response.


257 | JAVA Palette

JAVA PaletteThe Java palette has activities for executing Java code as well as converting between Javaobjects and XML documents.

Configuring JAVA in an Application ModuleTo access JAVA code in , you need to configure the application module with JAVA nature.

New Project

To configure a new project with JAVA nature:

Procedure1. On the menu bar, click icon.

This opens the New BusinessWorks Application Module wizard.

2. Specify Project name and select the Use Java configuration check box and clickFinish.

In Project Explorer you see a JRE System Library <version> folder created in your


258 | JAVA Palette

project.

Existing ProjectTo configure an existing project with JAVA nature:

1. In the Project Explorer pane, right-click on the project and select Configure >Convert to Java Project.

2. Import and execute the existing JAVA source (which resides in the JAR file) inside thesame application module.

3. In the TIBCO ActiveMatrix BusinessWorks™ActiveMatrix BusinessWorks™ applicationmodule (which has java nature), select the lib folder.

4. Right-click and select Import > Import > General > File System.


259 | JAVA Palette

5. Click the Browse button of the From directory field and provide the location of jarfile.

6. Now click the Browse button of the Info folder field and select the jar file you wantto import to the lib folder, and click Finish.

This copies and places the jar file in the application module's lib directory and addsit to the classpath.

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

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

l The Java class public member should not have the public getter and setter methodsfor it.

l The Java class member public variable name is mapped to an XML element with thesame name. For example, a Java class member variable declared as public intZipCode is mapped to an XML element named ZipCode.

l The Java Bean accessors and modifiers are mapped to appropriate XML elementnames. For example, a Java class method public int getBalance() or public voidsetBalance(int Balance) are mapped to an XML element named Balance.

l Only one XML element is created regardless of how many members of the Java class


260 | JAVA Palette

share the same name. For example, there may be an attribute named MySalary andaccessors named getMySalary() and setMySalary(). This translates to one element namedMySalary in the resulting XML document.

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

l Use Java generics and provide the type information while declaring and creating thecollection for example,

Instead of using List list = new ArrayList();

use generics: List<String> list = new ArrayList<String>();

l The datatype java.util.Map or any types that extend java.util.Map are not supported. Forexample, HashMap is not supported.

l The variable name defined in the class should be exactly same as the getter andsetter methods defined for the same variable. Otherwise, there can be a schemageneration issue by JavaToXML and XMLToJava activities. For example, if a variablename is airfileRouteStartTime, names of the getter and setter methods must begetAirfileRouteStartTime(), and setAirfileRouteStartTime() respectively.

l Class should implement java.io.Serializable interface.

l The boolean variable names defined should not start with the keyword is. Forexample, "isemployee ". It conflicts with the getter and setter methods isemployee()and setemployee() and results in the schema generation issue.

Creating Custom XPath FunctionsThis topic provides the detailed procedure of creating a custom XPath function group. Youcan use the Custom XPath Function wizard to create your custom XPath function group. Ituses the com.tibco.xml.cxf.customXPathFunction extension.

Procedure1. Launch TIBCO Business Studio for BusinessWorks and select File > New > Project.

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


261 | JAVA Palette

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


262 | JAVA Palette

4. On the Plug-in Content page, locate the Options group and select This plug-in willmake contributions to the UI.


263 | JAVA Palette

5. Accept all of the defaults and click Next.


264 | JAVA Palette

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


265 | JAVA Palette

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

.


266 | JAVA Palette

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

• Prefix: The prefix for the functions

• Namespace: The namespace for the functions

• Help Text: The description of the functions

8. Specify the XPath Function and XPath Function Parameters in the XPath FunctionGroup Creation Section dialog.


267 | JAVA Palette

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

l Name: the name of the function

l Return Type: the return type of the function

l Description: the description of the function

10. Click the Add button located on the right side of the XPath Function Parameterstable. Specify values for the following parameters and click Finish:

l Name: the name of the parameter

l Type: the data type of the parameter

l Optional: select the check box if the parameter is optional.

11. The Open Associated Perspective dialog displays. Click Yes.

TIBCO Business Studio for BusinessWorksopens in Plug-in and the Plug-inDevelopment perspective.

12. Open the Java class in the newly created Custom XPath function plug-in andimplement the Custom XPath function.

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


268 | JAVA Palette

Note: The Custom XPath functions work only when the plug-in is markedas singleton.

Creating Custom XPath Functions with MultipleJava ClassesYou can also create custom XPath functions with multiple Java classes within the sameplug-in.

Before you beginCreate the custom XPath function in the plug-in. For more information, see CreatingCustom XPath Functions.

Procedure


269 | JAVA Palette

1. Create different classes in the same plug-in.

2. Update the category, prefix, and namespace for the newly created Java class as perrequirement. For example:

@XPathFunctionGroup(category = "Another Custom Function",prefix = "mytns2",namespace = "http://my.xpath2", helpText = "Another Custom definedfunction")

3. Navigate to plugin.xml and add custom XPath extensions on the Extensions tab.

4. To update the class name and id, on the Extension Element Details pane clickBrowse.

5. Create OSGi component for the newly created class as follows.

a. Create a copy of the existing cxf.xml.

b. For the newly created XML file, on the Overview tab of the Component pane,update Name, Factory ID, and Class fields .


270 | JAVA Palette

6. Repeat steps 3, 4, and 5 for other classes in the same plug-in.

7. Update the manifest file to include the OSGI-INF/cxf.xml, OSGI-INF/foo_cxf.xml, and OSGI-INF/next_cxf.xml service components.

8. Export the plug-ins and install into the host repository.

9. Restart TIBCO Business Studio for BusinessWorks.

ResultThe new XPath functions are available for use.

What to do nextRun the application and custom XPath functions execute from the same plug-in.

Using Custom XPath Function at Design Timeand 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


271 | JAVA Palette

Procedure1. Right-click the Custom XPath Function Plug-in project and select Export from the

menu. On the Export window, select Plug-in Development > Deployable plug-insand fragments and click Next.

2. Select the Install into host Repository radio button on the Deployable plug-insand fragments screen and click Finish.


272 | JAVA Palette

The Custom XPath function plug-in is exported into the TIBCO Business Studio forBusinessWorks instance to use at design time.

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

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


273 | JAVA Palette

5. In TIBCO Business Studio for BusinessWorks, the Custom XPath function is availablefor use in any activity mapper in a process.

Making Custom XPath Function Available at RunTime

l After using the Custom XPath function in an activity in a process at design time,include the Custom XPath function plug-in the application project.

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


274 | JAVA Palette

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 themapper.

Procedure1. On the menu bar, click Help > About TIBCO Business Studio for BusinessWorks™.

On Mac, this is located under the "BusinessWorks" menu.

2. Click Installation Details.

The following dialog box is displayed.

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

4. If you uninstall a custom XPath project from the {Tibco_Home} location, theCustomXpath.jar is not removed from the plugins folder. To remove the jar file:

a. In the file explorer, navigate to {tibco_home}\studio\4.0\eclipse folder.

b. Open the command prompt here and type the following command:

TIBCOBusinessStudio.exe -applicationorg.eclipse.equinox.p2.garbagecollector.application

The CustomXpath.jar is removed from the plugins folder.

5. Restart the workspace.

Java InvokeJava Invoke is a synchronous activity that can be used to invoke a Java class method. Youcan construct an instance of the specified Java class, if you invoke the constructor for theclass.


275 | JAVA Palette

General



Description


Java GlobalInstance

Yes Specify the resource in this field to execute methods onshared Java objects created by Java Global Instanceresources.

For more information about the shared Java objectscreated by Java Global Instance resources, see JavaGlobal Instance.

This disables the options on the Advanced tab. In thedrop-down list in the Method field, you can select themethod to execute.

Note: 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 inthe Java invoke method.

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


276 | JAVA Palette


Description

shared Java object.

Note: To log steps in appnode log, from the customjava code, add the jar file rg.slf4j(1.8.0) to ImportPackages under Module dependencies and in the javacode add the below code

import org.slf4j.*;...Logger logger = LoggerFactory.getLogger("mylogger");logger.info("my logger");

Under appnode, add the logger part in the logback.xml file

<logger name="mylogger"><level value="INFO"/></logger>

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

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

Custom Icon None Provide the location of icon image file.

Click the Choose a custom icon button to select theicon image file from your current workspace.

Click the Import an icon from the file systembutton to select an icon image from your file system.

Select the Clear Value button to remove the fieldvalue.


277 | JAVA Palette


Description

Important: TIBCO recommends to use image file ofsize 48 by 48 pixels and of the form .png, .jpg, or .jpeg.

Parameters None The parameters for the Java Invoke activity. Thiselement is available when the MultiOutput check box isselected.

This element contains a list of input and outputparameters that are required for the Java invoke. Thiselement is not available when the selected method hasno parameters.

Each Input and Output parameter has the followingfields.

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

l Field Name: The name of the parameter. Whencreating a new parameter, provide the name of theparameter. The setter/getter methods getautomatically generated for the same, or select theoptions from the drop-down list of the names ofclass member variables that have setter/gettermethods.

l Type: The datatype of the parameter. The defaultis string. Specify one of the supplied Java primitivetypes, or specify Object Reference when acceptinga Java object from another Java activity as input.

l Occurrence: Specify whether the parameter isRequired, Optional, or Repeating.

l Click to add the input parameter.

l Click to add the output parameter.

l Click to delete the parameter.


278 | JAVA Palette

Description

Provide a short description for the Java Invoke activity.

Advanced



Description

Instantiatethereferencedclass

None This field controls one of the following:

l The referenced class must be constructed when theactivity is executed,

l An object reference must be supplied in theactivity’s input schema.

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

Do not select this check box, if you want to provide anobject reference for the class name specified on theGeneral tab. The object must be created and contained inthe output schema of a previously executed activity.

In this case, the referenced class is included in theactivity’s input schema.

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

Cache theobject

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 thisJava Invoke activity share the instance of the instantiatedreferenced class. A cached referenced object is kept in thememory until the process engine terminates.


279 | JAVA Palette


Description

Not selecting this check box leads to each instance of thisJava Invoke activity creating its own copy of thereferenced class.

InvokeCleanupMethod

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

When selected, you can invoke a method on the cachedobject before the object is released from memory, whenthe process engine terminates. You can perform cleanupactivities, such as closing connections, updating databasetables, and so on.

Select this check box to display the Cleanup Method field.

CleanupMethod

None This field is available only when the Invoke CleanupMethod check 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,therefore only methods with no parameters are listed inthis field. Any values returned by the selected method areignored, but exceptions raised by the selected method aresent to the log.

Input



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


280 | JAVA Palette


This element is not available when the selected method hasno parameters.

Output



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

This element is not available for methods that returnvoid.

Parameters varies The Output tab lists all output parameters specifiedon the General tab.

Selecting MultiOutput on the General tab makes thisoutput item available.

Fault

The Fault tab lists the exceptions generated by this activity. Selecting a method to invokelists the exceptions generated by the method.

In the Java Invoke activity:

l If MultiOutput is selected, the Fault tab generates the InvocationException exceptionwith error schema element as msg, msgCode, methodName, exceptionClassName,exceptionMessage.

l If MultiOutput is not selected, the Fault tab displays the exceptions generated bythe method selected in it with error schema elements as: 1:Java exception Object2:exceptionClassName 3:exceptionMessage

l If MultiOutput is not selected and method does not generate any exception, againthe Fault tab shows InvocationException with error schema element as msg, msgCode,methodName, exceptionClassName, and exceptionMessage.


281 | JAVA Palette

Error SchemaElement


msg string The error messageFor more information, see ErrorCodes.

msgCode string The error codeFor more information, see Error Codes.

methodName string The name of the Java method that raised theexception.

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 acustom starter written in Java.

Java Process Starter Abstract Class

The JavaProcessStarter abstract class defines the interface of your Java Process Starterwith the application. You must define an implementation for the following methods:

l init() : this method is called when the process engine starts up. This method shouldinitialize any resource connections. You could also specify a Java global instance onthe Advanced tab that initializes resource connections. Java global instances are alsoloaded and initialized during application start up. You can call this.getJavaGlobalInstance() to obtain the Java global instance resource in your process

starter code.

l onStart() : this method is called by the process engine to activate the process starter.This method should activate any event notifier or resource observer code. The


282 | JAVA Palette

notifier or observer code can then call the onEvent() method to start a processinstance.

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

l onShutdown(): this method is called by the application when the AppNode shuts down.This method should release any resources and resource connections and perform anyrequired clean up operations.

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

l onEvent(Object object): this method is called when a listener or resource observercatches a new event. The input to this method is a Java object containing the eventdata.

l getGlobalInstance(): this method returns an object reference to the Java global resourcespecified on the Advanced tab of the process starter. This is useful if you want toplace initialization code or other shared information in a Java global resource insteadof in the init() method of this class.

l onError(): this method throws the exception specified in the input parameter. Use thismethod to propagate an error to the process instance when a listener or resourceobserver 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 JavaInvoke or XML To Java activities. These Java objects can be passed using an outputparameter to another activity later in the process definition. The Java Invoke activityreceiving a Java object accepts the object into an input parameter. Map the output Javaobject to the input object of the receiving Java Invoke object.

Note: Any Java objects passed by input and output parameters betweenactivities should have the capability to serialize.

General



283 | JAVA Palette

Field ProcessProperty

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 andInit Parameters table.

Init Method No Selecting the Initialize with Parameters check box displaysthis field.

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

InitParameters

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

l Parameter Name: the name of the parameter.

l Parameter Type: the datatype of the parameter.

l Parameter Value: specify a default value for theparameter.

Description


Advanced



284 | JAVA Palette

Field Description

Sequencekey

This field can contain an XPath expression that specifies which processesshould run in sequence. Process instances with sequencing keys that evaluateto the same value are executed in the sequence the process instance wascreated.

Custom JobId

This field can contain an XPath expression that specifies a custom job ID forthe process instance.

Java GlobalInstance

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

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

Output



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

By default, this element is a Java object reference.

Fault

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

Error Schema Element Datatype Description

msg string The error message. For details, refer to Error Codes.

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


285 | JAVA Palette

Java To XMLJava To XML is a synchronous activity. You can use this activity to convert Java object'sdata members into an XML document.

Note: If the class does not have a public data member and only has a Java beanmodifier that sets the data, the input schema contains an element for themodifier, but the resulting XML document has no value set for the correspondingelement. 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 notpublic. In this case, an element named ID in this activity’s output schema exists,but that element has no value because there is no public mechanism for gettingthe data.

General


Field ModuleProperty

Description

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

ClassName

No The class name in the Java schema to use.

Use the Browse button to bring up the dialog to select theJava class.

Click the Reload button to regenerate the schema.

Description

Provide a short description for the Java to XML activity.

Advanced



286 | JAVA Palette

Field Description

Instantiatethereferencedclass

This field controls one of the following:

l The referenced class must be constructed when the activity is executed.

l 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 class is notincluded in the activity’s input schema.

Do not select this check box if you want to provide an object reference for theclass name specified on the General tab. The object must be created andcontained in the output schema of a previously executed activity.

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

Cache theobject

This option is available only when you select the Instantiate the referencedclass check box.

Select this check box to specify that all instances of this Java Invoke activityshare the instance of the instantiated referenced class. A cached referencedobject is kept in the memory until the process engine terminates.

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

Input


Input item Datatype Description

referencedclass

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

Output



287 | JAVA Palette


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 generated by this activity. For more informationabout error codes and the corrective action to take, see the ActiveMatrix BusinessWorksError Codes.


JavaToXMLConversionException An error occurred when converting the Java object to XML.

XML To JavaXML to Java is a synchronous activity. Use this activity to create an instance of a Javaobject based on data from an XML document. The XML schema for providing the input tothe Java object or Java schema specified on the General tab of this activity.

The specified Java class must meet the following requirements:

l The Java class must have a public default constructor (that is, a constructor with noarguments).

l The Java class must be eligible to be serialized (that is, the class must implement orbe 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 thatretrieves the data, the input schema contains an element for the accessor. However, theresulting Java object has no value set for the member. For example, the object has amethod declared as public int getID(), but there is no method for setting the ID and the datamember ID is not public. In this case, an element named ID in this activity’s input schema,but mapping a value to the element does not result in setting the ID member of the outputJava object. This is because there is no public mechanism for setting the data.


288 | JAVA Palette

General



Description

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

ClassName

No The class name in the Java schema to use.

Use the Browse button to bring up the dialog to select theJava class.

Description

Provide a short description for the XML to Java activity.

Input


InputItem


XMLSchema

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



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


289 | JAVA Palette

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the possible corrective actions, see the ActiveMatrix BusinessWorksError Codes.


XMLToJavaConversionException An error occurred when converting the XML schema to aJava object.


290 | JDBC Palette

JDBC PaletteThe JDBC palette contains activities for querying, updating, or calling stored procedures inthe database.

JDBC Call ProcedureJDBC Call Procedure is an asynchronous activity that calls a database procedure orfunction using the specified JDBC connection. If this activity is not part of a transactiongroup, 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 backwith the other JDBC activities in the group at the end of the transaction.

To override the default behavior of transaction groups for certain JDBC activities in atransaction group, select the Override Transaction Behavior check box on the Advancedtab. This specifies that the activity is outside of the transaction and the SQL statement iscommitted when the activity completes, even if the activity is in a transaction group.

General



Description


JDBCSharedResource

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

For more information about JDBC resources, see JDBC


291 | JDBC Palette


Description

Connection.

Timeout(sec)

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

Maximumrows

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

Description

Provide a short description for the JDBC Call Procedure activity.

Procedure

The Procedure tab has the following fields.


Description

Schema Yes The schema in which the procedure resides. Thisname is used to resolve naming conflicts, if more thanone schema in the database has the selectedprocedure with the same name.

Configure the Schema field to use a ProcessProperty or a Module Property if a schema has beendefined for the project, and you know the schemaname. To search for a schema, configure the field touse a Literal Value, and click the Browse button toselect a schema from the database that is using thespecified JDBC Connection.


292 | JDBC Palette


Description

Catalog orPackage

Yes The catalog or package in which the procedureresides. This name is used to resolve naming conflictsif more than one catalog or package in the databasehas selected procedures with the same name.

Configure the Catalog or Package field to use aProcess Property or a Module Property if a catalogor package has been defined for the project, and youknow their names. To search for a catalog or package,configure the field to use a Literal Value, click theBrowse button, and select a catalog or package fromthe database using the specified JDBC Connection. Ifa schema is specified in the Schema field, onlycatalogs or packages in the specified schema arelisted.

This field is only applicable to databases with morethan one catalog and package.

For more information about catalogs and packages,see your database documentation.

Procedure /Function

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

Click the Browse button to select the database foravailable procedures or functions after specifying theJDBC Connection field.

Click the Refresh button to retrieve the changes fromthe database, if you change the parameters orsignatures while editing your project.

The list of available procedures and functions islimited by the values supplied in the Schema andCatalog or Package fields.


293 | JDBC Palette


Description

Parameters No This field displays the parameters for the procedureand you can override the data type (IN, OUT, IN/OUT)for each parameter in the Direction column.

The parameters listed in the table show theParameter Name, Data Type, and the Direction (IN,OUT, IN/OUT) of the each parameter. All IN andIN/OUT parameters listed in the Parameters table areshown on the Input tab of the activity for the user toprovide values.

Advanced


Field Description

ThreadPoolSharedResource

Specifies a queue of threads available to run a queue of tasks. Threadpools are used to improve performance when executing large numbersof asynchronous tasks by reducing per task invocation overhead, providea means of bounding, and managing the resources consumed whenexecuting a collection of tasks.

OverrideTransactionBehavior

Overrides the default behavior of a transaction group. If this activity is ina transaction group, the activity is normally committed or rolled backwith the other transactional activities.

Select this check box to specify that this activity is not part of thetransaction group and is committed when it completes. Also, select thischeck box to use a separate database connection to perform the activityand commit the SQL statement.

Override JDBCConnection

Selecting this option overrides the default datasource connection, andallows for SQL queries to be executed against the optional datasource.


294 | JDBC Palette

Field Description

After selecting this option, the sharedResourceName field is enabledunder the Input > Data Source tab. From the sharedResourceNamefield, type the complete path with the name of the optional datasource,which can be found under the Resources folder. For example, if a JDBCshared resource is located at Resources > Package_Name > JDBC_SR_Name, then the value you enter should be Package_Name.JDBC_SR_Name. The value you enter in the XPath Expression field is casesensitive and must be a string.

To avoid mapping issues, ensure the optional datasource maintains astructure that is identical to the default database, and that bothdatasources are using the same datatypes.

Note: Transactions between multiple datasources is not supported.

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 toset input elements explicitly to null.

ResultSets UseSchema

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

When selected, TIBCO Business Studio for BusinessWorks tries to invokethe stored procedure with default values and get the metadata for theresultset.

If the check box is not selected, or if TIBCO Business Studio forBusinessWorks does not get any metadata, the results are displayed as’unknown resultsets’.

Interpret InvalidXML Chars

Specifies how invalid characters should be handled. If the check box isclear and invalid characters are sent from the database to ActiveMatrixBusinessWorks, the call procedure execution fails.

On the other hand, if invalid characters are sent, and the check box is


295 | JDBC Palette

Field Description

selected, ActiveMatrix BusinessWorks executes it successfully.

Override S/ADataType Schema

Select the check box to override the schema appended to the objecttype parameter. The schema in the Schema field on the Procedure taboverrides the schema in the Parameters field at run time.

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

Input

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


inputs complex The input parameters of the database procedure. Thedatatype contained in this element varies dependingupon the parameters specified for the databaseprocedure.

The IN and IN/OUT parameters displayed in theParameters table on the Procedure tab are displayedhere for the user to set values.

You can see inputSet once you select Procedure in theGeneral tab.

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.


296 | JDBC Palette

Output

The output of the activity is depends upon the output parameters of the databaseprocedure.


outputSet complex The output of the database procedure. Thedatatype contained in this element variesdepending upon what the database procedurereturns.

UnresolvedResultSets string The output of the database procedure may returnother result sets. These result sets are returned inthis output item as an XML string. Create a schemaresource to describe these result sets, and then usethe Parse XML activity to parse the XML based onthe schema. You can then use the parsed output insubsequent activities.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the possible corrective action to take, see the ActiveMatrixBusinessWorks Error Codes.


JDBCConnectionNotFoundException An error occurred when attempting to connect to thespecified database.

InvalidTimeZoneException An invalid time zone was specified.

JDBCSQLException An SQL error occurred.

LoginTimedOutException A timeout occurred while attempting to connect to thedatabase.



297 | JDBC Palette

JDBC QueryJDBC Query is an asynchronous activity that performs the specified SQL SELECTstatement. 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 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 JDBCactivities in a transaction group, you can select the Override Transaction Behavior checkbox on the Advanced tab. This specifies that the activity is outside of the transaction andthe SQL statement is committed when the activity completes, even if the activity is in atransaction group.

Note: Do not use the Override JDBC Connection option in a transaction.Selecting this option in a transaction results in failure of the transaction.

General



Description

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

JDBCSharedResource

Yes The path to the shared configuration resource containingthe JDBC connection information. For more information,see JDBC Connection.

Timeout(sec)

Yes The time (in seconds) to wait for the query to complete. Ifthe query does not complete in the given time limit, anerror is returned.

Maximumrows

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


298 | JDBC Palette

Description

Provide a short description for the JDBC Query activity.

Statement

The Statement tab has the following fields.

Field Description

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

PreparedStatement

The Prepared Statement contains the Parameter Name and Data Typefields. All the parameters defined in the Prepared Statement table are shownin the Input 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 preparedstatements are named Parameter1, Parameter2, and so on. You must supply the datatypeof each parameter to the SQL statement, and this data type is used in the input schema forthe statement.

Execute the Query Button

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

SQL Button

Launch Eclipse SQL Builder. For more information about using the SQL Query Builder tovisually build queries, see Eclipse Documentation at eclipse.org.

Fetch Button

https://help.eclipse.org/


299 | JDBC Palette

Using the Fetch button on this activity, you can synchronize the activity with the contentsof the database. When you first configure a JDBC activity, click the Fetch button to retrievethe schema for the output result set before applying your changes by saving your project.

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

Advanced


Field Description



Loop Subset inCalling Processes

Note: This field can be activated on selecting the Process in Subsetscheck box.

Use this field to configure the loop with lastSubset in another process.This another process calls the subprocess in which the JDBC Queryactivity is used.

Provide the names of the processes as a comma separated list.

For example, mypackage1.myprocess1,mypackage2.myprocess2.

If no input is provided for this field and the Loop Subset in CurrentProcess is also not selected it means the loop is in a direct call processof the subprocess.

Either Loop Subset in Calling Processes or Loop Subset in CurrentProcess can be selected at a time.

Loop Subset inCurrent Process

Note: This field can be activated on selecting the Process in Subsetscheck box.


300 | JDBC Palette

Field Description

Select this check box to configure the loop with lastSubset inside thecurrent process for activity.

Either Loop Subset in Calling Processes or Loop Subset in CurrentProcess can be selected at a time.



This activity is not part of the transaction group and is committed whenit completes, when this check box is selected. Selecting this option usesa separate database connection to perform the activity and commit theSQL statement.



Note: Do not use the Override JDBC Connection option in atransaction. Selecting this option in a transaction results in failure ofthe transaction.

After selecting this option, the sharedResourceName field is enabledunder the Input > Data Source tab. From the sharedResourceNamefield, type the complete path with the name of the optional datasource,which can be found under the Resources folder. For example, if a JDBCshared resource is located at Resources > Package_Name > JDBC_SR_Name, then the value you enter should be Package_Name.JDBC_SR_Name.The value you enter in the XPath Expression field is case sensitive andmust be a string.



Use Nil Specifies whether NULLs are represented as optional schema elements


301 | JDBC Palette

Field Description

or whether each item that can contain a NULL has subitems.

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-lengthstrings, when this check box is not selected. Whether you use this fieldor not, you can still use XPath to set input elements explicitly to null.

Note: Many databases treat empty strings and nulls as the same, sothis field does not affect how the database interprets empty strings.

Interpret InvalidXML Chars

Specifies how invalid characters should be handled.

If the check box is clear and invalid characters are sent from thedatabase, the JDBC Query execution fails. When the check box isselected and invalid characters are sent, executes it successfully.

Process In Subsets Selecting this check box activates the Loop Subset in Calling Processesand Loop Subset in Current Process fields.

This field provides the option to process the result set in smaller batchesrather than processing the entire result set at once. When this check boxis selected, the subsetSize input element is displayed for you to specifythe size of each batch of records you want to process. Also, thelastSubset output element is displayed and is set to true when the lastbatch of records is being processed.

Not selecting this check box returns the whole result set.

Override SQLStatement

Selecting this check box overrides the SQL SELECT statement specifiedon the Statement tab, and enables you to add a new SQL statement onthe Input tab.

Tip: To connect to another database that has a schema with thesame table structure, select the Override JDBC Connection checkbox. After doing this, go to the Input tab, and specify a SharedResource at sharedResourceName.


302 | JDBC Palette

Input




timeout number The time (in seconds) to wait for the query to complete.If the query does not complete in the given time limit, anerror is returned.


SqlStatement string Displays after the Override SQL Statement check box onthe Advanced tab has been selected. This is the SQLSELECT statement to perform in the database. You canuse a SQL Builder wizard to build the query for thedesired database. You can also use a module propertyhere.

Note: If you create a new SQL statement, ensure thenew statement does not differ from the outputschema specified on the Output tab. If the new SQLstatement does not match the output schema, anerror is generated at run time. The output schema isdetermined from the original SQL statement on theStatement tab.

Output


OutputItem


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


303 | JDBC Palette

OutputItem


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

Fault






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.


JDBC UpdateJDBC Update is an asynchronous activity that performs the specified SQL INSERT, UPDATE,or DELETE statement.


304 | JDBC Palette

If this activity is not part of a transaction group, the SQL statement is committed after theactivity completes. If this activity is part of a transaction group, the SQL statement iscommitted or rolled back with the other JDBC activities in the group at the end of thetransaction.

If you want to override the default behavior of transaction groups for certain JDBCactivities in a transaction group, you can select the Override Transaction Behavior checkbox on the Advanced tab.

Note: Do not select the Override Transaction Behavior checkbox for a JDBCresource in a transaction group.

This specifies that the activity is outside of the transaction and the SQL statement iscommitted when the activity completes, even if the activity is in a transaction group.

The SQL statement is committed after the activity completes.

General



Description


JDBCSharedResource


For more information, see JDBC Connection.

Timeout(sec)


Description

Provide a short description for the JDBC Update activity.


305 | JDBC Palette

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.

PreparedStatement

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 for informational purposes only, you must make sure theparameters in this field correctly correspond to the statement.

Advanced


Field Description



Insert if recorddoesn't exist

Select this check box to insert the record if it does not exist in thedatabase.

OverrideTransaction

Overrides the default behavior of a transaction group. If this activity is ina transaction group, the activity is normally committed or rolled back


306 | JDBC Palette

Field Description

Behavior with the other transactional activities.

If you select this check box, this activity is not part of the transactiongroup and is committed when it completes. Selecting this option uses aseparate database connection to perform the activity and commit theSQL statement.



After selecting this option, the sharedResourceName field is enabledunder the Input > Data Source tab. From the sharedResourceNamefield, type the complete path with the name of the optional datasource,which can be found under the Resources folder. For example, if a JDBCshared resource is located at Resources > Package_Name > JDBC_SR_Name, then the value you enter should be Package_Name.JDBC_SR_Name.The value you enter in the XPath Expression field is case sensitive andmust be a string.


Note: Transactions between multiple datasources are not supported.

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 where emptystrings are supplied.

When the check box is not selected, empty strings are treated as zero-length strings. Whether you use this check box option or not, you canstill use XPath to set input elements explicitly to null.

Note: Many databases treat empty strings and nulls as the same, sothis check box does not affect how the database interprets emptystrings.


307 | JDBC Palette

Field Description

Batch Update Selecting this check box signifies that you want to perform multiplestatements by supplying an array of records as input to the activitywhere each record matches the prepared parameters for the statement.The statements are performed in one batch at the end of the activity’sexecution.

If you do not select this check box, the expected input is the list ofprepared parameters for the statement (no array of records). Somedatabase drivers may not support batch updates. A JDBCSQLException isgenerated, if the database driver does not support batch updates.

Input



Record complex This field appears when the Batch Update checkbox is selected on the Advanced tab.

InsertStatement string This field appears when the Insert if recorddoesn't exist check box is selected on theAdvanced tab.


timeout number The time (in seconds) to wait for the query tocomplete. If the query does not complete in thegiven time limit, an error is returned.

sharedResourceName string This field appears when the Override JDBCConnection check box is selected on the Advancedtab.

Output



308 | JDBC Palette


noOfUpdates integer The number of updates performed by the statementspecified on the General tab.

This element can also return -2 that indicates, in the event ofa batch update, that the updates were successful, but it isunknown how many updates were performed.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see ActiveMatrix BusinessWorks ErrorCodes.






InvalidSQLTypeException A parameter’s datatype does not match the datatype ofthe table column.


SQL DirectSQL Direct is an asynchronous activity that executes an SQL statement that you supply.With this activity you can build an SQL statement dynamically using other activities, thenpass the SQL statement into this activity's input. You can use this activity to execute DDL


309 | JDBC Palette

SQL statements like CREATE and DROP. You can also execute SQL statements that are notsupported by other activities in the JDBC palette.

If this activity is not part of a transaction group, the SQL statement is committed after theactivity completes. If this activity is part of a transaction group, the SQL statement iscommitted or rolled back with the other JDBC activities in the group at the end of thetransaction.

General



Description


JDBCSharedResource


For more information, see JDBC Connection.

Timeout(sec)


Maximumrows

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

Description

Provide a short description for the SQL Direct activity.

Advanced



310 | JDBC Palette

Field Description

ThreadPoolSharedresource

Specifies a queue of threads available to run a queue of tasks. Threadpools are 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 whenexecuting a collection of tasks.



If you select this check box, this activity is not part of the transactiongroup and is committed when it completes. Selecting this option uses aseparate database connection to perform the activity and commit theSQL statement.



After selecting this option, the sharedResourceName field is enabledunder the Input > Data Source tab. From the sharedResourceNamefield, type the complete path with the name of the optional datasource,which can be found under the Resources folder. For example, if a JDBCshared resource is located at Resources > Package_Name > JDBC_SR_Name, then the value you enter should be <Package_Name>.<JDBC_SR_Name>. The value you enter in the XPath Expression field is casesensitive and must be a string.



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

Input



311 | JDBC Palette


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 the query does not complete in the specified time limit,an error is returned.


Output



noOfUpdates string The number of updates performed by the statementspecified on the General tab.

This element can also return -2 that indicates, in theevent of a batch update, that the updates weresuccessful, but it is unknown how many updates wereperformed.

unknownResultSet string The result of the database statement. The resultelement depends upon what is returned by thestatement.

The result set is a list of zero or more rows with zero ormore columns. Each column contains a name and avalue element. You can use XPath expressions toretrieve the desired row and column from the resultset. There can be multiple result sets returned by thestatements executed by this activity.


312 | JDBC Palette


Because of this, this output item is a repeatable list ofresult sets. The first item in the list of result setscorresponds to the result set returned by the firststatement executed by this activity. The second item inthe list of result sets corresponds to the result setreturned by the second statement executed by thisactivity, and so on.

Fault









313 | JMS Palette

JMS PaletteJava Message Service (JMS) is a specification about sending and receiving messagesbetween two or more applications in a Java environment. The JMS palette is used to sendand receive JMS messages in a process.

The models supported are:

l Point-to-Point (queues): Message delivered to one recipient

l Publish/Subscribe (topics): Message delivered to multiple recipients

JMS supports these two models by using distinct interfaces within the API for eachmessaging model.

For more information about JMS and its message models, see the documentation of theJMS provider or JMS specifications.

Common JMS Properties and HeadersJMS properties comprise message headers and message properties. MessageHeaderproperties are set by the JMS client sending the message. You can view these after themessage is received. You can also set MessageProperties on the outgoing messages on theInput 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 should besent.


314 | JMS Palette

MessageHeadersProperty

Dataype Description

JMSDeliveryMode string The delivery mode of the message. Can be one of thefollowing:

l PERSISTENT: signifies the messages are stored andforwarded.

l 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 provider tobe sent. The time is expressed as the amount of time, inmilliseconds, 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.

JMSPriority integer The priority of the message. Priority is a value from 0-8.Higher numbers signify a higher priority (that is, 8 is ahigher priority than 7).

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 type ofthe message. Some JMS providers use this property todefine messages in the provider’s repository.

For more information about the use of this field, see theJMS provider documentation.


315 | JMS Palette

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 oftime, 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.


316 | JMS Palette

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 thespecified queue. You can use this activity to perform a receive operation on the queue asopposed to waiting for a queue message to be delivered to the Wait for JMS QueueMessage activity.

You can use the Message Selector field on the Advanced tab to retrieve a specific queuemessage from the queue.

General



Description



317 | JMS Palette


Description

JMSConnection

Literal Value

Module Property

The JMS connection. For more information, see JMSConnection.

Destination Yes The name of the queue from which to retrieve themessage.

The syntax of the destination name is specific to theJMS provider you are using. For more informationabout queue names, see the JMS providerdocumentation.

Message Type None The type of the message. This can be one of thefollowing:

l Text: the message is a java.lang.String.

l Byte: a stream of bytes.

l Map: a set of name or value pairs. The namesare strings, and the values are simpledatatypes (JAVA primitives), an array of bytes(use the Binary datatype when mapping thisdata), or a string. Each item can be accessedsequentially or by its name.

l Object: a Java object that can be serialized.

l Object Ref: an object reference to a Javaobject.

l Simple: a message with no body part.

l Stream: a stream of Java primitives, strings,or arrays of bytes. Each value must be readsequentially.

l XML Test: the message is XML text.


318 | JMS Palette


Description

AcknowledgeMode

Yes The acknowledge mode for incoming messages. Itcan be one of the following:

l Auto: the message is automaticallyacknowledged, when it is received.

l Client: the message is acknowledged at alater point by using the Confirm activity. If themessage is not confirmed before the processinstance ends, the message is redelivered anda new process instance is created to handlethe new incoming message. Ensure that yourprocess confirms the message when using theacknowledge mode.

l Dups Ok: the message is acknowledgedautomatically when it is received. JMSprovides this mode for lazy acknowledgment,but TIBCO Cloud Integration acknowledgesmessages upon receipt.

l TIBCO EMS Explicit Client: (only available forTIBCO Enterprise Message Service) a messagewhich is not acknowledged using the Confirmactivity before the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and onesession handles all incoming messages foreach process instance.

l TIBCO EMS Explicit Client Dups OK: (onlyavailable for TIBCO Enterprise MessageService) a message which is notacknowledged using the Confirm activitybefore the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and one


319 | JMS Palette


Description

session handles all the incoming messages foreach process instance. The messageshowever, are lazily acknowledged.

l TIBCO EMS No Acknowledge: messagesdelivered using this mode do not requireacknowledgment. Therefore, messages in thismode are not redelivered regardless ofwhether the delivery was successful.

Default MapType Value

Yes When the message is sent with the message type asMap, the optional XML schema elements havingdata type as Int, Integer, Float, Decimal, or Doublewith null values, and the Default Map Type Valuecheck box is selected, then the default value isadded while creating the node at the receiver sidefor respective element, otherwise the node is notcreated.

Description

Provide a short description for the Get JMS Queue Message activity.

Advanced


Field LiteralValue/ProcessProperty

Description

MessageSelector

Yes A string to determine whether a message should bereceived. The syntax of the message selector isdetermined by the JMS provider (where message


320 | JMS Palette

Field LiteralValue/ProcessProperty

Description

properties are used instead of table column names).

For more information and syntax for a message selectorstring, see the JMS provider documentation.

ApplicationPropertiesType

None The type of application-specific message properties thatis part of the message.

JMS FetchTimeout

Yes This field specifies the amount of time (in milliseconds)that the JMS Consumer waits to fetch message from thequeue before it times out. If set to zero (0), the JMSConsumer does not time out.

Note: JMS Fetch Timeout must be less than ActivityTimeout in the Input tab.

Output Editor

The Output Editor tab defines the schema to use for messages of type Map, Stream, orXML Text. Map messages are name or value pairs, and using this schema you can define thestructure of the retrieved destination queue message. The schema defined on the OutputEditor tab becomes the body of the message on the Output tab. For XML Text messagetype, select an XSD element. For Map and Stream message types, select an XSD type in theOutput Editor tab.

Input



destinationQueue string The queue to which to send the request. This input itemoverrides the Destination field on the General tab.


321 | JMS Palette


timeout integer This field specifies the amount of time (in milliseconds)that the activity waits before it times out. If set to zero(0), the activity times out after default time, which isthree minutes.

selector string A string to determine whether a message should bereceived. The value of this element overrides any valuespecified in the Message Selector field on theAdvanced tab. The syntax of the message selector isdetermined by the JMS provider, but it is usually asubset of SQL92 (where message properties are usedinstead of table column names).

For more information and syntax for a message selectorstring, see the JMS provider documentation.

Output



JMSHeaders complex The message header fields for the message. For moreinformation about message header fields, see CommonJMS Properties and Headers.

Only properties applicable to this type of message aredisplayed.

JMSProperties complex The message properties for the message. For moreinformation about message properties, see CommonJMS Properties and Headers.


Body as permessage

The body of the message.


322 | JMS Palette


type

DynamicProperties complex Dynamic properties is an additional parameter to addruntime property to the outgoing JMS messages thatare specified in the Input tab. This is an optionalelement with only one instance. Dynamic property canhave multiple property elements.

Each property element denotes a single dynamicproperty and can contain the following elements:

l Name - Required. Name of the property withone instance.

l Value - Required. Value of the property with oneinstance.

l Type - Optional. Type of the property. If notprovided, it is considered as string.

The following data types are supported:

l string

l boolean

l short

l integer

l long

l float

l double

l byte

Note: The DynamicProperty overwrites the value ofa property (with the same name) added using theJMS Application Property. The DynamicPropertiesare also added to the outgoing message.


323 | JMS Palette

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see ActiveMatrix BusinessWorks ErrorCodes.


JMSInvalidInputException The input to the activity is not valid.

JMSSessionCreateException The JMS session could not be created.

JMSReceiveException The JMS receive operation failed.


JMS Receive MessageJMS Receive Message is a process starter activity that starts the process based on thereceipt of a message for the specified JMS destination.

General



Description


Messaging Style Yes Select from one of the following availablemessaging style options:

l Generic: This options corresponds to an


324 | JMS Palette


Description

abstract JMS Destination. If you are not surewhether your destination is a Queue or Topic,select Generic.

l Queue

l Topic

JMSConnection

None The JMS connection. For more information, see JMSConnection.

Destination Yes The JMS destination from where the process starterreceives the message.











325 | JMS Palette


Description

DurableSubscriber

Yes Specifies a durable subscription.

You must specify a name in the Subscription Namefield that is registered with the JMS application asthe durable subscriber name. This field is onlyavailable if the Messaging Style is Topic.

SubscriptionName

Yes The subscription name registered with the JMSapplication for durable subscriptions. This field isonly available when you select the DurableSubscriber check box.

After creating a durable subscription, you can onlyremove this subscription by accessing theadministration tool of the JMS provider.

For more information about managing durablesubscriptions, see the documentation of the JMSprovider.

Suppress LocalMessages

Yes Specifies to not receive messages on the specifiedtopic name when the message origin is the JMSapplication on the same connection as the processengine.

If the process publishes and subscribes to messageswith the same topic name, this option is useful ifyou want to specify whether to receive messagessent by the same JMS application that published themessage.

Selecting this check box prevents the process fromreceiving messages sent by the same connection.

Keep this check box clear to specify that themessages sent by the same connection should bereceived.


326 | JMS Palette


Description

AcknowledgeMode

Yes The acknowledge mode for incoming messages. Itcan be one of the following:


l Client: the message is acknowledged at alater point by using the Confirm activity. Ifthe message is not confirmed before theprocess instance ends, the message isredelivered and a new process instance iscreated to handle the new incoming message.Ensure that your process confirms themessage when using the acknowledge mode.

l Dups Ok: the message is acknowledgedautomatically when it is received. JMSprovides this mode for lazy acknowledgment,but ActiveMatrix BusinessWorks acknowledgesmessages upon receipt.

l TIBCO EMS Explicit Client: (only available forTIBCO Enterprise Message Service) a messagewhich is not acknowledged using the Confirmactivity before the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and onesession handles all incoming messages foreach process instance.

l TIBCO EMS Explicit Client Dups OK: (onlyavailable for TIBCO Enterprise MessageService) a message which is notacknowledged using the Confirm activitybefore the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and one


327 | JMS Palette


Description

session handles all the incoming messages foreach process instance. The messageshowever, are lazily acknowledged.


Max Sessions None Specifies the maximum number of client sessionsthat can connect with the messaging server. Thisproperty is enabled only when the Acknowledgemode is selected as Client.

The default value is 1.

Note: Do not use the flowlimit property when theMax Session value is greater than 1.

SharedSubscription

None This field is enabled only when the Messaging Stylefield has Topic option selected. Select this checkbox to support shared subscription feature of JMS2.0 specification.





328 | JMS Palette

Description

Provide a short description for the JMS Receive Message activity.

Load-Balancing for Incoming Messages

One common application of a JMS message is to distribute messages across multiplereceivers, thus balancing the processing of the messages. To achieve this goal, both theJMS server and ActiveMatrix BusinessWorks must be properly configured. The JMS servermust allow the messages to be distributed across multiple receivers. For example, in TIBCOEnterprise Message Service, the exclusive property on the queue controls whethermessages can be delivered across receivers or not. In ActiveMatrix BusinessWorks, theprocess definition containing the JMS Receiver must be deployed across multiple processengines. This creates multiple queue receivers for the same queue.

Note:If the Sequencing Key field is set to preserve the order of incoming messages, toconfirm the messages sequentially you must either set the Acknowledge modeto TIBCO EMS Explicit Client Acknowledge mode or set the Acknowledge modeto Client and Max Sessions to 1. Setting Max Sessions to 1 can limit the system'sthroughput, so using TIBCO Enterprise Message Service and TIBCO EMS ExplicitClient Acknowledge is a better choice.

Advanced



Description

MessageSelector

Yes A string to determine whether a message should bereceived. The syntax of the message selector isdetermined by the JMS provider.

For more information and syntax for a messageselector string, see the JMS provider documentation.


329 | JMS Palette


Description


None Any application-specific message properties that ispart of the message. This is specified by the JMSapplication properties shared configuration object.

PollingInterval (sec)

None Specifies the polling interval to check for newmessages. If no value is specified for the property, thedefault polling interval is two seconds.

Set a value in this field to specify the polling interval(in seconds) for this activity. The value in this fieldoverrides the default polling interval.

Sequence Key None This field can contain an XPath expression thatspecifies which processes should run in sequence.Process instances with sequencing keys that evaluateto the same value are executed in the sequence theprocess instances were created.

Custom JobId

None This field can contain an XPath expression thatspecifies a custom ID for the process instance.

Output Editor

The Output Editor tab defines the schema to use for incoming messages whose MessageType is Map, Stream, or XML Text. Map messages are name or value pairs, and you canuse the schema to define the structure of the incoming message. The schema on theOutput Editor tab becomes the structure used for the body of the message displayed onthe 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.

Conversations

You can initiate and join the conversation here. Click the Add New Conversationbutton to initiate multiple conversations.


330 | JMS Palette

For more information about conversations, see the ActiveMatrix BusinessWorks ApplicationDevelopment guide.

Output







Body as permessagetype




l Name - Required. Name of the property with oneinstance.



331 | JMS Palette




l string

l boolean

l short

l integer

l long

l float

l double

l byte

Note: The DynamicProperty overwrites the value ofa property (with the same name) added using theJMS Application Property.

The DynamicProperties are also added to the outgoingmessage.

JMS Request ReplyJMS Request Reply is an asynchronous activity that is used to send a request to a JMSdestination and wait for a response from the JMS client.

Note: This activity uses temporary destinations to ensure that reply messagesare received only by the process that sent the request. However, the user hasthe ability to use preexisting JMS destinations.

General



332 | JMS Palette


Description


MessagingStyle

Yes Select from one of the following available options:

l Generic

l Queue

l Topic

JMSConnection


Destination Yes The name of the destination of the outgoing message.




l Map: a set of name or value pairs. The namesare strings, and the values are simple datatypes(JAVA primitives), an array of bytes (use theBinary datatype when mapping this data), or astring. You can access each item sequentially orby its name.




l Stream: a stream of Java primitives, strings, orarrays of bytes. Each value must be readsequentially.


333 | JMS Palette


Description

l XML Text: the message is XML text.

Description

Provide a short description for the JMS Request Reply activity.

Advanced


Field Description

Reply ToDestination

The destination to use for replies for this activity.

Note: If more than one job has the same Reply To Destination, each jobmay not receive the correct reply. Ensure to specify an expression in thisfield that assigns a different Reply To Destination to each processinstance.

Deliver Mode The delivery mode of the message. Can be one of the following:

l Persistent: signifies that the messages are stored and forwarded.

l Non_Persistent: signifies that the messages are not stored and may belost due to transmission failure.

l TIBCO_EMS_Reliable_Delivery: this mode is only available when usingTIBCO Enterprise Message Service. See the TIBCO Enterprise MessageService documentation for more information.

JMSExpiration(msec)

Corresponds to the JMSExpiration property that specifies how long themessage can remain active in miliseconds.

If set to 0, the message does not expire.


334 | JMS Palette

Field Description

Priority The priority of the message. You may set the priority to a value from 0-8. Thedefault 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 typeMap, Stream, or XML Text. Map messages are name or value pairs, and you can use theschema to define the structure of the outgoing request and the incoming reply. Theschema defined on the Input Editor tab becomes the body of the message on the Inputtab. The schema defined on the Output Editor tab becomes the body of the message onthe Output tab. For XML Text message type, select an XSD element. For Map and Streammessage types, select an XSD type in the Input Editor or Output Editor.

Input



Destination string The destination to which to send the request. Thisinput item overrides the Destination field on theGeneral tab.

replyTo string The destination to use for replies for this activity.

Note: If more than one job has the same Reply ToDestination, then each job may not receive thecorrect reply. Ensure to specify an expression in thisfield that assigns a different Reply To Destinationto each process instance.


335 | JMS Palette


JMSExpiration integer Specifies how long the message can remain active inmilliseconds.

If set to zero (0), the message does not expire.

JMSPriority string The priority of the message. This item overrides thepriority set on the Advanced tab.


l Persistent: signifies that the messages arestored and forwarded.

l Non_Persistent: signifies that the messages arenot stored and may be lost due to transmissionfailure.

l TIBCO_EMS_Reliable_Delivery: this mode isonly available when using TIBCO EnterpriseMessage Service.

For more information, see the TIBCO EnterpriseMessage Service documentation.

JMSCorrelationID string This ID is used to link a response message with itsrelated request message. This is usually the messageID of a request message when this field exists in areply message.


336 | JMS Palette


Note: If the correlation ID is not specified the JMSMessage ID is passed as a selector. The Reply ToJMS Message activity replies for that correspondingID only. If you use the JMS Send Message activityinstead of the Reply To JMS Message activity forsending the reply to the JMS Request Replyactivity, then you must explicitly map the JMSCorrelation ID in the JMS Send Message activitywith the Message ID in the JMS Request Replyactivity to maintain the correct order of the requestand reply.

JMSType string The type of the message. This item overrides the valuespecified on the Advanced tab.

JMSProperties complex The message properties. For more information, seeCommon JMS Properties and Headers.

Body depends onthemessagetype






l Type - Optional. Type of the property. If not


337 | JMS Palette


provided, it is considered as string.


l string

l boolean

l short

l integer

l long

l float

l double

l byte



requestTimeout integer This field specifies the amount of time (in milliseconds)that the activity waits before it times out.

Output






338 | JMS Palette








Name - Required. Name of the property with oneinstance.

Value - Required. Value of the property with oneinstance.

Type - Optional. Type of the property. If not provided,it is considered as string.


l string

l boolean

l short

l integer

l long

l float

l double


339 | JMS Palette


l byte



Fault




JMSMessageCreateException The JMS message could not be created.


JMSSendException The JMS send operation failed.

JMSReceiveException The JMS receive operation failed.


JMS Send MessageJMS Send Message is a synchronous activity that sends a message to the specified JMSdestination.


340 | JMS Palette

General



Description


MessagingStyle

None Select from one of the following available options:

l Generic

l Queue

l Topic

JMSConnection


Destination Yes The name of the destination of the outgoing message.




l Map: a set of name or value pairs. The namesare strings, and the values are simple datatypes(JAVA primitives), an array of bytes (use theBinary datatype when mapping this data), or astring. Each item can be accessed sequentiallyor by its name.




341 | JMS Palette


Description


l Stream: a stream of Java primitives, strings, orarrays of bytes. Each value must be readsequentially.


Description

Provide a short description for the JMS Send Message activity.

Advanced



Description

Reply ToDestination

Yes The destination to use for replies for this activity.

Note: If more than one job has the same Reply ToDestination, each job may not receive the correctreply. Ensure to specify an expression in this fieldthat assigns a different Reply To Destination toeach process instance.

Delivery Mode None The delivery mode of the message. Can be one of thefollowing:



342 | JMS Palette


Description




JMSExpiration(msec)

None Corresponds to the JMSExpiration property thatspecifies how long the message can remain active inmilliseconds.


Delivery Delay(msec)

Yes Delivery Delay feature, which is supported in EMS, isnow supported in TIBCO ActiveMatrix BusinessWorks™6.4.2.

Delivery Delay is the minimum length of time inmilliseconds that must elapse after a message is sentbefore the JMS provider may deliver the message to aconsumer.

Priority None The priority of the message. You may set the priorityto a value from 0-8. The default value is 4.

Type None The value to supply to the JMSType header property.


None Any application-specific message property that is partof the message. This is specified by the JMSapplication properties shared configuration object.

Override None Overrides the default behavior of a transaction group.


343 | JMS Palette


Description

TransactionBehavior

When the activity is in a transaction group, the JMSmessage is normally committed or rolled back withthe other participants in the transaction.

When the check box is selected, the JMS messagedoes not participate in the transaction.

Input Editor

The Input Editor tab defines the schema to use for outgoing messages whose messagetype is Map, Stream, or XML Text. Map messages are name or value pairs, and you can usethe schema to define the structure of the outgoing message. After defining the schema onthe Input Editor tab, it becomes the structure used for the body of the message displayedon the Input tab. For the XML Text message type, select an XSD element. For Map andStream message types, select an XSD type in the Input Editor tab.

Input



Destination string The destination to which to send the message. Thisinput item overrides the Destination field on theGeneral tab.




344 | JMS Palette










JMSCorrelationID string This ID is used to link a response message with itsrelated request message. This is usually the messageID of a request message when this field exists in areply message.






345 | JMS Palette








l string

l boolean

l short

l integer

l long

l float

l double

l byte




346 | JMS Palette

Output



MessageID string The unique identifier of the message.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective actions to take, see the ActiveMatrix BusinessWorksError Codes.






Reply to JMS MessageReply To JMS Message is a synchronous activity that sends a reply to a previouslyreceived JMS queue or topic message. The Reply For Event field in the General tab liststhe activities that can receive the JMS message. The activity you select determines theresponse of the reply message.

General



347 | JMS Palette

Field Description

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

Reply ForEvent

A drop-down list of activities that can receive JMS queue or topic messages. Theactivity you select determines the message this activity replies to. The reply-toqueue or topic name from the message in the selected activity is used to sendthe reply message. The listed activity is WaitforJMSRequest.

MessageType

The type of the message. This can be one of the following:



l Map: a set of name or value pairs. The names are strings, and the valuesare 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.


l Object Ref: an object reference to a Java object.


l Stream: a stream of Java primitives, strings, or arrays of bytes. Each valuemust be read sequentially.


Description

Provide a short description for the Reply to JMS Message activity.

Advanced


Field Description

Delivery Mode The delivery mode of the message. This can be one of the following:


348 | JMS Palette

Field Description

l Persistent: signifies that the messages are stored and forwarded.

l Non_Persistent: signifies that the messages are not stored and may belost due to transmission failure.

l TIBCO_EMS_Reliable_Delivery: this mode is only available when usingTIBCO Enterprise Message Service.

For more information, see the TIBCO Enterprise Message Servicedocumentation.

JMSExpiration(msec)

Corresponds to the JMSExpiration property that specifies how long themessage can remain active in milliseconds.

If set to zero (0), the message does not expire.

Priority The priority of the message. You may set the priority to a value from 0-8. Thedefault value is 4.

JMS 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.

Input Editor

The Input Editor tab defines the schema to use for outgoing messages whose messagetype is Map, Stream, or XML Text. Map messages are name or value pairs, and you can usethe schema to define the structure of the outgoing message. After defining the schema onthe Input Editor tab, it becomes the structure used for the body of the message displayedon the Input tab. For XML Text message type, select an XSD element. For Map and Streammessage type, select an XSD Type in the Input Editor tab.

Input



349 | JMS Palette


Destination string The destination to which to send the request. Thisinput item overrides the Destination field on theGeneral tab.











JMSCorrelationID string This ID is used to link a response message with itsrelated request message. This is usually the messageID of a request message when this field exists in a


350 | JMS Palette


reply message.











l string

l boolean

l short

l integer

l long


351 | JMS Palette


l float

l double

l byte



Fault







Wait for JMS RequestWait for JMS Request is a signal-in activity that waits for the receipt of a message for thespecified JMS destination.


352 | JMS Palette

General



Description


Messaging Style Yes Select from one of the following available options:

l Generic

l Queue

l Topic

JMSConnection

None The JMS connection. For more information, see JMSConnection .

Destination Yes The destination from which a reply to this messageshould be received.






l Object Ref: an object reference to a Java


353 | JMS Palette


Description

object.




DurableSubscriber

Yes Specifies a durable subscription.

Specify a name in the Subscription Name field thatis registered with the JMS application as the durablesubscriber name. This field is only available, if theMessaging Style is Generic or Topic.

SubscriptionName

Yes The subscription name registered with the JMSapplication for durable subscriptions. This field isonly available when the Durable Subscriber checkbox is selected.

After a durable subscription is created, it can onlybe removed by accessing the administration tool ofthe JMS provider.

For more information about managing durablesubscriptions, see the documentation of the JMSprovider .

Suppress LocalMessages

Yes Specifies to not receive messages on the specifiedtopic name when the message origin is the JMSapplication on the same connection as the processengine.

If your process publishes and subscribes tomessages with the same topic name, this option isuseful if you want to specify whether to receive


354 | JMS Palette


Description

messages sent by the same JMS application thatpublished the message.

Selecting this check box prevents the process fromreceiving messages sent by the same connection.

Keep this check box clear to specify that themessages sent by the same connection should bereceived.

AcknowledgeMode

None The acknowledge mode for incoming messages. Itcan be one of the following:


l Client: the message is acknowledged at alater point by using the Confirm activity. Ifthe message is not confirmed before theprocess instance ends, the message isredelivered and a new process instance iscreated to handle the new incoming message.Ensure that your process confirms themessage when using the acknowledge mode.

l Dups Ok: the message is acknowledgedautomatically when it is received. JMSprovides this mode for lazy acknowledgment,but ActiveMatrix BusinessWorks acknowledgesmessages upon receipt.

l TIBCO EMS Explicit Client: (only available forTIBCO Enterprise Message Service) a messagewhich is not acknowledged using the Confirmactivity before the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and one


355 | JMS Palette


Description

session handles all incoming messages foreach process instance.

l TIBCO EMS Explicit Client Dups OK: (onlyavailable for TIBCO Enterprise MessageService) a message which is notacknowledged using the Confirm activitybefore the process instance ends, isredelivered instead of all messages in thesession. The session is not blocked and onesession handles all the incoming messages foreach process instance. The messageshowever, are lazily acknowledged.


Max Sessions None Specifies the maximum number of client sessionsthat can connect with the messaging server. Thisproperty is enabled only when the Acknowledgemode is selected as Client.


Note: Do not use the flowlimit property when theMax Session value is greater than 1.

SharedSubscription

None This field is enabled only when the Messaging Stylefield has Topic option selected. Select this checkbox to support shared subscription feature of JMS2.0 specification.



356 | JMS Palette


Description



Description


Event

The Event tab has the following fields.

Field Description


This field specifies the amount in seconds. If no value is specified in this field,the message waits indefinitely. If zero is specified, the event is discardedimmediately, unless this activity has already been executed.


This field specifies the amount of time (in milliseconds) to wait if the filechange occurs before this activity is executed in the process instance. If theevent timeout expires, an error is logged and the event is discarded.

Advanced



357 | JMS Palette


Description

MessageSelector

Yes A string to determine whether a message should bereceived. The syntax of the message selector isdetermined by the JMS provider.

For more information and syntax for a messageselector string, see the JMS provider documentation.


None Any application-specific message properties that ispart of the message. This is specified by the JMSapplication properties shared configuration object.

PollingInterval (sec)

Yes The polling interval (in seconds) to check for new JMSrequest.

Output Editor

The Output Editor tab defines the schema to use for messages of type Map, Stream, orXML Text. Map messages are name or value pairs, and using this schema you can definethe structure of the retrieved queue message. The schema defined on the Output Editortab becomes the body of the message on the Output tab.

Conversations

You can initiate and join the conversation here. Click the Joining existing conversation

button to join existing conversations.For more information about conversations, see the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Output



358 | JMS Palette














l string

l boolean


359 | JMS Palette


l short

l integer

l long

l float

l double

l byte



Fault





360 | Mail Palette

Mail PaletteThe Mail Palette is used to receive incoming emails or send outgoing emails.

Receive MailReceive Mail is a process starter activity that polls a POP3 mail server for the new mail.After detecting and retrieving a new mail, the Receive Mail activity starts the process.

General



Description


Host Yes The host name or IP address for the mail server.

Port Yes The default port (110) used to connect to POP3server.

User Name Yes The username for logging into the POP3 server.

Password Yes The password for logging into the POP3 server.

Polling Interval(Sec)

Yes The polling interval (in seconds) to check for newmail. The default is 5, if no polling interval isspecified.


361 | Mail Palette


Description

Delete Mail None Select this check box to delete the mail from thePOP3 server after process starter has retrieved it.

Note: To delete mail, place a Checkpointactivity immediately after the Receive Mailprocess starter. This ensures that the messageis not lost in the event of a machine failure.

Alternatively, you can leave this field clear.

EnableConfidentiality

None This check box specifies whether a Secure SocketsLayer (SSL) Client should be used to specify theSSL configuration. When this check box isselected, the SSL Client field displays.

SSL Client Yes The name of the resource. In the SslClientResourceResource Template wizard, create a resource toconnect to the SSL client.

Test Connection Button

The Test Connection button tests the connection to the specified mail server. Use thisbutton to ensure that your Receive Mail activity is properly configured to receive mail fromthe specified mail server. This button is enabled only when the Host, User Name, andPassword fields on the General tab are populated.

Description

Provide a short description for the Receive Mail activity.

Advanced

The Advanced tab contains the following fields:


362 | Mail Palette

Field Description

SequenceKey

Contains an XPath expression that specifies which process runs in a sequence.Process instances with sequencing keys evaluating to the same value, areexecuted in the sequence the process instance was created.

Custom JobId


Provide RawMessage

When selected, this field specifies the whole message to be provided in thebinary form. The output schema changes to include an element namedrawMessage that contains the message instead of bodyText andmimeEnvelopeElements.

The Receive Mail process starter uses the javax.mail API. This API assumes thatthe content type of the message is multipart/mixed. When the multipart subtype isnot mixed (such as multipart/signed or multipart/alternative) or when another contenttype is used (for example, application/*), the javax.mail API may not correctlyparse the message.

Select this check box to send the raw message to a Java Invoke activity thatuses the Java activation framework to implement the appropriate handlers toprocess the message.

For more information about how the Java activation framework can be usedfor this purpose, see the API documentation for javax.activation and javax.mail.

You can also feed the binary message to the javax.mail.MimeMessage constructorin the form of a java.io.InputStream to construct a MimeMessage object. Thedefault javax.mail API handler is used in such a case.

Write to File Select this check box to specify that the incoming messages whose body andattachments (or raw message size, if Provide Raw Message is selected)exceed the specified threshold size, must be written to a file instead of beingstored in memory. You can accept large incoming messages withoutconsuming more memory. The incoming message is written to the file withmail headers when body and attachment exceeds the specified size.

Selecting this check box displays the Directory, Creating Non-ExistingDirectories, and Threshold Data Size(bytes) fields.

Do not select to keep the incoming messages in memory.


363 | Mail Palette

Field Description

Note: The files created by using this option are not deleted automatically.You must manage the storage used by these files and delete them whenthey are no longer used.

Directory The directory to write messages that are above the specified threshold. Theprocess engine does not attempt to create the directory, if the specifieddirectory does not exist. Therefore, create the directory before starting theprocess engine.


The directory to write messages that are above the specified threshold.

If the specified directory does not exist, the process engine does not attemptto create the directory. Therefore, select the check box to create the directorybefore starting the process engine.

Not selecting this check box with one or more non-existing directories in thespecified path in the Directory field, raises an exception.


The maximum size (in bytes) of an incoming message that can be kept inmemory. Messages larger than the specified size are written to a file in thespecified directory. The file name is an output so that the subsequentactivities in the process properties can access the file and read its contents.

Specifying zero (0) in this field determines all incoming messages to be savedto a file.

Output Editor

Incoming messages may contain custom headers. From the Output Editor tab, define acustom schema for the headers of the incoming mail messages. You can also specify anystandard header supported by the javax.mail package. For example, X-Mailer or X-Priority.Values of headers in the incoming message populates the corresponding defined outputheaders of the same name.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations. For more information about conversations, see Application


364 | Mail Palette

Development.

Output



from string The email address of the sender of the email.

to string The recipient list of the email.

cc string The cc (carbon copy) list of the email.

replyTo string The reply to list of the email.

subject string The subject of the email.

sentdate string The date the email was sent.

Headers complex This element contains the schema you defined onthe Output Editor tab. You can specify customheaders that can be included in the incoming mailmessages.

bodyElement string Contains a choice element.

You can either provide the bodyText element orfileName element.

mimeEnvelopeElement complex This field is available when the Provide RawMessage check box on the Advanced tab is notselected.

Contains the message attachments. This elementcontains a repeating element named mimePartthat comprises each mime attachment.

mimeHeaders complex This element contains the mime header for eachmimePart.


365 | Mail Palette


mimeHeaders contain the following information:

l content-disposition - To suggest a filenamefor an attachment, use "*;filename=<filename>"in this element.

Note: E-mail servers may alter or ignorethe suggested name.

l content-type


l content-id

l any element


Note: When the contentType is specified as"text/*" (for example, "text/xml"), specify theattachment content in either the textContentinput element or the file name storing theattachment in the fileName input element.When the contentType is anything other than"text/*":

l The attachment content must be in thebinaryContent input element.

l The file name storing the attachmentmust be in the fileName input element.

binaryContent | fileName| textContent

choice This element contains the mime attachment. It canbe any of the following:

l binaryContent: the content of theattachment when the attachment is binarydata.

l fileName: the file name of the attachment



366 | Mail Palette


written on the disk.

l textContent: the content of the attachmentwhen the attachment is text data.

Send MailSend Mail is a synchronous activity that sends an email by way of an SMTP server.

General


Field Literal Value/ModuleProperty

Description


SMTPProperty

Yes The property name of the SMTP server.

If your server is configured for using a different port,specify it in this field.

Description

Provide a short description for the Send Mail activity.

Advanced



367 | Mail Palette

Field Description

Allow Non-StandardEmail IDs

By default, email IDs specified in the to, from, cc, bcc, or replyTo inputelements must conform to the RFC 822 standard for email addresses.

Select this check box to specify email IDs that do not conform to the RFC 822standard. This is useful for sending mail to a server that has extensions forsending email to devices such as a fax machine.

For more information about email address syntax, seehttp://www.faqs.org/rfcs/rfc822.html.

Note: When this field is not selected, not all of the RFC 822 syntax rules areenforced. For example, addresses composed of simple names (with no"@domain" part) are allowed.

For more information about enforcing RFC 822, see the description of the strictflag of the parse method of javax.mail.internet.InternetAddress athttps://docs.oracle.com/.

Input Editor

You may want to add custom headers to outgoing mail messages. From the Input Editortab you can define a custom schema for the headers of the outgoing mail message. Youcan specify any standard header supported by the javax.mail package. For example, X-Maileror X-Priority.

Input



username string The username to use when authenticating to themail server.

password string The password to use when authenticating to themail server.


https://docs.oracle.com/


368 | Mail Palette


from string The email address of the sender.

to string The recipient list for the email. Use this repeatableelement to send mail to more than one recipient.

Provide a list of "to" recipients in a single string byusing either a comma or a semicolon (but not bothin the same string) as delimiters.

cc string The "cc" (carbon copy) list for the email. Use thisrepeatable element to place more than onerecipient on the "cc" list, if required.

Provide a list of "cc" recipients in a single string byusing either a comma or a semicolon (but not bothin the same string) as delimiters.

bcc string The "bcc" (blind carbon copy) list for the email.Use this repeatable element to place more thanone recipient on the "bcc" list.

Provide a list of "bcc" recipients in a single stringby using either a comma or a semicolon (but notboth in the same string) as delimiters.

replyTo string The "replyTo" list for the email. Use thisrepeatable element to place more than onerecipient on the "replyTo" list.

Provide a reply to list in a single string by usingeither a comma or a semicolon (but not both inthe same string) as delimiters to separate theaddresses in the list.

subject string The subject of the email.

sentdate string The date stamp for the email.


369 | Mail Palette


Note: The email server provides the actual datestamp for the email, so this input item isignored. Do not attempt to place a value in thisinput item.

bodyElement complex Contains a choice element.

You can either provide the bodyText element orfileName element.

bodyText string The text of the email message.

fileName string The file name of the attachment written to thedisk.

Headers complex Contains the schema you defined on the InputEditor tab. Specify custom headers for theoutgoing mail messages.

Specify any standard header supported by thejavax.mail package. For example, X-Mailer or X-Priority.

To use attachments, specify the Content-Typeheader as multipart/* (where * is a valid subtype ofthe multipart).

contentType string The mime content type for the message. You canspecify a character encoding in this element forthe encoding of the body of the message.

mimeEnvelopeElement complex Contains the message attachments.

mimePart complex This repeating element comprises each mimeattachment.

mimeHeaders complex This element contains the mime header for eachmimePart.


370 | Mail Palette


mimeHeaders contain the following information:

l content-disposition - To imply a filename foran attachment, use "*;filename=<filename>" inthis element.

Note: E-mail servers may alter or ignorethe suggested name.

l content-type


l content-id

l any element


Note: When the contentType is specified as"text/*" (for example, "text/xml"), specify theattachment content in either the textContentinput element or the file name storing theattachment in the fileName input element.When the contentType is anything other than"text/*":

l The attachment content must be in thebinaryContent input element.

l The file name storing the attachmentmust be in the fileName input element.

binaryContent | fileName| textContent

choice This element contains the mime attachment. It canbe any of the following:

l binaryContent: the content of theattachment when the attachment is binarydata.

l fileName: the file name of the attachment



371 | Mail Palette


written on the disk.

l textContent: the content of the attachmentwhen the attachment is text data.

Fault



InvalidInputException The input is not valid.

UnknownHostException The mail server host name is not resolved.

The exception contains the name of the mail server host.

SendFailedException The send operation failed for some reason.


372 | Parse Palette

Parse PaletteThe 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 adata schema or transform a data schema into a formatted text string.

The text lines can be formatted either by delimiters separating each field or offsets can bespecified to determine 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 beingprocessed. When reading a large number of records from a file, the process may consumesignificant machine resources. To avoid too much memory, you may want to read the inputin parts, parsing and processing a small set of records before moving on to the next set ofrecords.

This procedure is a general guideline for creating a loop group for parsing a large set ofinput records in parts. You may want to modify the procedure to include additionalprocessing of the records, or you may want to change the XPath expressions to suit yourbusiness process. If processing a large number of records, do the following.

Procedure1. 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 Recordcheck box.

3. Select the Parse Data activity and click the group icon on the tool bar to create agroup containing the Parse Data activity.

4. Specify Repeat Until True Loop as the Group action, and specify an index name (forexample, "i").

The loop must exit when the EOF output item for the Parse Data activity is set totrue. For example, the condition for the loop can be set to the following: string($ParseData/Output/done) = string(true())


373 | Parse Palette

5. Set the noOfRecords input item for the Parse Data activity to the number of recordsyou want to process for each execution of the loop.

If you do not select the Manually Specify Start Record check box on the Generaltab of the Parse Data activity, the loop processes the specified noOfRecords witheach iteration, until there are no more input records to parse.

You can optionally select the Manually Specify Start Record check box to specifythe startRecord on the Input tab. If you do this, you must create an XPathexpression to properly specify the starting record to read with each iteration of theloop. For example, the count of records in the input starts at zero, so thestartRecord 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 containsbinary attachments as an inline data of the SOAP message. The output can be either in aText or in a Binary format.

General


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

Provide a short description for the MimeParser activity.


374 | Parse Palette

Advanced

The Advanced tab has the following.

Field Description

Generate Strict ParsingErrors

Select this check box to generate strict parsing validationerrors.

Input



MimeBinaryData Binary This is the incoming binary data.

Output



soapMessage Binary orString

Depends on the type selected in the Output Styleformat.

StrictValidationErrors Complex This displays only when the Generate StrictParsing Errors check box is selected.

ErrorString String Shows strict parsing validation error logs.

Fault



375 | Parse Palette

Fault Generated When...

XOPParseException The input has XOP related exceptions.

MimeParseException The input has MIME related exceptions.

InvalidXMLException The input has invalid xml related exception.

Parse DataThe Parse Data activity takes a text string or input from a file and processes it byconverting it into a schema tree based on the specified Data Format shared resource.

You can use any mechanism to obtain or create a text string for processing. For example,you can use the Read File activity to obtain text from a file. You can also use this activityto specify a text file to read.

You can use this activity in various scenarios. For example, a user has a file comprisingmultiple lines with comma-separated values (as in data obtained from a spreadsheet) andthis data has to be inserted into a database table. In such a scenario, read and parse thefile into a data schema with the Parse Data activity. Then, use the JDBC Update activity toinsert the data schema into a database table.

General



Description


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.


376 | Parse Palette


Description

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

Encoding Yes The encoding of the input file.

To enable this field, select the File option in the Input 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.

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. Formore information about how to read the input stream in parts,see Parsing a Large Number of Records.

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.


377 | Parse Palette


Description

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 errors occur.

Description

Provide a short description for the Parse Data activity.

Input



text string The text string to parse.

This input item is available only when String isspecified in the Input Type field of the Generaltab.

fileName string The location and name of the file to read. The file'scontent is used as the input text string for thisactivity.

This input item is available only when File isspecified in the Input Type field of the Generaltab.

startRecord number The line number of the input stream to beginparsing. All lines before the specified line areignored. This input item is available only if theManual Specify Start Record check box on theGeneral tab is selected.


378 | Parse Palette


The input stream begins with the line number 1(one). This is useful for reading the input stream inparts to minimize memory usage.

For more information, see Parsing a Large Numberof Records

noOfRecords number The number of records to read from the inputstream. Specify -1 if you want to read all records inthe input stream.

This is useful for reading the input stream in partsto minimize memory usage.

For more information, see Parsing a Large Numberof Records.

SkipHeaderCharacters integer The number of characters to skip when parsing.You can skip over any file headers or otherunwanted information.

Output



Rows complex This output item contains the list of parsed lines from theinput. This is useful to determine the number of records parsedby this activity.

The schema specified by the Data Format resource iscontained in this output item.

schema complex The schema containing the data from the parsed input text.This output item contains zero or more parsed records.

ErrorRows This output item is available when you select Continue on


379 | Parse Palette


Error, and error(s) while parsing the records in the input.

Raw input data is put in the error string.

This field contains the list of error lines for the records from theinput that failed parsing.

done boolean true if no more records are available for parsing. false if thereare more records available.

This output item is useful to check whether there are no morerecords in the input stream when reading the input in parts topreserve memory.

Fault



FileNotFoundException The specified input file cannot be located.

BadDataFormatException The input format is not valid.

Parsing a Large Number of Records

The input for this activity is placed in a process variable and takes up memory as it is beingprocessed. When reading a large number of records from a file, the process may consumesignificant machine resources. To avoid too much memory, you may want to read the inputin parts, parsing and processing a small set of records before moving on to the next set ofrecords.

This procedure is a general guideline for creating a loop group for parsing a large set ofinput records in parts. You may want to modify the procedure to include additionalprocessing of the records, or you may want to change the XPath expressions to suit yourbusiness process. If processing a large number of records, do the following:


380 | Parse Palette

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 Recordcheck box.

3. Select the Parse Data activity and click the group icon on the tool bar to create agroup containing the Parse Data activity.

4. Specify Repeat Until True Loop as the Group action, and specify an index name (forexample, "i").

The loop must exit when the EOF output item for the Parse Data activity is set totrue. For example, the condition for the loop can be set to the following:

string($ParseData/Output/done) = string(true())

5. Set the noOfRecords input item for the Parse Data activity to the number of recordsyou want to process for each execution of the loop.

If you do not select the Manually Specify Start Record check box on the Generaltab of the Parse Data activity, the loop processes the specified noOfRecords witheach iteration, until there are no more input records to parse.

You can optionally select the Manually Specify Start Record check box to specifythe startRecord on the Input tab. If you do this, you must create an XPathexpression to properly specify the starting record to read with each iteration of theloop. For example, the count of records in the input starts at zero (0), so thestartRecord input item could be set to the current value of the loop index minusone. For example, $i - 1.

Render DataThe Render Data activity takes an input of a data schema and renders it as a text string.The schema processed is based on a specified Data Format shared resource.

You can use this activity in various scenarios, for example, retrieving a result set from adatabase table. You may want to:

l Format this result set as a formatted text string (with line breaks between each rowin the result set), and then write that text string out to a file.

l Use the Render Data activity to render the data schema as a formatted text string.

l Use the Write File activity to write the string to a file.


381 | Parse Palette

General



Description


DataFormat

No The Data Format shared resource to use when rendering thetext output.

Description

Provide a short description for the Render Data activity.

Input


InputItem


Rows complex The element containing the list of items to render.

root complex The complex element containing data schema (specified by theData Format shared resource) to render as a text string. This is arepeating element which renders more than one output record.

Output



382 | Parse Palette

OutputItem


Text string The output text string as a result of rendering the specified dataschema. Line breaks separate records of the data schema.

Fault



BadDataFormatException The output format is not valid.


383 | Rendezvous Palette

Rendezvous PaletteUsing the Rendezvous palette you can send and receive TIBCO Rendezvous® messages.

Important: To run Rendezvous® applications on UNIX, set the LD_LIBRARY_PATHvariable and RV_HOME specifying the RV lib path.

Important: You must install Rendezvous® if you want to use the Rendezvouspalette features. Refer to the product readme, readme.txt, for the supportedversions.

Datatype ConversionWhen sending or receiving TIBCO Rendezvous® messages, TIBCO ActiveMatrixBusinessWorks™ converts the fields of the message to the correct datatypes. Data in theincoming Rendezvous® messages is converted to ActiveMatrix BusinessWorks™ datatype(and represented in the activity’s output). Data in an outgoing message is converted toRendezvous® datatypes.

The following tables describe the corresponding datatypes between ActiveMatrixBusinessWorks and Rendezvous, depending upon whether ActiveMatrix BusinessWorks issending or receiving the message.

RendezvousDatatype

XSD Dataype

TIBRVMSG_BOOL boolean

TIBRVMSG_I8 byte

Rendezvous to ActiveMatrix BusinessWorks Datatype Conversion



RendezvousDatatype

XSD Dataype

TIBRVMSG_I16 short

TIBRVMSG_I32 int

TIBRVMSG_I64 long

TIBRVMSG_U8 unsignedByte

TIBRVMSG_U16 unsignedShort

TIBRVMSG_U32 unsignedInt

TIBRVMSG_U64 unsignedLong

TIBRVMSG_F32 float

TIBRVMSG_F64 double

TIBRVMSG_OPAQUE hexBinary or base64Binary, depending upon what is defined in theschema.

TIBRVMSG_DATETIME date

TIBRVMSG_STRING string

XSD Datatype RendezvousDatatype

boolean TIBRVMSG_BOOL

byte TIBRVMSG_I8

short TIBRVMSG_I16

ActiveMatrix BusinessWorks to Rendezvous Datatype Conversion



XSD Datatype RendezvousDatatype

int TIBRVMSG_I32

long TIBRVMSG_I64

integer TIBRVMSG_I64

unsignedByte TIBRVMSG_U8

unsignedShort TIBRVMSG_U16

unsignedInt TIBRVMSG_U32

unsignedLong TIBRVMSG_U64

float TIBRVMSG_F32

double TIBRVMSG_F64

hexBinary or base64Binary, depending upon what is defined in theschema.

TIBRVMSG_OPAQUE

date TIBRVMSG_DATETIME

dateTime TIBRVMSG_DATETIME

time TIBRVMSG_STRING

string TIBRVMSG_STRING

Field Names in MessagesA TIBCO Rendezvous® message can contain field names that are not compliant with XMLnaming rules. For example, XML element names can neither begin with a number, nor canthey contain special characters, such as # or ^. When activities in the Rendezvous palettesend or receive messages, element names in the input schemas or output schemas for theactivity must comply with XML naming rules. Any element in referenced schemas in the



input schemas or output schemas is automatically altered to comply with XML namingrules. From the XML-Compliant Field Names field, you can handle the incoming oroutgoing messages when the field names are not valid XML names.

When the XML-Compliant Field Names field is clear, any field name in the incoming oroutgoing messages not compliant with XML naming rules, is altered to comply with therules. When this field is selected, field names in the message are left unaltered.

When publishing a message with XML-Compliant Field Names field not selected, the fieldnames in the message sent over the transport to the receiving application are altered tocomply with XML naming rules. By selecting this field, you can send the message with theoriginal field names intact; no alterations are made to the field names. This is useful in thecase where you reference a schema in the Input Editor tab that contains invalid XMLnames. The receiving application receives the message with the original field names, if theXML-Compliant Field Names field is not selected.

When receiving a message, not selecting the XML-Compliant Field Names field ensuresthat field names in the incoming message are altered to comply with XML naming rules. Ifthe message contains fields that do not comply to XML naming rules, the output schema ofthe subscriber activity must specify the correct altered name to match the altered name ofthe field in the incoming message. Keeping the field clear leaves the field names of themessage intact.

Note: Not selecting the XML-Compliant Field Names field involves extraprocessing of incoming and outgoing messages. If you are certain that messagescontain only field names that comply with XML naming rules, you can clear thisfield to improve performance.

Globalization SupportTIBCO Rendezvous® activities use bw.palette.messageEncoding property as the wire formatencoding.

If this property is not set, the default wire format encoding value which supports all thecharacter set, is UTF-8. To change the wire format encoding other than UTF-8, set thebw.palette.messageEncoding property to the required encoding. In design time, you canspecify the property in VM arguments of Debug or Run Configurations like -Dbw.palette.messageEncoding=ISO8859-1 in the Debug Configrations dialog box. See thefollowing screenshot for reference.



Note: ISO8859-1 supports English and other western European languages thatbelong to ISO Latin-1 character set. UTF-8 can send and receive characters thatare not in the ASCII and Latin-1 character set.

In run time, you can specify the property in the config.ini file of the AppNode. For moreinformation, see TIBCO ActiveMatrix BusinessWorks™ Administration guide.

Rendezvous PublisherRendezvous Publisher is a synchronous activity that publishes a TIBCO Rendezvous®

message on the specific subject with the specified message content.

General





Description


Subject Yes The subject on which to publish the Rendezvous®

message. Specify a subject on the Input tab to overridethis value.

Transport Literal Value/ModuleProperty

The Rendezvous transport parameters. These arespecified as Rendezvous Transport sharedconfiguration resource.

Pre RegisterListener

Yes When using TIBCO Rendezvous Certified Messaging(RVCM), this field specifies the cmnames of the RVCMsubscribers. The publisher preregisters with anyexpected listeners. If multiple cmnames are specified,separate each cmname with a comma.

For more information about RVCM, see the TIBCORendezvous® documentation.

XML Format None If selected, the body of the Rendezvous® message isplaced into a single field named XML. This field is abyte array containing the body of the message. Thedatatype of the field is TIBRVMSG_XML.

XMLCompliantField Names

None Specifies whether the field names of the outgoingmessage should be altered so that they comply withXML naming rules.

Clear this check box to alter only the field names thatdo not comply with XML naming rules. When selected,the field names are left unaltered.

Description

Add a short description for the activity.



Input Editor

Define a schema element for the body of the Rendezvous message.

Input

The following is the input of this activity.

Field DataSource

Description

subject string The subject of the Rendezvous message.

replySubject string The subject to send replies for this Rendezvous message.This is useful if you want to use the Wait forRendezvous Message activity later in the process toreceive replies to the message.

preRegisterListner string When using TIBCO Rendezvous Certified Messaging(RVCM), this field specifies the cmnames of the RVCMsubscribers. This allows the publisher to pre-registerwith any expected listeners. If multiple cmnames arespecified, separate each cmname with a comma. Anylisteners preregistered on the Transport tab are alsopreregistered with the listeners specified in this element.

body complex The body of the Rendezvous message.

This field displays only when any schema is provided inthe Input Editor tab.

Fault





TransportException The transport cannot be created.

SerializationException The message cannot be serialized.

RVPluginException An error occurred when sending the message.

Rendezvous TransportRendezvous Transport resource describes a TIBCO Rendezvous ® transport. This resourceis used when specifying activities from the Rendezvous palette. For more informationabout specifying these fields, see the TIBCO Rendezvous documentation.

Configuration

The Configuration tab has the following fields.


Description

Name No Resource label.

Description No Short description of the shared resource.

Daemon Yes If the Rendezvous daemon is running on the samemachine as the process engine: Daemon is notspecified.

If the Rendezvous daemon is running on a differentmachine than the process engine:

Host name followed by the socket number.

For example:




Description

ssl:acct:5785

Network Yes Host name, IP address, network name, or interfacename.

For example:

;224.34.103.4

Service Yes TIBCO Rendezvous service name or port number:

For example:

<service name>

<port number>

SSL No Use Secure Sockets Layer (SSL) when communicatingwith the TIBCO Rendezvous daemon. Select this fieldto enable the Configure SSL button.

For more information, see Configure SSL Button.

Configure SSL Button

The Configure SSL button allows you to configure the SSL parameters for communicatingwith the TIBCO Rendezvous daemon. For more information about how SSL is configured forTIBCO Rendezvous daemons and clients, see the TIBCO Rendezvous documentation.

The SSL Configuration for TIBCO RV dialog tab has the following fields:

Field Description

DaemonCertificate

File containing one or more certificates from trusted daemon certificateauthorities. Select this field to connect to a trusted (non-rogue) daemon andretrieve a daemon certificate.



Field Description

Once a certificate is retrieved, select a project folder in the TIBCO Rendezvousadministration interface and choose Tools>Trusted Certificates>Import Into PEMFormat to import the certificate.

Alternatively, instead of importing or embedding them, configure certificatesat deployment time by declaring a global variable and setting its absolute pathto a certificate in PEM format.

To learn more about retrieving, importing, and configuring daemon certificatesusing the administration interface, see the TIBCO Rendezvous documentation.

Identity Identity resource used to authenticate the TIBCO Rendezvous daemon.

Click Browse to select an identity resource from a list of resources whose Typefield is set to Identity File or Username/Password.

Advanced

The Advanced tab has the following fields:

Field GlobalVariable?

Description

RV Type No Type of Rendezvous connection (reliable (standard RVtransport), certified (RVCM), or Distributed Queue (RVCMQ)).

Note: Use Confirm activity with RV Certified messaging.

The fields on the Advanced tab correspond to the valueselected for this field.

Certified Transport

CM Name Yes Name of the delivery-tracking session, in the same format asTIBCO Rendezvous subject names.

Ledger File Yes Name and location of the persistent ledger file that trackscertified messages. If not specified, the certified message ledger




Description

is kept in process memory only.

Sync LedgerFile

Yes Specifies whether to keep the ledger file synchronous with thecurrent messages.

Relay Agent Yes Name of the relay agent to use. Relay agents are useful whenclients are disconnected from the network from time to time.The relay agents store inbound certified messages and labeledmessages (and other messages related to certified deliveryfeatures) on behalf of their disconnected client programs. Whena client is connected, the relay agent receives inboundmessages immediately.

Require OldMessage

Yes Select this check box if you want to require the retention ofmessages for which delivery has not been confirmed. Thesemessages are be resent.

MessageTimeout(sec)

Yes Time limit for certified message delivery.

Distributed Queue Transport

CMQ Name Yes Name of the distributed queue, in the same format as TIBCORendezvous subject names.

WorkerWeight

Yes Weight of the worker (this pertains to the worker processingqueue requests, not to BusinessWorks process engines).Relative worker weights assist the scheduler in assigning tasks.When the scheduler receives a task, it assigns the task to theavailable worker with the greatest worker weight.

WorkerTasks

Yes Sets the task capacity for the worker (this pertains to theworker processing queue requests, not to BusinessWorksprocess engines). Task capacity is the maximum number oftasks that a worker can accept. When the number of accepted




Description

tasks reaches this maximum, the worker cannot acceptadditional tasks until it completes one or more of them.

WorkerCompleteTime

Yes The amount of time the scheduler waits for a worker process tocomplete. If the worker process does not complete the processin the specified time, the scheduler reassigns the message toanother worker.

SchedulerWeight

Yes Weight represents the ability of this member to fulfill the role ofscheduler, relative to other members with the same name.Cooperating distributed queue transports use relative schedulerweight values to elect one transport as the scheduler. Memberswith higher scheduler weight take precedence. Acceptablevalues range from 1 to 65535.

SchedulerHeartbeat(sec)

Yes Interval in which scheduler sends heartbeat messages. Allmembers with the same name must specify the same value forthis parameter. The value must be strictly positive.

SchedulerActivation(sec)

Yes Maximum amount of time that the heartbeat signal from thescheduler is silent before the member with the greatestscheduler weight becomes the new scheduler. All memberswith the same name must specify the same value for thisparameter. The value must be positive.

Rendezvous Reply To RequestRendezvous Reply to Request is a synchronous activity that is used to send a reply to areceived TIBCO Rendezvous® message.

General





Description


Reply to None This field sends reply to the Rendezvous® activity orprocess starter that received the request. This is aselection list of the following available activities thatcan receive Rendezvous messages.

l RendezvousSubscriber

l WaitForRendezvousMessage

ReplySubject

Yes The reply subject of the received Rendezvous message.You can override this value by specifying a subject onthe Input tab.


None Select this check box to specify whether the fieldnames of the outgoing message should be altered sothat they comply with the XML naming rules.

Clear this check box to alter only the field names thatdo not comply with XML naming rules. When selected,the field names are left unaltered.

Description


Input Editor

Use the Input Editor tab to define a custom schema for the body of the Rendezvousmessage.



Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Input



replySubject string The reply subject of the Rendezvous® message.

Fault



RVPluginException An error occurred when sending the reply message.

Rendezvous SubscriberRendezvous Subscriber is a process starter activity that creates a process when a TIBCORendezvous® message on the specified subject is received.

General





Description


Subject Yes The subject on which to listen for the Rendezvous®

message.

Transport Literal Value/ModuleProperty

The Rendezvous transport parameters. These arespecified as a Rendezvous Transport shared resource.

XML Format None If you select this check box, the body of the incomingRendezvous message is a single field named "xml".This field is a byte array containing the body of themessage.

TIBCO ActiveMatrix BusinessWorks™ automaticallydeserializes the xml field and represents the messageas a schema tree in this activity’s output.

Note: Note: When selected, the Need InputFilteration check box gets disabled.

Need OutputFilteration

None Specifies that only fields that match the name anddatatype of the schema elements specified on theOutput Editor tab should be processed. Any elementsthat do not match the specified schema are ignoredand not included in this activity’s output.

This is useful if you need only a subset of the fields ofan incoming message. Any unnecessary fields are notincluded in the activity output. This saves memory, andconsequently improves the performance.




Description

Note: Note: This option is valid, only when the XMLFormat check box is not selected. Do not select thischeck box when the XML Format check box is alsoselected.


None Specifies whether the field names of the incomingmessage should be altered so that they comply withXML and ActiveEnterprise naming rules. Only fieldnames that do not comply with XML andActiveEnterprise naming rules are altered when thischeck box is not selected. When selected, field namesare left unaltered.

Raw-RV-Object Mode

None Selecting this check box disables XML Format, NeedsOutput Filtration, and XML-Compliant Field Namescheck boxes.

Select this check box to specify that the body of the RVmessage is the output as a Java object reference. Asubsequent Java Invoke activity in the process canaccept the reference as an input parameter and thenconstruct the RV message from the object. To use theJava object, the Java Invoke activity must cast theobject reference as a byte array. For example:

TibrvMsg tibrvMsg = new

TibrvMsg ((byte[])in_var_1);

Where in_var_1 is the input parameter for the JavaInvoke activity that is mapped to the object referenceof the object containing the Rendezvous message.

Description




Advanced


Field Description

SequenceKey

This field can contain an XPath expression that specifies which processesshould run in a sequence. Process instances with sequence keys that evaluateto the same value, are executed sequentially in the sequence the processinstance was created.

Custom JobId

This field can contain an XPath expression that specifies a custom job ID forthe process instance.

Output Editor

Use the Output Editor tab to define a custom schema for the body of the Rendezvous®

message.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see Application Development.

Output



sendSubject string The subject of the received message.

replySubject string The reply subject of the Rendezvous® message.



Rendezvous Request ReplyRendezvous Request Reply is an asynchronous activity that publishes a TIBCORendezvous® message on the specified subject with the specified message content. A replyto the message on the specified reply subject and with the specified reply message contentis received by this activity. This activity waits for a reply on the reply subject and outputsthe content of the reply. This activity uses the INBOX mechanism to ensure that replymessages are received only by the process that sent the request.

General



Description


Subject Yes The subject on which to publish the Rendezvous®

message. You can override this value by specifying asubject on the Input tab.

Transport Yes The Rendezvous transport parameters. These arespecified as a Rendezvous Transport sharedconfiguration resource.

RequestTimeout(msec)

Yes The length of time to wait (in milliseconds) for a replyto the Rendezvous message. If no reply is received inthe specified time limit, it returns an error.

Pre-registerListener

Yes When using TIBCO Rendezvous Certified Messaging(RVCM), this field specifies the cmnames of the RVCMsubscribers. The sender can preregister with anyexpected listeners. If multiple cmnames are specified,separate each cmname with a comma.




Description

For more information about RVCM, see the TIBCORendezvous® documentation .

XML Format None If this check box selected, the body of the Rendezvous®

request and reply messages is sent as a single fieldnamed "xml". This field is a byte array containing thebody of the message.

Need OutputFiltration

None Specifies that only fields in the reply message thatmatch the name and datatype of the schema elementsspecified on the Output Editor tab should beprocessed. Any elements that do not match thespecified schema are ignored and not included in thisactivity’s output.

This is useful if you need only a subset of the fields of areply message. Any unnecessary fields are not includedin the activity output. This saves memory, andconsequently improves performance.

Note: Note: This option is only valid when the XMLFormat check box is not selected.

XMLCompliantField Namesfor Input

None Specifies whether the field names of the input messageshould be altered so that they comply with XMLnaming rules. Only field names that do not complywith XML naming rules are altered when this check boxis not selected.

Select this check box if you want the field names to beunaltered.


None Specifies whether the field names of the outgoingmessage should be altered so that they comply withXML naming rules. Only field names that do not comply




Description

for Output with XML naming rules are altered when this check boxis not selected.

Select this check box if you want the field names to beunaltered.

Description

Provide a short description for the activity in this field.

Input Editor

In the Input Editor tab you can define custom schemas for the body of the outgoingRendezvous request and body of the incoming Rendezvous response.

Output Editor

In the Output Editor tab you can define custom schemas for the body of the outgoingRendezvous request and body of the incoming Rendezvous response.

Input



subject string The subject of the Rendezvous message.

replySubject string The reply subject for this activity.

timeout number The amount of time to wait (in milliseconds) for a reply tothe Rendezvous message. If no reply is received in the giventime limit, an error is returned.



Output



replySubject string A reply message can optionally have a reply subject,presumably so that the two applications can communicatewith further messages. This element contains the replysubject set on the reply message, if one is set. If no replysubject is set on the reply message, this element is notpopulated.

Fault



TransportException The transport cannot be created.

SerializationException The message cannot be serialized.

RVPluginException An error occurred when sending the message.


Wait for Rendezvous MessageWait for Rendezvous Message activity waits to receive a TIBCO Rendezvous® message withthe specified subject.

General





Description


Subject Yes The subject on which to listen for the Rendezvous®

message.

Transport Yes The Rendezvous transport parameters. These arespecified as a Rendezvous Transport sharedconfiguration resource.

XML Format None If this check box is selected, the body of the incomingRendezvous message is expected to be a single fieldnamed "xml". This field is a byte array containing thebody of the message.

TIBCO ActiveMatrix BusinessWorks™ automaticallydeserializes the xml field and represents the messageas a schema tree in this activity’s output.

Need OutputFiltration

None Specifies that only fields that match the name anddatatype of the schema elements specified on theOutput Editor tab should be processed.

Any elements that do not match the specified schemaare ignored and not included in this activity’s output.


None Specifies whether the field names of the incomingmessage should be altered so that they comply withXML and ActiveEnterprise naming rules. Only fieldnames that do not comply with XML naming rules arealtered when you clear this check box.

Select this check box to leave the field namesunaltered.



Description


Event


Field Description


A message may arrive before this activity is executed. This field specifies theamount of time (in seconds) a message waits if it is received before this activityis executed. If the event timeout expires, an error is logged and the event isdiscarded.


Specify the amount of time (in milliseconds) for an activity to wait before it isexecuted.

Output Editor

From the Output Editor tab you can define custom schemas for the body of the outgoingRendezvous request and body of the incoming Rendezvous response.

Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.For more information about conversations, see the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Output

The Output tab has the following fields.




sendSubject string The subject of the received message

replySubject string The reply subject of the Rendezvous® message

Fault





407 | REST and JSON

REST and JSONThe activities of REST and JSON Palette can be used to invoke RESTful web services andexpose processes as RESTful web services. The activities in this group can also be used toconvert data between JSON format and XML format.

BW JSON UtilsBW JSON utils provide an easier way to create XML schema (XSD files) from JSON payloador SQL statements.

Create XSD Schema from JSON payload

To create a schema from an available JSON payload:

1. From the Project Explorer pane, right-click on the Schemas folder and click New >XML Schema File from JSON Payload.

2. In the JSON to Schema Wizard, enter a schema file name in the Schema File Namefield.

3. Enter the JSON payload, to be used during the conversion, in the JSON Sample field,and click Next.

Note: A validation error displays in TIBCO Business Studio forBusinessWorks if any values from the JSON payload are not valid.

If the conversion is successful, the message JSON payload parsed successfully...Createdschema <Name>.xsd displays in the JSON to Schema Wizard window, and you can closethe wizard.

Create Schema from an SQL String

To create an SQL schema:


408 | REST and JSON

1. In the Process package, click Resources > JDBC Connection Resource and verifywhether the JDBC connection is able to connect to the database successfully.

2. Right-click the fully configured JDBC Connection Resource > BW JSON Utils >Create Schema from SQL.

3. In the SQL Query Builder, provide the query statement to fetch the requiredinformation and click OK.

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 receivesresponses from the service provider.

Note: For the Invoke REST API activity to work, an HTTP Client shared resourceis required. In the HTTP Client shared resource, make sure ApacheHttpComponents (Supported by HTTP and REST) is selected as theImplementation Library in the HTTP Client section.

Note: To invoke the DELETE method of a REST service implemented in Opaquemode, it is not possible to send request body as an asciiContent for the InvokeREST API activity. To send the request body, we have to use the Send HTTPRequest activity with the Jetty HTTP Client implementation library in the HTTPClient shared resource.

Note: MIME or multipart data format attachments are not supported as responseor request in Invoke REST API activity

General



409 | REST and JSON


Description


HTTP Client Yes The HTTP client resource.

ResourcePath

No The resource of the REST service.

Note:l Spaces and special characters are not supported in the

path and query parameter name.

l To use special characters in a query parameter name,percent-encode the question mark (?) as %3F.

This field is mandatory.

HTTPMethod

No The REST methods used for the requests.

Select from one of the following available methods:

l POST

l GET

l PUT

l DELETE

l PATCH

RequestType

No The value of the Content-Type header set while invoking theREST operation.

l JSON: the service provider returns the data in the JSONformat.

l XML: the service provider returns the data in the XMLformat.

l Custom: to override the Content-Type value in the Inputtab, select CUSTOM and provide the value in the Inputtab.


410 | REST and JSON


Description

ResponseType

No The value of the Accept header set while invoking the RESTOperation.

l JSON: the service provider returns the data in the JSONformat.

l XML: the service provider returns the data in the XMLformat.

l Custom: to override the Accept header value in the Inputtab, select CUSTOM and provide the value in the Inputtab.

Description

Provide a short description for the Invoke Rest API activity.

Advanced


Field Description

Output HTTPResponseHeaders

Selecting this check box displays the HTTP headers received in theresponse.

Request EntityProcessing

This field has two values:

l BUFFERED: the request entity is buffered in memory to determine thecontent length that is sent as a Content-Length header in the request.

l CHUNKED: the entity is sent as chunked encoded (no Content-Lengthis specified, entity is streamed). The Transfer-Encoding header is setto Chunked.

The default value is Chunked.


411 | REST and JSON

Field Description

ActivityTimeout(seconds)

Timeout to invoke a RESTful web service and receive a response from theservice provider after an Invoke REST API call is sent.

The Default Timeout is three (3) minutes.

Input



ResourcePath string This value overrides the value provided in the ResourcePath field on the General tab.

Message Body string The body of the HTTP request message.

asciiContent string The ASCII content (ASCII content of the request likePOST or PUT to the server) of the request to the HTTPserver.

HttpHeaders string The header of the HTTP request. The header structure isdefined by the HTTP protocol.

For more information about the fields and content of theheader of an HTTP request, see the W3C HTTPspecification at w3.org.

l Accept: specifies the media types that areacceptable for response messages for theincoming request. For example, text/*,text/html.

For more information about media types, see theW3C HTTP specification at w3.org

Note: To get status messages for exceptions,set the Accept field to */* or text/html.

l Accept-Charset: specifies the character sets that





412 | REST and JSON


are acceptable for response messages for theincoming request. For example, iso-8859-5,unicode-1-1.

For more information about character sets, see theW3C HTTP specification at w3.org.

l Accept-Encoding: specifies the content-codingvalues that are acceptable for response messages.For example, compress, gzip.

l Content-Type: the media type of the entity bodysent to the receiver.

For more information about media types, see theW3C HTTP specification at w3.org.

l Content-Length: indicates the size of the entitybody sent to the receiver.

l Connection: the requestor can specify optionsdesired for this connection. For example, theoption close specifies that the requestor wouldlike the connection to be closed when the requestis complete.

l Cookie: For more information about this field, seethe W3C HTTP specification at w3.org.

Note: For correct parsing and processing ofcookies, input must be in the format"key=value".

l Pragma: is used to include implementation-specific directives that might apply to the receiver.

For more information about this field, see the W3CHTTP specification at w3.org.

DynamicHeaders complex The dynamic header is an additional header parameterto add runtime headers to the outgoing HTTP messages.The DynamicHeaders consists of the following






413 | REST and JSON


information:



Output



statusCode The HTTP Response Code.

reasonPhrase ReasonPhrase is intended for giving a short textual description ofstatusCode.

MessageBody The body of the response message. This is asciiContent.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see the TIBCO ActiveMatrixBusinessWorks™ Error Codes.


HttpCommunicationException An HTTP exception occurred when trying to execute thespecified method, or when trying to read the response.

HttpClientException The HTTP server replied with a message that has the 4XXstatus code.

HttpServerException The HTTP server replied with a message that has the 5XXstatus code.


414 | REST and JSON

Support for Path and Query Parameters

Invoke REST API activity supports both Path and Query parameters. For Path Parameters,enclose each path parameter in { } brackets. For example, if the resource path is set as/books/{isbn}, a PathParameters element is added to the activity input.

Multiple path parameters can be defined in a similar way. The activity also supports staticURL content mixed with path parameters, for example, /books/{isbn}/events/{author}.

Query parameters are defined using the pattern /staticUrl?Param1&Param2.

A QueryParameters element is added to the Input tab of the activity with each of theparameter listed. For example, if the resource path is set as /books?isbn&author, aQueryParamters element is added to the activity input.

Policy


with the Invoke REST API activity, click the Add Policy to Activity icon. To edit

policy details, click Go to selected Policy icon. The Policy tab has the followingfields.

Field Description


Type The type of policy associated with the activity. The Invoke REST API activitycan support the Basic Credential Mapping policy.



415 | REST and JSON

Restrictions on XML SchemaThis topic lists the restrictions on XML Schema.

General Restrictionsl No wildcards or attribute wildcards. For example, any element and any attribute is not

supported.

l Complex types might not contain both an attribute and a child element with thesame local name.

l Complex types might not be of the pattern "simple type plus attributes".

l Complex types might not contain mixed content.

l Attributes that are not part of the default (empty) namespace, cannot be used forComplex Elements.

l The 'choice' and 'sequence' compositors might not have maxOccurs > 1 (same as therestriction on 'all' in the schema specification).

l Substitution groups are not supported.

l Element of simple type with an attribute is not supported.

l The elementFormDefault can only be qualified for schemas used by REST binding andJSON activities.

l Schemas should not contain cyclic dependencies within same schema, or on theother schemas.

l Schemas should not have a type that has two child members with the same localname, but different namespaces.

l For float and double values, XML schema always shows exponential values of type1.0E0

Parse JSONParse JSON activity takes the JSON data, processes it, and converts it into XML data.


416 | REST and JSON

General



Description

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

Schema Type None Specifies the mode for the output data. The followingschema types are supported:

l Generic: converts a JSON string to an XML string

l XSD: converts a JSON string to an XMLdocument defined using a schema specified inthe Output Editor.

The default value in this field is the XSD schema type.

Note: Ensure the schema resource you select doesnot contain cyclic dependencies on other schemas ,or a type that has two child members with thesame local name, but different namespaces.

Badgerfish None Specifies the following conversion rules:

l Select this check box for converting JSON datato XML data with the mapping of XMLnamespace, XML attribute, CDATA, and so on.

l Do not select this check box if you want normalconversion rules for mapping data from JSON toXML.

XML attributes are converted into elements when thecheck box is not selected


417 | REST and JSON


Description

Input JsonStyle

None Specifies the method to parse the data.

l None : Select this option to exclude the rootelement in the JSON string.

l Json with Root : Select this option to includethe root element in the input JSON string.

l Anonymous Array : Select this option to accepta Json array without the parent element, wherethe root element has exactly one child of thetype Array.

Use Null ForEmpty Values

None Select the check box to use null in the place of emptyvalues in the JSON. This option is applicable only forObjects and Arrays. This has no effect on primitivetypes. By default, the check box is not selected.

IgnoreAdditionalJSON Fields

None This check box is available when the XSD option isselected in the Schema Type field.

Select the check box to ignore the additional fieldsreceived due to the changes made in external payloadwhile processing the schema.

This check box is not selected by default.

Description

Provide a short description for the Parse JSON activity.

Output Editor

From the Output Editor you can define or reference an XML schema for the activity output.You can use the BW JSON Utils tool to generate an XML schema file with a specified JSONfile.


418 | REST and JSON

Input


Field Description

jsonString The input JSON data for translation.

Output

The output for the Parse JSON activity varies depending on the data schema you specifiedin the Schema Type field on the General tab.

Fault

The Fault tab lists the possible exceptions generated by this activity. For more informationabout error codes and the corrective action to take, see the ActiveMatrixBusinessWorksError Codes.


JSONParserException An exception occurred when parsing the JSON data.

Render JSONRender JSON activity takes XML data and renders it as a JSON string.

General



419 | REST and JSON


Description


Schema Type None Specifies a schema type for the output data. Thefollowing are the supported schema types:

l Generic : converts an XML string to a JSON string

l XSD : converts an XML string to a JSONdocument defined using a schema specified inthe Output Editor.

The default value in this field is the XSD schema type.

Badgerfish None Specifies the following conversion rules:

l Select this check box for converting JSON datato XML data with the mapping of XMLnamespace, XML attribute, CDATA, and so on.

l Do not select this check box if you want normalconversion rules for mapping data from JSON toXML.

XML attributes are converted into elements when thecheck box is not selected

Output JsonStyle

None Specifies the method to render the data.

l None : Select this option to exclude the rootelement in the JSON string.

l Json with Root : Select this option to includethe root element in the input JSON string.

l Anonymous Array : Select this option to returna JSON array without the parent element, wherethe root element has exactly one child of thetype Array.


420 | REST and JSON


Description

Use EmptyValues ForNull

None Select the check box to use empty values in the placeof null in JSON. This option is applicable only forObjects and Arrays. This has no effect on primitivetypes. By default, the check box is not selected.

Note:l The "com.tibco.plugin.restjson.xml2json.emptytonull" property is newly added for

the Rendor JSON activity. This property when set to true converts the ""(refers to empty string) and "{}" (refers to empty element or object) to the"null" value in the output generated by the Rendor JSON activity.

l The "com.tibco.bw.rest.renderjson.generic.parseDataTypes" property is newlyadded for the Rendor JSON activity with generic schema type. On settingthis property to true, numeric values are rendered without quotes, else thedefault behavior of enclosing all values within quotes is followed.

Description

Provide a short description for the Render JSON activity.

Input Editor

From the Input Editor tab, you can define or reference an XML schema for the activityinput. You can also use the BW JSON Utils tool to generate an XML schema file with aspecified JSON file.

Input

The input data for the Render JSON activity is in the XML format. The schema type of theXML data varies depending on the schema type you specified in the Schema Type field onthe General tab.


421 | REST and JSON

Output

The Output tab contains the following field.

Field Description

jsonString The translated data in JSON string format.

Fault



JSONRenderException An exception occurred when rendering the data.

Transform JSONTransform JSON activity takes input data in JSON format and transforms it into JSONformat according to the Jolt specifications.

General



Description


SpecFile

Yes Specify the location of Jolt specification file.

For more information, see Jolt Specification atGithub.com.

https://github.com/bazaarvoice/jolt


422 | REST and JSON

Description

Provide a short description for the Transform JSON activity.

Input


Field Description

JsonInput Mandatory. Input content in the JSON format.

SpecContent Provide Jolt specification file content in the JSON format.

You can either provide a path to the file in the General tab or provide filecontent in the SpecContent field.

Output


Field Description

JsonOutput Output in the JSON format converted as per the Jolt specification used.

Fault

The Fault tab has the following fields.


JSONTransformException There is invalid Jolt specification file or JSON input.

Note: If you are using an external file for JOLT specification in SpecContentfield, make sure the file path is accessible to the application container.


423 | Policy Resources

Policy ResourcesPolicies are resources which you can define and configure in TIBCO Business Studio forBusinessWorks. You can define a policy and then reference it from multiple activities orbinding in the same or different process. For example, you can define a BasicAuthentication policy, and refer it either from an HTTP Receiver activity, or from a RESTbinding.

Basic Authentication Policy

Applying this policy ensures that users cannot access your application unless theircredentials are verified.

Basic AuthenticationThe Basic Authentication policy resource provides options you can configure when you setup a basic authentication security policy.

General

The General section has the following fields.

Field Description

Package The name to be displayed as the label of the policy resource package.

Name The name of the policy resource.

Description A short description of the policy resource.

Service Provider Details

The service provider you select authenticates user name and password credentials. TheService Provider Details section has the following fields.



Field Description

SelectAuthenticationType

Select a way to authenticate user credentials:

l LDAP Authentication

l XML File Authentication

LDAP Resource Create a new LDAP Authentication resource, or specify an existing LDAPAuthentication resource. The Basic Authentication policy references theLDAP Authentication resource you select.

XML FileResource

Create a new XML Authentication resource, or specify an existing XMLAuthentication resource. The Basic Authentication policy references theXML Authentication resource you select.

Authentication Tab

Field Description

Authorizationby Role

Select the check box to enable the following fields:

l Radio buttons: Permit and Deny

l Roles section.

For more information see XML Authentication.

Permit Select the radio button to authorize the specific roles specified in the Rolestable.

Deny Select the radio button to deny the specific roles specified in the Rolestable.

Roles Add or remove roles to which authorization access is allowed or denied.

For XML Authentication, groups are defined in an XMLUsers.xml file undergroup-mapping tag in the XML Authentication shared resource.

For LDAP Authentication, groups are defined under the Users and Groupstab of the LDAP Authentication shared resource.

Authorization Tab



Field Description

Roles are case-sensitive. To sort roles in alphabetical order click the Rolesheader.

To add roles, click the Add button. Add roles by clicking on a last emptyrow.

To remove roles, click Delete button.

To move roles, click Move button.

Note: When you select the Permit or Deny options, it is mandatory toadd roles.

Basic Credential MappingConfigure the Basic Credential Mapping policy resource to set up a basic credentialmapping security policy.

General


Field Description




Credential Mapping

You can choose to enforce either Fixed credential mapping or Conditional credentialmapping.

Fixed



Select this option to ensure that a fixed set of credentials is applied to all users regardlessof their user type or role. The Fixed section has the following fields:

Field Description

Identity Provider Select an Identity Provider to authenticate user credentials.

Conditional

Select Conditional credential mapping to enforce credential mapping for authenticatedusers and anonymous users. Credentials are mapped for authenticated users if the requestcomes from an authenticated service. Credentials are mapped for anonymous users if therequest comes from an unauthenticated service.

The Conditional section has the following fields:

Field Description

Role basedIdentityProviders

Type roles for authenticated users and associate an Identity Provider witheach role. You can reuse the same Identity Provider for multiple roles.

AuthenticatedIdentity Provider

Select an Identity Provider shared resource for authenticated users.

AnyonymousIdentity Provider

To allow anonymous users access to your secure application, specify anIdentity Provider. To not allow anonymous users access, do not specifyan Identity Provider.

Note: Application logic can also affect how credentials are mapped foranonymous users. For example, application logic might dictate thatanonymous requests are redirected to specific entry points. If ananonymous request is directed to an enforced entry point, the requestis rejected.

WSS ConsumerConfigure the WSS Consumer policy to enforce confidentiality, integrity, and timestamping,and credential mapping.



General


Field Description



Description A description of the policy resource.

Shared Resource for WSS Processing

The Shared Resource for WSS Processing section has the following fields.

Field Description

WSSVerification

The WSS Verification shared resource that the WSS Consumer policyreferences.


The Service Provider Details section comprises of the Confidentiality tab, the Integritytab, the Timestamp tab, and the Credential Mapping tab.

Confidentiality

To maintain confidentiality, the policy can be configured for an outbound request to beencrypted and an inbound response to be decrypted at its endpoint. The Confidentialitytab has the following fields:

Field Description

EncryptRequest

Specify the following fields:

1. Trust Provider: Select a Trust Provider shared resource.



Field Description

2. Key Alias: Specify a Key Alias.

3. Algorithm Suite: Specifies the algorithm suite required for performingcryptographic operations with symmetric or asymmetric key basedsecurity tokens. An algorithm suite specifies actual algorithms andallowed key lengths. The default selection is Basic128. You can select adifferent algorithm suite from the drop-down menu.

4. Encrypt: Specify to Encrypt Parts or to Encrypt Elements of themessage.

a. Encrypt Parts: Select this option to encrypt the Body, Header, orboth parts of the message.

b. Encrypt Elements: Select this option to encrypt elements in therequest message. When specifying the Element, ensure you alsospecify the Namespace of the element, and Prefix of the elementif it has one.

DecryptResponse

To Decrypt response, provide the Subject Provider or the Subject Provider(with Trust Credential) value in the WSS Authentication policy resource, andselect the Enable Decryption check box on the Basic Configuration section ofthe WSS Authentication policy resource.

Integrity

To maintain integrity, the outbound request can be signed and the signature verified in theinbound response. The Integrity tab has the following fields:

Field Description

SignRequest


1. Subject Provider: Select a Subject Provider shared resource.

2. Algorithm Suite: Specifies the algorithm suite required for performingcryptographic operations with symmetric or asymmetric key basedsecurity tokens. An algorithm suite specifies actual algorithms andallowed key lengths. Default type is Basic128. You can select a different



Field Description

algorithm suite from the drop-down menu.

3. Digest Algorithm for Signature: The algorithm takes as input a messageof arbitrary length and produces as output a 128-bit "fingerprint" or"message digest" of the input. Default type is SHA-256. You can select adifferent type from the drop-down menu.

4. Sign: Specify to Sign Parts or to Sign Elements.

a. Sign Parts: Select this option to sign the Body, Header, or bothparts of the message.

b. Sign Elements: Select this option to sign elements in the requestmessage. When specifying the Element, ensure you also specifythe Namespace of the element, and Prefix of the element if it hasone.

VerifySignatureonResponse

Select the check box to enable the Verify parts that are Signed field.

Select from the following options from the drop-down menu :

1. Entire message

2. Message header

3. Message body

Timestamp

Under the Timestamp tab, configure the following fields to insert a timestamp in anoutbound request and verify a timestamp in the inbound response.

Field Description

Set Timestamp on Request Specify time-to-live in seconds.

Verify Timestamp on Response No additional configuration required.



Credential Mapping

Under the Credential Mapping tab, select either Username Token credential mapping orSAML Token credential mapping to map credentials to the outbound request.

Field Description

NoCredentials

Select this option to ensure credential mapping is not enforced.

UsernameToken basedCredentialMapping

Select Fixed or Conditional:

l If you select Fixed, specify an Identity Provider resource in theIdentity Provider field.

l If you select Conditional, specify the types of users your applicationmaps credentials for. You can choose to map credentials forauthenticated users with roles, authenticated users, and anonymoususers.

For configuration details, see Basic Credential Mapping.

SAML TokenbasedCredentialMapping

Configure the following fields:

1. SAML Token Profile: Select a token type. Specify either SAML 1.1Token 1.1 or SAML 2.0 Token 1.1.

2. Sign SAML Assertion: If you select this option, the following fields areenabled:

l Subject Provider: Specify a Subject Provider shared resource.

l Digest Algorithm for Signature: Select one of the followingoptions from the drop-down menu:

o SHA1

o SHA256

o SHA384

o SHA512

l Algorithm Suite: Select one of the following options from thedrop-down menu:



Field Description

o Basic128

o TripleDes

o Basic256Rsa15

o Basic192Rsa15

o Basic128Rsa15

o TripleDesRsa15

o Basic256Sha256

o Basic192Sha256

o Basic128Sha256

o TripleDesSha256

o Basic256Sha256Rsa15



o TripleDesSha256Rsa15

3. SAML Issuer Name: Type a SAML issuer name.

4. SAML Assertion Validity: Select SAML Assertion Validity (forever) toensure that the SAML assertion is valid indefinitely. Optionally, you canselect Specify Validity Period (sec) to specify the number of secondsthe SAML assertion is valid.

WSS ProviderThe WSS Provider policy acts on the server side to ensure that the confidentiality, integrity,and timestamp of a request remains secure.

General




Field Description




Shared Resource for WSS Processing

The Shared Resource for WSS Processing section has the following fields.

Field Description

WSSVerification

The WSS Verification shared resource that the WSS Provider policyreferences.


The Service Provider Details section comprises of the Authentication tab, Confidentialitytab, the Integrity tab, and the Timestamp tab.

Authentication

The Authentication tab has the following fields that you can enable to enforceauthentication on a request message.

Field Description

NoVerification

Select this option to ensure that credentials are not authenticated throughuser name token or SAML token.

Verifyusernametoken

Select this option to authenticate user credentials through user name token.If you select this option, ensure you have configured the User Authenticationtab on the WSS Authentication Shared Resource.

Verify SAML Select this option to authenticate user credentials through SAML token.



Field Description

token Select one of the following confirmation methods:

1. Bearer

2. Holder of Key

3. Sender VouchesSelect one of the following security token types:

1. SAML 1.1 Token 1.1

2. SAML 2.0 Token 1.1

Specify Issuer Name

Confidentiality

An inbound request can be decrypted and an outbound response can be encrypted tomaintain confidentiality. The Confidentiality tab has the following fields:

Field Description

DecryptRequest

To Decrypt request, provide the Subject Provider or the Subject Provider(with Trust Credential) value in the WSS Authentication policy resource, andselect the Enable Decryption check box on the Basic Configuration section ofthe WSS Authentication policy resource.

EncryptResponse


1. Trust Provider: Select a Trust Provider shared resource.

2. Key Alias: Specify a Key Alias.

3. Algorithm Suite: Specifies the algorithm suite required for performingcryptographic operations with symmetric or asymmetric key basedsecurity tokens. An algorithm suite specifies actual algorithms andallowed key lengths. The default selection is Basic128. You can selectone of the following algorithms suite from the drop-down menu:

l Basic128

l TripleDes



Field Description

l Basic256Rsa15

l Basic192Rsa15

l Basic128Rsa15

l TripleDesRsa15

l Basic256Sha256

l Basic192Sha256

l Basic128Sha256

l TripleDesSha256

l Basic256Sha256Rsa15



l TripleDesSha256Rsa15

4. Encryption Algorithm: Select one of the following encryption algorithmsfrom the drop-down menu:

l AES_128

l AES_192

l AES_256

l AES_128_GCM

l AES_192_GCM

l AES_256_GCM

l TRIPLE_DES

5. Encrypt: Specify to Encrypt Parts or to Encrypt Elements of themessage.

a. Encrypt Parts: Select this option to encrypt the Body, Header, orboth parts of the message.

b. Encrypt Elements: Select this option to encrypt elements in theresponse message. When specifying the Element, ensure you also



Field Description

specify the Namespace of the element, and Prefix of the elementif it has one.

Integrity

Maintain integrity by verifying the signature on an inbound request and signing anoutbound response. The Integrity tab has the following fields:

Field Description

VerifySignatureon Request

Select from the following options from the drop-down menu Verify parts thatare signed :

1. Entire message

2. Message header

3. Message body

SignResponse


1. Subject Provider: Select a Subject Provider shared resource.

2. Algorithm Suite: Specifies the algorithm suite required for performingcryptographic operations with symmetric or asymmetric key basedsecurity tokens. An algorithm suite specifies actual algorithms andallowed key lengths. Default type is Basic128. Select a one of thefollowing algorithm suites from the drop-down menu:

l Basic128

l TripleDes

l Basic256Rsa15

l Basic192Rsa15

l Basic128Rsa15

l TripleDesRsa15

l Basic256Sha256



Field Description

l Basic192Sha256

l Basic128Sha256

l TripleDesSha256




l TripleDesSha256Rsa15

3. Digest Algorithm for Signature: The algorithm takes as input a messageof arbitrary length and produces as output a 128-bit "fingerprint" or"message digest" of the input. Default type is SHA-256. Select one of thefollowing options from the drop-down menu.

l SHA1

l SHA256

l SHA384

l SHA512

4. Sign: Specify to Sign Parts or to Sign Elements of the message.

a. Sign Parts: Select this option to sign the Body, Header, or bothparts of the message.

b. Sign Elements: Select this option to sign elements in the responsemessage. When specifying the Element, ensure you also specifythe Namespace of the element, and Prefix of the element if it hasone.

Timestamp

To track the time of the request, a timestamp is inserted in the request. The Timestamptab has the following fields:



Field Description

Verify Timestamp on Request No additional configuration required.

Set Timestamp on Response Specify the time-to-live in seconds.


438 | Shared Resources

Shared ResourcesShared resources are used to define a resource that contains configuration data that canbe referenced from multiple processes.

Data FormatThe Data Format shared resource contains the specification for parsing or rendering a textstring using the Parse Data and Render Data activities. This resource specifies the type offormatting for the text (delimited columns or fixed-width columns), the column separatorfor delimited columns, the line separator, the fill character, and field offsets for fixed-widthfor fixed-width columns.

You must also specify the data schema to use for parsing or rendering the text. Whenparsing text, each column of an input line is transformed into the corresponding item inthe specified data schema. The first column of the text line is turned into the first item inthe data schema, the second column is transformed into the second item, and so on. Eachline is treated as a record, and multiple lines result in a repeating data schema containingthe lines of the input text string. The following figure illustrates how an input text string isparsed 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 ofoutput text. The first item of the data schema is transformed into the first column of thetext line in the output text string. Rendering a data schema into a text string is exactly theopposite process of parsing a text string into a data schema.

Data Format Editor

This editor contains General, Data Format Configuration, Data Format Editor, and FieldOffsets sections.

General


Field Description

Package The name of the package in which you want to create a shared resource.

Name The name of the shared resource.

Description A short description of the shared resource.

Data Format Configuration

You can define the structure of the data file by using the Data Format Configuration panel.

Field Description

Format Type The Type of formatting for the text. The text can be either Delimiter separatedor Fixed format.

When you select the Delimiter separated option, the text in each column isseparated by a delimiter character, specified in the Col Separator field. Eachline is separated by the character specified in the Line Separator field.

When you select the Fixed format option, the text in each column occupies afixed position on the line. For fixed format text, you must specify the fillcharacter, the line length, and the column offsets.



Field Description

ColSeparator

This field specifies one or more separator characters between columns whenDelimiter separated option is specified in the Format Type field.

When rendering text, each element in the input data schema is separated bythe column separator in the output text string. If more than one character isspecified in this field, the Render Data activity places the entire stringspecified in this field between each column.

For example, if ":;" is specified in this field, then ":;" displays between eachcolumn in the rendered string.

When parsing text, each column becomes an element in the output dataschema. If more than one character is specified in this field, the Parse Dataactivity uses the rules specified in the Col Separator Parse Rule field todetermine how to parse the data.

This field supports the Module property.

ColSeparatorParse Rule

Specifies the rule to use for multiple column separator characters whenparsing data. The choices are the following:

l Treat all characters entered as a single column separator string.

The characters entered into the Col Separator field are treated as asingle string that acts as a separator. For example, if the specified ColSeparator is ":;" then Apple:;Orange:;Pear is treated as three columns.

l Treat each character specified as a potential column separator

Any of the characters acts as a column separator. For example, if thespecified Col Separator is ":;" Apple;Orange:Pear is treated as threecolumns.

LineSeparator

Specifies the character(s) that determine the end of each line. Available LineSeparator characters are:

l New Line

l Carriage Return

l Carriage Return/Line Feed(windows)



Field Description

When parsing text each line is treated as a new record in the output dataschema. When rendering text, each data record is separated by the lineseparator character in the output text string.

The last line in your input file must be terminated by the specified lineseparator.

FillCharacter

When processing fixed format columns, this is the type of character that isused to fill the empty space in a column and between columns. This field isonly available when you select the Fixed format option in the Format Typefield. The fill character is used only by the Render Data activity.

You can select any one from the following available options:

l Space: fills with a space

l Dash: fills with a dash

l 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 widthis 10. One row has the value "588" for that column. Because the width of 588 isthree and the column width is 10, the remaining 7 characters are filled with thespecified fill character.

Data Format Editor

You can define a custom schema for the text in the Data Format Editor panel. You candefine your own datatype here. After defining the data type, the data specified here is usedto parse a text string into the specified schema or render the specified schema as a textstring. The Header element contains the following:

l @attribute

l (any element)

l primitive

l (any element)



Field Offsets

When processing fixed format text, you must specify the line length and the column offsets.This enables the Parse Data or Render Data activity to determine where columns and linesbegin and end. You can specify the format of fixed-width text using the Field Offsets.

The line length is the total length of input lines, including the line separator characters.Include the appropriate number of characters for the selected line separator in the DataFormat Configuration to the total length of each line.

The column offset is the starting and ending character position on each line for thecolumn. Each line starts at zero (0). For each column of the line, you must specify the nameof the data item associated with this column (this is the same name you specified for thecorresponding elements in the data schema), the starting offset for the column, and theending offset for the column.

Each column offset can begin where the last column offset ended. Many fixed format datafiles are used by databases or are generated by automated processes. These files have rigidfile record formats and may not have additional padding space between the columns.When you define each column offset to begin where the last column offset ends, you canread the data more quickly. This is because you can read sequentially the bytes of theinput records.

Consider the following text file. The first two lines of the file indicate offset numbers (each0 indicates another 10 characters), and the fill character between columns is spaces:

0 12 30 45 01234567890123456789012345678901234567890123456789012345678 57643Smith Chris Account 57644 Jones Pat Marketing 57645 Walker Terry Development

Delimiter Separated Fields

When processing delimiter-separated text, each field in the input line is separated by thedelimiter specified by the Column Separator field. Leading and trailing spaces are strippedfrom each field and the specified Line Separator determines when a new record starts.

In some situations, you may not be able to choose a column separator character that doesnot display in any column data. For example, if you choose a comma as the columnseparator, there may be commas in some of the column values. To process data thatcontains column separator characters in a column, you can surround the column withdouble quotes (" "). You can also use double quote to include leading and trailing spacesas well as line breaks in a field. If you want to display a double quote in a field, escape thedouble 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 yourcompany 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 acomma. The entire field is surrounded by double quotes, so it is still treated as part of thesame record.

FTP ConnectionFTP Connection shared resource describes a connection to an FTP server. Use the FTPconnections when configuring activities in the FTP palette.

General


Field Description




FTP Connection





Description

Host Yes The host name or IP address of the FTP server.

Port Yes The port number of the FTP server. For connectionsinside of a firewall, when no value is specified in thisfield, the default value is 21.

User Name Yes The user name to use when logging into the FTP server.

Password Yes The password to use when logging into the FTP server.This field is mandatory.

Mode Yes Specify whether you want to use Active or Passive modeto connect to the FTP server.

ConnectionTimeout(msec)

Yes The timeout specified in this field (in milliseconds)applies to the following scenarios:

l Making the control socket connection to the FTPServer

l Making the data socket connection to the FTPserver (passive mode)

l Waiting for the data socket connection from theFTP server (active mode)

l Reading a reply from control socket after sending aFTP control command

l Reading data from the data sockets

The default value is 60000 milliseconds.

If the specified time is reached when attempting any ofthese operations, the activity using this FTP connectionterminates without error and takes any matching successtransitions to the next activity in the process.

Remote None A drop-down list of values for specifying the character




Description

FilenameEncoding

encoding of file names supplied to FTP commands usingthis connection.

The encoding specified in this field is used when sendingpath and file names supplied to FTP commands that usethis FTP Connection resource. Set this field when theFTP server has a different system encoding than themachine where the engine is running.

Firewall Yes Specifies whether the FTP host resides outside of afirewall. Selecting this check box enables the Proxy Host,Proxy Port, and Proxy User Name fields. If this checkbox is selected, you must supply the Proxy Host andProxy Port fields with the name and the port of theproxy server used to access sites outside of a firewall.

You can optionally specify the user name and passwordfor the proxy server, if required.

Proxy Host Yes Specifies the host name or IP address of the firewallserver. This is used when the remote FTP server is outsideof a firewall.

Proxy Port Yes Specifies the port number of the firewall server. This isused when the remote FTP server is outside of a firewall.

Proxy UserName

Yes Specifies the user name to use to connect to the proxyserver, if necessary. This is used when the remote FTPserver is outside of a firewall.

ProxyPassword

Yes Specifies the password to use for the specified user namewhen connecting to the proxy server, if necessary. This isused when the remote FTP server is outside of a firewall.



Test Connection

When you click the Test Connection button, the activity attempts to connect to thespecified remote FTP server on the specified port using the specified username andpassword. You can use this button to determine whether the specified connectionconfiguration is correct.

Available Commands

The Available Commands button displays a dialog box with details about which FTPcommands are available on the specified remote server. FTP servers on different operatingsystems and from different vendors support slightly different commands. Use this button todetermine the available commands on the remote FTP server before attempting to executethem with the FTP Quote activity.

Security

Select the Confidentiality check box to display the SSL Client field.

Field Description

SSLClient

The name of the resource.

In the SslClientResource Resource Template wizard, create a resource to connectto the SSL client.

HTTP ClientThe HTTP Client resource template represents an outgoing HTTP connection.

General




Field Description




HTTP Client



Description

Default Host Yes The name of the host that accepts the incomingrequests.

For machines that have only one network card, thedefault value localhost specifies the current machine.For machines with more than one network card, thisfield specifies the host name of the card used toaccept the incoming HTTP requests.

The default value is localhost.

Default Port Yes The port number on which to invoke outgoing HTTPrequests.


HTTP Version No The HTTP version to be used for communication. Bydefault, it is HTTP 1.1. If required, you can selectHTTP 2.0 as the version for the HTTP 2communication. It is mandatory for the server tosupport HTTP 2 as well if HTTP 2 is selected as theclient protocol. When HTTP 2 is selected as theversion, the option of the client in the




Description

Implementation Library field, changes to JettyHTTP Client, and other options do not appear, asonly the Jetty client supports HTTP 2. When HTTP1.1 is selected as the version, the previous optionsreappear along with the new option Jetty HTTPClient, which also supports HTTP 1 communication.

When HTTP 2.0 is selected as the HTTP version in theHTTP client shared resource, enabling SSL throughthe Confidentiality or Default Confidentiality optionis compulsory.

l If Confidentiality is enabled at the HTTP clientand HTTP 2 is the version used, it is necessaryto select Enable Mutual Authentication at thecorresponding SSL client resource andconfigure the identity store provider, key aliasname, and key password.

Note: HTTP 2 is currently supported only for theHTTP palette along with HTTP 1.1. The SOAP andREST bindings continue to use only HTTP 1.1 forcommunication.

ImplementationLibrary

No Specifies the implementation library to be used:

l Apache HttpComponents(Supported byHTTP 1, SOAP and REST): must be used forthe SOAP and REST Reference Binding, andInvoke REST API activity.

Attention: To enforce basic credentialmapping on REST or HTTP activities, you mustselect Apache HttpComponents(Supportedby HTTP and REST) library.

When HTTP 2 is selected as the protocol




Description

version in HTTP Connector resource, withFollow HTTP1 Compliance selected, and HTTPComponents client is used as theimplementation library in the HTTP Clientresource, the application fails due to lack ofcommon cipher suites. Hence this scenario ispresently not supported for HTTP 2 in TIBCOActiveMatrix BusinessWorks™ 6.x.

l Jetty HTTP Client: can be used for HTTPactivities (both HTTP 1.1 and HTTP 2). Thisclient library is currently not supported forREST and SOAP.

l Apache Commons(Deprecated): ApacheCommons library is now no longer used,because it is deprecated. Older importedprojects using Apache Commons, continue todisplay Apache Commons as the client option,but Apache Components is used as the clientfor executing the HTTP requests, because thislibrary is obsolete.

The default is Apache HttpComponents(Supported byHTTP 1, SOAP and REST), when HTTP 1.1 is selectedas the protocol version. When HTTP 2 is selected asthe protocol version, the Jetty HTTP Client is theonly Implementation option available, becausecurrently only the Jetty Client supports HTTP 2.




Description

Note:

l The Jetty HTTP Client implementation canonly be chosen for HTTP applications, andis not compatible with SOAP/RESTapplications.

l After Axis2 upgrade, Apache Commonsclient library is no longer used in HTTP. Theprojects migrated from ActiveMatrixBusinessWorks™ 5.x shall now show ApacheComponents as the client library instead ofApache Commons.

DisableConnectionPooling

Yes Indicates whether to use the single or multi-threadedconnection manager.

If you select this check box, Maximum TotalConnections, Idle Connection Timeout(ms),Maximum Total Connections Per Host/Route, andStale Check fields are disabled.

The default value is False.

This option is not enabled when the Jetty HTTPClient is selected as the implementation library,because connection pooling happens internally inthe Jetty Client library.

Maximum TotalConnections

Yes Specifies the maximum number of concurrent, activeHTTP connections allowed by the resource instanceto be opened with the target service. This property isenabled only if connection pooling is enabled (theDisable Connection Pooling parameter is deselected).


For applications that create many long-livedconnections, increase the value of this parameter.




Description

Idle ConnectionTimeout(ms)

Yes Keep-alive time (in milliseconds) for idle HTTPconnection in the Persistent Connection Pool.

Maximum TotalConnections PerHost/Route

Yes Specifies the maximum number of concurrent, activeHTTP connections allowed by the resource instanceto the same host or route. This property is enabledonly if connection pooling is enabled (the DisableConnection Pooling parameter is unchecked).

Note: This number cannot be greater thanMaximum Total Connections. Every connectioncreated here also counts into Maximum TotalConnections.


Stale Check Yes Selecting this check box determines whether thestale connection check is to be used. Disabling thestale connection check can result in slightperformance improvement at the risk of getting anI/O error, when executing a request over aconnection that has been closed at the server side.

Cookie Policy No Specifies the Cookie Policy to use:

Note: Ensure you have selected ApacheHttpComponents (Supported by HTTP andREST) as the Implementation Library whenselecting a Cookie Policy.

l BROWSER_COMPATIBILITY: Choose thisoption to select a cookie policy that iscompatible with the common cookiemanagement practices, including those thatare not fully standards compliant.




Description

l NETSCAPE: Select this option to use theNetscape cookie draft compliant policy. Whenyou select this option, Cookie2 headers are notsent in the request message.

l RFC_2109: Select this option to use theRFC2109 compliant policy. This policy issupported for HTTP palette activities.

Note: If this policy is selected for theInvoke API activity or the REST ReferenceBinding, the BEST_MATCH policy isselected instead.

l IGNORE_COOKIES: Select this option ifcookies sent by the server need be disabled.

l BEST_MATCH: This is the default selection.Select this option to choose the BEST_MATCHCookie Policy.

Disableconnection statetracking

Yes This check box is enabled only when ApacheHttpComponents (Supported by HTTP and REST)option is selected in the Implementation Libraryfield.

When this check box is selected, the HTTPSconnections are not reset by the Apache componentsclient, and a single HTTPS connection can be reused.


Caution: If you select this check box, there mightbe a security risk of leasing a persistent SSLconnection to the wrong user.




Description

This option is not enabled when the Jetty HTTPClient is selected as the implementation library.

Thread Pool No Specifies a queue of threads available to run a queueof tasks.

Thread pools are used to improve performance whenexecuting large numbers of asynchronous tasks byreducing per task invocation overhead, provide ameans of bounding, and managing the resourcesconsumed when executing a collection of tasks.

You can optionally create this client thread pool toroute messages to the target service. The threadpool resource can be created by either selecting athread pool resource template or creating a newone.

For more information, see the Thread Pool topic.

Advanced



Description

SocketTimeout (ms)

Yes Specifies the number of milliseconds to wait for data before theconnection is severed.

The value zero (0) is interpreted as an infinite timeout and isused when no socket timeout is set in the HTTP methodparameters.




Description

ConnectionTimeout (ms)

Yes Specifies the number of milliseconds to wait while a connectionis being established.

The value zero (0) is interpreted as no timeout.

AcceptRedirect

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 forconnecting to the server if an exception occurs.

When the client library implementation is set to ApacheComponents, the retry count at HTTP client shared resource isaccessed internally by the Apache Components Client to createa DefaultHttpRequestRetryHandler(https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/impl/client/DefaultHttpRequestRetryHandler.html), which retries to send the failedrequests number of times specified in the Retry Count field.

Interrupted IO Exception, Unknown Host Exception, ConnectException, and SSL Exception are the types of exceptions forwhich the requests cannot be retried. The requests are retriedfor all other exceptions, only if the request has not beensuccessfully sent. The default value of retry count is 3.

Use SingleCookieHeader

Yes Select this check box if multiple name/value pairs must be sentin a single non-repeating Cookie header element for outgoingHTTP requests.





Description

Use Non-PreemptiveAuthentication

Yes Select this check box if you want to use non-preemptiveauthentication.

LogRequest/Response Time

Yes Select this check box to log the time required for sending andreceiving the HTTP response in the Send HTTP Requestactivity.

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.

For more information, see the Proxy Configuration.

Security

Security can include any combination of the following characteristics:


Description

Authentication None To be included when the messages must beauthenticated. Authentication can be performed withuser names and passwords.

Identity Provider : Provides user name and passwordcredentials encapsulated in an identity providerresource. Selecting this check box activates theIdentity Provider field.




Description

Note: You can enforce authentication on requestsby selecting the Authentication check box, or byassociating the Basic Credential Mapping policywith REST or HTTP activities. If you choose to usethe policy, ensure the Authentication check boxon the HTTP Client resource is not selected.

OauthConfiguration

None Selecting this check box enables the OAuthconfiguration.

OAuth configuration requires additionalconfigurations. For more information about OAuthconfiguration, see OAuth Configuration Resource.

KerberosAuthentication

None Selecting this check box enables KerberosAuthentication.

Kerberos Authentication requires a few additionalconfigurations. For more information aboutconfigurations, see the section "KerberosAuthentication Configuration".

To enforce Kerberos authentication on REST binding,you must select Apache HttpComponents(Supported by HTTP and REST) library.

Note: Kerberos authentication is not supported onInvoke REST API. Use REST Reference Binding orHTTP to invoke a kerberized service.

Username None Enter the Active Directory user name to be used forthe Kerberos authentication.

This field is enabled only when the KerberosAuthentication field is selected.




Description

Password None Enter the password for the specified user name.

This field is enabled only when the KerberosAuthentication field is selected. This field ismandatory.

DefaultConfidentiality

Yes Select the check box to encrypt or decrypt messages.

Select the check box to enable the SSL with defaultconfiguration.

For more information about SSL Client configuration,see the SSL Client Configuration.

Note: If you select Default Confidentiality, there isno need to create a shared resource. SSL isenabled with Default Configuration. If customconfigurations for SSL are required, selectConfidentiality. When using DefaultConfidentiality ensure that the correct rootcertificates are present at the <TIBCO_HOME>\tibcojre64\1.8.0\lib\security\cacerts trust store.

Confidentiality Yes Select the check box when encrypting or decryptingmessages.

When you select a module property for this field andset it to true, or select the check box, the SSL ClientConfiguration field is visible.

For more information about SSL Client configuration,see the SSL Client Configuration.

JWTAuthentication

No Select the check box to use the JSON Web Token(JWT) authentication when exposing a RESTReference.

Select the check box to enable the JWT Token field.




Description

For more information about JWT, see JWT.io


JWT Token Yes Provide a JWT value.

Kerberos Authentication Configuration

The krb5.conf and login.conf files are present under the config folder at the location, BWHome/config. We recommend that the configurations in the login.conf file should not bechanged. However, values in the krb5.conf file can be changed according to the Kerberosenvironment you are working in.

You can configure the following values in the krb5.conf file:

l libdefaults

l realms

l domain_realm

Persistent ConnectionsPersistent connections maintain a pool of connections that can be reused by the SendHTTP Request activity to avoid opening and closing the connection. Persistent ConnectionManager is created by the HTTP Client shared resource. Hence, each HTTP Client sharedresource has its own persistent connection pool.

A Send HTTP Request activity requires a connection to the HTTP server. The activityexclusively uses the connection until the HTTP server sends the response message. If youhave many process instances connecting to a HTTP server, each Send HTTP Requestactivity opens a connection, holds the connection until the activity completes, and thencloses the connection. Opening and closing a large number of connections causes asignificant overhead. Persistent connections play a significant role in such scenarios.

https://jwt.io/introduction/



Note: Not all HTTP servers support the use of persistent connections. Todetermine whether the HTTP server supports the use of persistent connections,read the documentation of that HTTP server.

Using persistent connection manager, you can specify the total number of connections andthe maximum number of connections per HTTP server. The total number of connectionssignify the aggregate connections to all HTTP servers handled by that connection pool.

HTTP ConnectorHTTP Connector resource describes the characteristics of the connection used to receiveincoming HTTP requests. This resource is used when the process requires an HTTP requeston a specific port where the HTTP server is running. For example, the process starter HTTPReceiver and the signal-in Wait for HTTP Request activity receiving HTTP requests.

There can be only one process with an HTTP Receiver or Wait for HTTP Request activitythat uses the same HTTP Connection resource. With this restriction the HTTP serverlistening for the incoming requests dispatches the request to the correct process.

General



Description

Package No The name of the package in which you want to create ashared resource.

Name No The name of the shared resource.

Description No A short description of the shared resource.

Basic Configuration

The Basic Configuration section has the following fields.




Description

Host Yes Note: Do not change the value for this property. Bydefault, it is set to the BW.HOST.NAME moduleproperty.

Specifies the name of the host that accepts the incomingrequests. For machines that have only one network card,the default value localhost specifies the current machine.For machines that have more than one network card, thisfield specifies the host name of the card that is used toaccept incoming HTTP requests.

If there is more than one network card on the machine,and you specify localhost in this field, all network cardson the machine listen for incoming HTTP requests on thespecified port.

When using local host for the system property, use the fullname of your machine as the host in the client.

Note: You can start more than one HTTP server on asingle port by using Context and Path fields on HTTPReceiver and Wait for HTTP activities. Ensure that youuse a different port, if different Context or Path arenot specified.

Port Yes Specifies the port number on which to listen for incomingHTTP requests.

Note: Do not use port 7777. It is reserved for aninternal use.

HTTP Version No The HTTP version to be used for communication. Bydefault, it is HTTP 1.1. If required, you can select HTTP 2.0as the version for the HTTP 2 communication. It ismandatory for the communicating client to support HTTP2 as well if HTTP 2 is selected as the server protocol. Ifmultiple clients are used, which may or may not support




Description

HTTP 2, it is recommended to select the Follow HTTP1Compliance check box, subject to the condition that theclients have the ability to negotiate the HTTP version withthe server. Currently, among the TIBCO Cloud IntegrationHTTP clients, only the Jetty client supports HTTP 2communication.

When HTTP 2.0 is selected as the HTTP version in theHTTP connector shared resource, enabling SSL throughthe Confidentiality or Default Confidentiality option iscompulsory.

l If Confidentiality is enabled at the HTTP connectorand HTTP 2 is the version used, it is necessary toselect Enable Mutual Authentication at thecorresponding SSL server resource and configurethe keystore provider.

Note: Both HTTP 2 and HTTP 1.1 are currentlysupported only for the HTTP palette. The SOAP andREST bindings continue to use only HTTP 1 forcommunication.

Follow HTTP1Compliance

Yes This option is enabled only when the HTTP 2.0 is selectedas the HTTP version. This option, if selected enablesnegotiation between the server and client to decide theHTTP version to be used. HTTP 1.1 and HTTP 2.0 are thesupported versions. If the client does not have the abilityto negotiate the protocol, selecting this check box causesthe server to fall back to the default HTTP 1implementation. Hence this check box should be selectedonly if the HTTP 2 client can negotiate the protocol withthe server. Currently, no client used in ActiveMatrixBusinessWorks 6.x can negotiate the protocol version.Hence it is recommended not to enable this option, ifHTTP 2 communication is required. Currently, HTTPcommunication with this option works only when the




Description

Jetty HTTP Client is selected as the client library, forActiveMatrix BusinessWorks applications.

Accept Queue Size Yes Specifies the number of connection requests to bequeued before the operating system starts sendingrejections. The default values are: -1 and 0.

These default values signify that the queue size is 50 orOS-specific.

Acceptor Threads Yes These are the Jetty server threads. Acceptor threads areHTTP socket threads for an HTTP Connector resourcethat accept the incoming HTTP requests.

The value should be compulsorily set between 1 and (thenumber of processors in the runtime + 3)/4.

This shall ensure optimal performance during requestprocessing using Non Blocking IO. The Jetty 9 library usedfor the HTTP Connector, uses Non-Blocking IO as the onlymeans of IO.


For more information about Acceptor Threads, see JettyDocumentation.

Hide ServerImplementation

Yes Select the check box to hide additional details of a serverimplemented in the HTTP response, and log files in caseof errors.


Advanced Configuration

The Advanced Configuration section has the following fields.

https://www.eclipse.org/jetty/documentation.php

https://www.eclipse.org/jetty/documentation.php




Description

Header BufferSize (B)

Yes Specify to set the size of the buffer for request headers. Anidle connection at most has one buffer of this size allocated.The default value is 4K.

Note: Increase the default value while sending HTTPrequests with large header values and using Jetty HTTPClient library, set the new property"com.tibco.bw.http.jettyclient.requestBufferSize" with theproper request size.

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 theheader buffer. The default value is 8K.

Use DirectBuffers

Yes Specify to determine whether direct byte buffers are used ornot. The default value is True.

Response BufferSize (B)

Yes Specify to set the size of the content buffer for sendingresponses. These buffers are used only for activeconnections that are sending responses with bodies that donot fit within the header buffer. The default value is 24K.

URI Encoding Yes Specifies the character encoding used to decode the URIbytes.

If you do not set any value for uriEncoding, the default UTF-8 is used.

Max Idle Time(ms)

Yes Specify to set the maximum idle time for a connection. TheMax Idle Time is applied in the following cases:

l When waiting for a new request to be received on aconnection; when reading the headers and content ofa request

l When writing the headers and content of a response




Description

Jetty interprets this value as the maximum time betweenthe progress 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 isresolved to a DNS name. This can adversely affect thethroughput. This check box is not selected as default. Selectthis check box only when required.


Low ResourceMax Idle Time(ms)

Yes Specifies to set the period in ms for the connection to beidle.

This results in the server rapidly closing idle connections togracefully handle high load situations.

Compression Yes Specifies if the output of the HTTP Connection iscompressed using the HTTP/1.1 GZIP compression.

The acceptable values for this field are: True or False


Linger Time(ms)

Yes Specifies 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 separatedlist istext/html, text/xml, text/plain.

SessionTimeout (s)

Yes The timeout (in seconds) for the HTTP session to expire afterinactivity.

Max Post Size Yes Specifies the maximum size in bytes of the POST that thecontainer FORM URL parameter parsing can handle.




Description

By default, the value of this field is set to 2MB or 2097152bytes. Setting the value less than or equal to zero disablesthe limit for maxPostSize.

Reverse ProxyHost

Yes Specifies the name of the reverse proxy host that acceptsthe incoming requests.

Max Save PostSize

Yes Specifies the maximum size in bytes of the POST that thecontainer can save/buffer during FORM or CLIENT-CERTauthentication.

l FORM authentication: the request message is savedwhile the user is redirected to the login page. It isretained until the user authentication succeeds or thesession associated with the authentication requestexpires.

l CLIENT-CERT authentication: the request message isbuffered for the entire duration of the SSL handshake.After processing the request, the buffer is emptied.

However, in both the cases the buffering happens before theuser authentication. By default, the value of this field is setto 4Kb or 4096 bytes. Setting the value to -1 disables thelimit for this field.

Reverse ProxyPort

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 fromthe acceptor 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.





Description

Maximum QTPThreads

Yes This field specifies the maximum number of threadsavailable for the incoming HTTP requests. The HTTP serverdoes not create more than the number of threads specifiedby this parameter.


This limit is useful for determining number of incomingrequests that can be processed at a time. Setting a highnumber creates that many threads and drastically reducethe performance.

Enable AccessLogs

Yes Select the Enable Access Logs check box to print the HTTPaccess logs.

Disable HTTPMethods

Yes Disable specific HTTP methods by adding the requiredmethods to the field list.

To add a method to the list, click the Add icon . Toremove a method from the list, select the required method

and click the delete icon .

Note: The first time you click the Add icon , bydefault the TRACE method is selected and added to thelist of methods to be disabled.

Share AcrossApplications

Yes Select the Share Across Applications check box to sharethe same HTTP Connector shared resource across severalapplication modules.

Note: This check box is applicable if the HTTP Connectorshared resource is present in the shared module, and thecheck box is not be applicable if the HTTP Connectorshared resource is present in the application module.



Security

Security can include any combination of the following characteristics:


Description

Confidentiality Yes To be included when encrypting or decrypting themessages.

Selecting this check box displays the SSL ServerConfiguration field.

Older security protocols TLS v1.0, v1.1 and SSL v3 arenot supported, in order to prevent securityvulnerabilities.

JWTAuthentication

No Enable this to use JSON Web Token (JWT)authentication when exposing a BusinessWorks RESTService.

JWT is an open standard that defines a compact andself-contained way for securely transmitting informationbetween parties as a JSON object. This information canbe verified and trusted because it is digitally signed.JWTs can be signed using a secret (with the HMACalgorithm).Selecting this check box enables the following fields:

l JWT Algorithm: Use the drop-down list to specifyan HMAC algorithm (HS256, HS384 or HS512.)

l Secret Key: When HMAC is used, a shared secret(password) is required to encrypt the JWT token.Enter the password in the Secret Key field.



Note: Note: Imported projects display the Authentication check box under theSecurity section if the check box was selected in a previous version ActiveMatrixBusinessWorks™ 6.x. Authentication remains enabled on the HTTP Connectorresource if you do not clear the check box. If you clear the Authentication checkbox, a warning message is displayed prompting you to confirm your action. Toremove authentication from the resource, click OK.

Once you have removed authentication from the resource, you can reapply itusing the Basic Authentication policy.

For more information, see Enforcing Basic Authentication in TIBCO ActiveMatrixBusinessWorks™Application Development .

Note: When Jetty debug logs are enabled, intermittent ClosedChannelExceptionerror messages occur in the logs. These messages are to be ignored, since this isan expected behavior due to internal implementation of the Jetty server. Thesemessages are not an indication of any errors.

Identity ProviderIdentity Provider shared resource provides user name and password credentials.

General


Field Description






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 whenspecifying activities from the JDBC palette.

General


Field Description



Description A short description of the shared resource

JDBC Connection





Description

ConnectionType

None Specifies the kind of JDBC connection you want tocreate.

MaximumConnections

Yes The maximum number of database connections toallocate. The default maximum is 10. The minimumvalue that can be specified is 1.

LoginCredentials

Yes The user name used to connect to the database.

The password used to connect to the database.

JDBC Driver



Description

DatabaseDriver

Yes The name of the JDBC driver class. If you select asupported driver from a list of supported drivers, theDatabase URL field is populated with a template for theURL of the driver.

The following drivers are packaged:

l PostgreSQL

l Microsoft SQL Server

In addition, the JDBC palette also supports the MySQL,Oracle, and DB2, and MariaDB database.




Description

Note: The TIBCO Business Studio for BusinessWorksproduct can connect with MariaDB ® or MySQL throughuse of MariaDB® Connector/J, which is subject to freeand open source software license terms and availableat https://mariadb.com/downloads/mariadb-tx/connector. MariaDB Connector/J is not part of theproduct and therefore not within the scope of yourlicense for the TIBCO Business Studio forBusinessWorks product. Accordingly, MariaDBConnector /J is not covered by the terms of youragreement with TIBCO, including any termsconcerning support, maintenance, or warranties.Download and use of MariaDB Connector/J is solely atyour own discretion and subject to the free and opensource license terms applicable to MariaDBConnector/J.

When editing this field, you can also specify for the JDBCPalette to use a custom JDBC driver. For instructions onhow to do this, see Using Custom Drivers.

Note: Custom drivers must be compliant with theJDBC 4.0 API Specification.

Database URL Yes The URL to use to connect to the database. A template ofthe URL is supplied for the selected JDBC driver. Youmust supply the portions of the URL that are in anglebrackets (<>).

LoginTimeout(secs)

Yes The length of time (in seconds) to wait for a successfuldatabase connection.

Only JDBC drivers that support connection timeouts canuse this field. If the JDBC driver does not supportconnection timeouts, the value of this field is ignored.Most JDBC drivers support connection timeouts.

https://mariadb.com/downloads/mariadb-tx/connector

https://mariadb.com/downloads/mariadb-tx/connector




Description

ConnectionIdle Timeout

Yes This option monitors the given time. When the timelapses, it cleanly closes the connection awaiting insidethe pool of connections.

You can provide time in any of the following units:

l Seconds

l Minutes

l Hours

When you choose Minutes option and then select theHours option, the value is rounded up to the nearestwhole number. That is, 300 seconds are converted to 5minutes or 1 hour.

When you choose Hours and then select Minutes option,the rounding takes place at the most convenient wholenumber. That is, 1 hour becomes 60 minutes or 3600seconds.

The default value is 300 seconds.

Note: If you enter a value less than or equals to Zero(0), the monitoring does not take place. The pool doesnot close any physical connection.

Test Connection

Click the Test Connection button to test whether the specified configuration fields resultin a valid connection to a database.

Installing Supported Drivers for Run Time

If you want to use other databases, other than PostgreSQL or Microsoft SQL Server, youmust add them separately. This is a one-time process for every installation of ActiveMatrixBusinessWorks. Open the README.txt in the respective database shells at BW_HOME/config/drivers/shells/ for details on what JAR files to download, and where to add them.



To add the drivers at run time for Oracle, MySQL, DB2, or MariaDB, run the bwinstallcommand from BW_HOME/6.x/bin. Ensure that you run bwinstall with no arguments to accessthe help and instructions to add the driver to the run time.

The script creates driver bundles and adds it to that specific TIBCO® Cloud Integrationenvironment. Any AppNodes that are created and started in that TIBCO Cloud Integrationenvironment include the drivers automatically.

Since the drivers are part of the system and not part of each application, all theapplications on a particular AppNode use the same drivers. However, this is not true forAppSpaces. The drivers belong to an AppNode and not an AppSpace.

Supported Drivers

The following database drivers are supported:

l org.hsqldb.jdbc.JDBCDriver

l com.mysql.jdbc.Driver

l org.postgresql.Driver

l oracle.jdbc.OracleDriver

l com.microsoft.sqlserver.jdbc.SQLServerDriver

l com.ibm.db2.jcc.DB2Driver

l org.mariadb.jdbc.Driver

Note: To connect to MySQL Server you can select the MariaDB nativedriver (org.mariadb.jdbc.Driver) from the Database Driver drop downmenu.

The following Data Direct Drivers are supported:

l tibcosoftwareinc.jdbc.postgresql.PostgreSQLDriver

l tibcosoftwareinc.jdbc.mysql.MySQLDriver

l tibcosoftwareinc.jdbc.sqlserver.SQLServerDriver

l tibcosoftwareinc.jdbc.db2.DB2Driver

l tibcosoftwareinc.jdbc.oracle.OracleDriver



Using Custom Drivers

Installing custom drivers comprises of three parts:

1. Enabling the JDBC palette to use custom drivers.

2. Configuring the JDBC Connection Shared Resource to use a custom driver.

3. Setting up drivers for run time.

Enabling Custom Drivers

In TIBCO Business Studio for BusinessWorks, you can enable the JDBC palette to usecustom drivers. Before you do this, ensure that you place the drivers at the <BW_Home>/config/design/thirdparty location.

1. Click Click Here to Set Preferences. Optionally, go to Windows > Preferences >BusinessWorks > Palettes > JDBC.

2. Select the Allow use of custom driver check box and click Apply.

3. Click OK and restart TIBCO Business Studio for BusinessWorks for this configurationto take effect.

Configuring JDBC Connection to Use Custom Driver

Follow these steps to configure the JDBC Connection Shared Resource to use a customdriver:

1. Open the JDBC Connection Shared Resource from the Project Explorer.

2. Click in the Database Driver field, and select the custom.jdbc.driver option from

#SECTION_26BF2E0B43B746A9AC6EFAFAFAB6E32C

#SECTION_377AFC1C203C4AC894F0ECABE53399D3

#SECTION_65E0498C35F84EA0AB983D8445E038FA



the drop-down menu.

3. Edit the following fields that display under the Login Timeout (sec) field:

l Database Driver: Type the name of the driver class to use.

l Database Name: Type the name of the database to connect to. If the databasename is the name of a schema, type the schema to connect to.

l Jar File: Type the name of the Jar archive file stored at BW_HOME/config/design/thirdparty. This file to create the driver. If you are addingmultiple Jar files, separate the file names with commas.

Note: To ensure that TIBCO Business Studio for BusinessWorkscreates a driver bundle for the application at run time, confirm thatthe Jar archive file is stored under the third party folder at <BW_Home>/config/design/thirdparty.

4. Click Test Connection. If you have entered the correct database connection details,and have already created a plugin project to support the custom driver, TIBCOBusiness Studio for BusinessWorks confirms that you have successfully connected tothe database.

Note: If you are unable to connect to the database you specified, checkthe configurations you made to the JDBC Connection Shared Resource.The database connection field can also fail if you have not created a plug-in project to support the custom driver at run time. In this case, TIBCOBusiness Studio for BusinessWorks displays a warning message indicatingthat it does not recognize the custom driver you selected. Click OK andcomplete step 5.

5. Optional. Follow these steps:

a. In the Create New Plug-in Project wizard that displays, enter a name in theProject name field, accept the default selections, and click Next.

b. In the Content pane, accept the default values, and click Next.

c. In the Custom Driver Properties pane, edit the following fields:



Tip: Tip: Refer to your JDBC driver documentation for additionaldetails.

l Datasource Class: Type the name of the class that TIBCO CloudIntegration should use to establish a connection data source between theJDBC Connection Shared Resource and the database.

l Pooled Datasource Class: Type the name of the class that TIBCO CloudIntegration should use to create a pooled connection data source datasource between the JDBC Connection Shared Resource and thedatabase.

d. Click Finish, and the newly created plug-in project displays on the ProjectExplorer pane. Click the custom plug-in project to expand it.

e. Click the src folder to display the java file, and double-click the java file to editit. Locate the following instructions in the Java file, and follow them to importpackages that contain the datasource and pooldatacourse classes:

/****************************** TODO************************************* Import the packages from jar that contain the data source and drivers ** by hovering over the data source class name with your mouse and ** select the import option **************************************************************************/

f. Edit the methods and properties provided in the template file, or add yourown.

Note: Methods with the @Override annotation can be modified.Whether you edit @Override methods, do not remove them from thetemplate file.

Setting up Custom Drivers for Run TimeFollow these steps to set up custom drivers for run time:

1. Export the custom driver JAR file by right-clicking on the Plugin-Project from theProject Pane and clicking Export > Plug-in Development > Deployable plug-insand fragments.



2. In the Export wizard, complete the following steps:

a. Select a plug-in project.

b. On the Destination tab, and specify <BW_HOME>/system/shared as the targetdirectory to export the runtime bundle.

3. Click Finish to export the plug-in project as a JAR file. The JAR file is exported to theplugins folder at <BW_HOME>/system/shared/plugins.

Note: The plugins folder is automatically generated after you export theJAR file, but you can delete this folder after moving the JAR file to theshared folder at <BW_HOME>/system/shared.

Uninstalling Drivers for Run Time

To uninstall the drivers at run time for Oracle, MySQL, DB2, and MariaDB, run the bwuninstallcommand from <BW_Home>/6.x/bin. Ensure that you run bwuninstall with no arguments toaccess the help and instructions to uninstall the driver at run time.

Azure Authentication

Azure Authentication helps to connect the SQL Server database with the JDBC sharedresource. Azure authentication comprises of the following parts:

1. Enabling the JDBC palette to use Azure Authentication

2. Configuring the JDBC Connection Shared Resource to use Azure Authentication

3. Setting up Azure Authentication for Run Time

Enabling the JDBC palette to use Azure Authentication

In TIBCO Business Studio for BusinessWorks, you can enable the JDBC palette to use azureauthentication. Before you do this, create a new folder Azurelib in TIBCO_HOME/bwce/version/config/design/thirdparty and ensure that you place all the required jars toconnect to azure in this folder.

1. Navigate to Windows > Preferences > BusinessWorks > Palettes > JDBC.

2. Select the Enable Azure AD Password Authentication - (Required Jars must beprovided) check box and click Apply.



3. Click OK and restart TIBCO Business Studio for BusinessWorks for this configurationto take effect.

Configuring the JDBC Connection Shared Resource to use AzureAuthentication

Follow these steps to configure the JDBC Connection Shared Resource to use azureauthentication:

1. Open the JDBC Connection Shared Resource from the Project Explorer.

2. On the JDBC Driver tab, click on the Database Driver field, and select thecom.microsoft.sqlserver.jdbc.SQLServerDriver option from the drop-down menu.

3. On the Database URL field, add the URL to connect to the database.

4. Edit the fields that display under the Login Timeout (sec) field.

5. Click Test Connection. If you have entered the correct database connection details,TIBCO Business Studio for BusinessWorks confirms that you have successfullyconnected to the database.

Note: If you are unable to connect to the database you specified, checkthe configurations you made to the JDBC Connection Shared Resource.

Setting up Azure Authentication for Run Time

Follow these steps to set up azure authentication for run time:

1. Stop all the applications, appnodes, and bwagents.

2. Backup the com.tibco.bw.tpcl.jdbc.datasourcefactory.sqlserver_4.0.XXX folder from <BWCE_HOME>\2.5\system\shared to tmp directory

3. Add the required jar in the lib folder in com.tibco.bw.tpcl.jdbc.datasourcefactory.sqlserver_4.0.XXX.

4. In the META-INF folder locate the MANIFEST.MF file and modify the Bundle-ClassPathin this file, and append the jar names added in step 3.

5. Copy the modified com.tibco.bw.tpcl.jdbc.datasourcefactory.sqlserver_4.0.XXX folder in<BWCE_HOME>\2.5\system\shared.



JMS ConnectionJMS Connection resource describes a JMS connection. This resource is used to specifyactivities on the JMS palette.

General


Field Description




Basic Configuration



Description

ConnectionFactory Type

No A connection factory is the object used by a client tocreate a connection to a provider. Select from one ofthe following available options:

l JNDI: select to look up the connection factoryobject. Selecting this option displays the QueueConnection Factory and Topic ConnectionFactory fields, when the Messaging Styleselected is Queue/Topic.

l Direct: select if you want to connect to the JMSserver using a URL. Selecting this option displaysthe Provider URL field. Ensure to select the




Description

Queue/Topic in the Message Style.

Messaging Style None The available messaging style options are:

l Generic

l Queue/Topic

You can combine these styles in a single application orthe application can use any one of these messagingstyles.

QueueConnectionFactory

Yes This field is available when you select JNDI in theConnection Factory Type field and Queue/Topic inthe Message Style field.

The QueueConnectionFactory object stored in JNDI isused to create a queue connection with a JMSapplication.

For more information about creating and storingQueueConnectionFactory objects, see the JNDI providerdocumentation.

TopicConnectionFactory

Yes This field is available only when you select JNDI in theConnection Factory Type field and Queue/Topic inthe Message Style field.

The TopicConnectionFactory object stored in JNDI. Thisobject is used to create a topic connection with a JMSapplication.

For more information about creating and storingTopicConnectionFactory objects, see the JNDI providerdocumentation.

ConnectionFactory JNDIName

Yes This field is available only when you select the JNDI inthe Connection Factory Type field and Generic in theMessage Style field.




Description

The GenericConnectionFactory object stored in JNDI isto create connection with JMS server.

JNDIConfiguration

No A JNDI Configuration shared configuration object thatspecifies the JNDI connection information. For moreinformation, see JNDI Configuration.

Note: The New button is used to create a new JNDIConfiguration Shared Resource using thepreferences set by the user.

Provider URL Yes This field is available only when you select Direct inthe Connection Factory Type field.

The URL to the JNDI service provider, forexample,tcp://<host>:<port>.

Use UFOConnectionFactory

Yes Use this check box when using EMS Unshared StateFailover factories.

This field appears only when the option Direct isselected in the Connection Factory field.

When using Unshared failover setup, if a connectionloss is detected to server (A), TIBCO ActiveMatrixBusinessWorks™TIBCO ActiveMatrix BusinessWorks™tries to connect to server (B) as defined in theconnection factory configuration.

After enabling this check box you can pass the providerURL in the form of UFO. For example:tcp://serverA:7222+tcp://serverB:7222, where serverA andserverB are two EMS servers configured for theUnshared State Failover.

Unsupported Features and Activities

l JMS Palette




Description

o JMS Queue Requestor

o JMS Topic Requestor

o Any other Requestor activity

l SOAP Palette

o All Activities

l Service Palette

o All activities

l AE Adaptor

o All activities

Looking up factories using JNDI is not supported

l UFO factories cannot be retrieved through JNDIdirectly.

For more information about Unshared State Failover,see TIBCO Enterprise Message Service User's Guide.

Test Connection

Click the Test Connection button to test the connection specified in the configuration ofthis resource.

Using Third Party JMS Drivers

The JMS palette supports the EMS, IBM MQ, TIBCO Custom JMS, and JBoss JMS drivers.

Adding Drivers for Runtime

If you want to use other JMS servers, other than the JMS servers mentioned in thesection,Using Third Party JMS you must add them separately, for run time. This is a onetime process for every installation of TIBCO Business Studio for BusinessWorks. To add theJMS drivers at run time for IBM MQ, or JBoss run the bwinstall command from <BW_Home>/6.x/bin. Ensure that you run bwinstall with no arguments to access the help andinstructions to add the driver to the run time.



The script creates driver bundles and adds it to the specific ActiveMatrix BusinessWorksenvironment. Any AppNodes that are created and started in that ActiveMatrixBusinessWorks environment includes the drivers automatically. Since the drivers are a partof the system and not part of each application, all the applications on a particularAppNode use the same drivers.

However, this is not true of App Spaces. The drivers belong to an AppNode and not anAppSpace.

To use another location for the drivers, a preference is provided in TIBCO Business Studiofor BusinessWorks which can be updated for the JMS palette to use drivers at design time.

To change the Directory Preference in TIBCO Business Studio for BusinessWorks, navigateto Windows > Preferences > BusinessWorks > Palettes > JMS

If you have changed the preferences and want to use other databases with the JMS paletteat design time, place the drivers at <BW_Home>/6.x/config/design/thirdparty location.

Field Description

One click JNDIResourcename

The name of JNDI Connection shared resource which is auto created whenyou click the New button. This is used only if the shared resource uses JNDIand not Direct.

Default JNDINaming URL

The default URL to be added in the JNDI Connection shared resource whena new resource is created.



Field Description

GenericConnectionFactory Name

The value to be added in the Generic Connection Factory field when a newJMS Connection Shared Resource is created.

QueueConnectionFactory Name

The value to be added in the Queue Connection Factory field when a newJMS Connection shared resource is created.

TopicConnectionFactory Name

The value to be added in the Topic Connection Factory field when a newJMS Connection shared resource is created.

DirectoryPreferences

Click the Browse button and navigate to the location where the driverlibraries are stored.

Note: While testing the JMS connection for JMS drivers other than EMS, ensurethat only the jars related to the selected third party JMS driver are present in thelocation specified in the directory preference.

Security

Security section has the following field.


Description

LoginCredentials

Yes The login credentials to log on to the JMS server. Clickthe Username+Password radio button, if you want to usethis option for a secure login. This displays the Usernameand Password fields.



Advance Configuration



Description

Auto-generateClient-ID

No Select this check box if you want to automatically generatethe client ID if no client ID is specified or if the specified IDis already in use.

When this check box is selected, a value cannot be specifiedfor the clientID.

When an automatically generated client ID is required, thefollowing format is used for the client ID:

BW-<projectName>-<topic or queue>-<engineName>-<timestamp>

Do not select this check box if you do not want to use thevalue specified in the Client ID field. If no value is specifiedin the Client ID field, no client ID is set. If the valuespecified in the Client ID field is already in use, it throws anexception.

Note: Selecting the Auto-generate Client-ID check boxgenerates a new Client ID every time a connection ismade to the JMS Server. If you are using DurableSubscribers, manually set the client ID for the JMSConnection.

Client ID Yes The client ID for the connection. The JMS providers have aprovider-specific format for client IDs.

For more information about client IDs, see the JMSprovider’s documentation.

Each connection must use a unique client ID. If you do notspecify a value in this field, ActiveMatrixBusinessWorksTIBCO ActiveMatrix BusinessWorks™ ensuresthe uniqueness of the client ID for each connection.



SSL

Select the Confidentiality check box to configure the SSL connection parameters.


Description

SSL Client None Specify an SSL Client Shared Resource. For moreinformation about how to configure the Shared Resource,see SSL Client.

ConnectionFactory SSLPassword

Yes This field is only available if you select theConfidentiality check box.

The SSL configuration is specified in theConnectionFactory object, except for the client SSLpassword. You can specify your client SSL password inthis field, or you can leave this field empty. If yourpassword is not specified, the private key password isused.

Uninstalling Drivers for Run Time

To uninstall the drivers at run time for IBM MQ or JBOSS, run the bwuninstall command from<BW_Home>/1.0/bin. Ensure that you run bwuninstall with no arguments to access the helpand instructions to uninstall the driver at run time.

JNDI ConfigurationJNDI Configuration shared resource provides a way to configure the JNDI configurationthat can be shared with other activities. This resource can be specified in any resource thatpermits JNDI connections. For example, JDBC Connection and JMS Connection can useJNDI connections.

General




Field Description




JNDI Connection



Description

JNDIProvider

No The name of the JNDI connection. Select any one of theJNDI provider from the following options:

l JBoss

l TIBCO EMS

l TIBCO Custom JMS

l IBM WebSphere MQ

InitialContextFactory

Yes The initial context factory class for accessing JNDI.(com.tibco.tibjms.naming.TibjmsInitialContextFactory).

NamingProvidingURL

Yes The name of the JNDI provider URL. For example,tibjmsnaming://localhost:7222.

JNDI Property Configuration

This section contains optional properties to pass to the JNDI server. Use the + and X keysto add and delete properties in the list.



Field Literal Value/Module Property Description

Name No The name of the custom JNDI property.

Type No The datatype for the custom JNDI property.

Value Yes The value for the custom JNDI property.

Note: See the documentation for your JNDI provider for more information aboutproperties that can be passed to the JNDI server.

Security

This section has the following field.

Field Description

LoginCredentials

The login details to access the JNDI connection. Select any one of thefollowing options.

l None: Selecting this radio button does not display theUsername+Password option.

l Username+Password: Valid username and password to access theJNDI connection.

Using TIBCO Custom JMS JNDI ProviderInstalling custom drivers comprises of two parts:

1. Enabling the JMS palette to use Custom Drivers

2. Configuring the JNDI configuration shared resource



Enabling custom librariesIn TIBCO Business Studio for BusinessWorks, you can enable the JMS palette to use customdrivers.

Before you beginEnsure that you place the drivers at the <BW_Home>/config/design/thirdparty location.

Procedure1. Click the link Click Here to Set Preferences. Optionally, go to Windows >

Preferences > BusinessWorks > Palettes > JMS.

2. Select required directory preference and click Apply.

3. Click OK and restart TIBCO Business Studio for BusinessWorks for the configurationto take effect.

Configuring and Setting up Custom Drivers forRuntimeFollow these steps to configure the JNDI Configuration shared resource to use a customdriver:

Procedure1. Open the JNDI Configuration shared resource from the Project Explorer.

2. Select the TIBCO Custom JMS option from the drop-down list in JNDI Provider field.

3. Provide Initial Context Factory and Naming Provider URL values.

Note: Multiple initial context factories are supported.

4. Click Test Connection to display Custom JMS Provider Runtime Support wizard.

5. Click Yes to create a new Plug-in project. Specify desired project name and clickNext.

6. In the Content pane, accept the default values, and click Next.



7. Click Finish

The newly created plug-in project displays on the Project Explorer pane.

Adding Multiple Initial Context FactoriesYou can add multiple initial context factories in the newly created plug-in project.

Before you beginNewly created plug-in project is displayed on the Project Explorer pane.

Procedure1. Double-click on the Activator.java file from the src folder of the plug-in project.

Activator.java file is opened. By default, there are getProvider() and getProviders() methodsare present in the Activator.java file.

2. Uncomment the getProviders() method.

3. Create another copy of the CustomJMSProvider.java file from the src folder in the samefolder. You can rename the copy file.

4. Double-click the newly copied file.

Newly created Java file is opened.

5. In the getInitialContextFactory() method, remove the existing context factory and add thename of initial context factory that is to be supported.

6. Open the Activator.java file and create an object of newly created class.

7. Add the object to the AbstractJMSProvider array.

8. Expand the OSGI-INF directory to see CustomJMSProvider.xml file.

9. Create copy of the CustomJMSProvider.xml file with the same name as given to thenewly created copy of the CustomJMSProvider.java file.

10. Double-click the newly created copy of the CustomJMSProvider.xml file.

Newly created XML file is opened.

11. Replace existing class name with the new class name in the <implementation class>attribute.



12. Expand MetaINF folder to see the MANIFEST.MF file.

13. Add an entry of the newly created XML file in the service-implement attribute in theform OSGI-INF/<class name>.xml

14. Save all the open files.

Note: If you want to add more context factories, repeat the procedure.

Java Global InstanceYou can use Java Global Instance shared configuration resource to specify a Java objectto be shared across all process instances in a Java Virtual Machine (JVM).

When the engine is started, an instance of the specified Java class is constructed. When theprocess engine is shut down, if specified, a cleanup method is invoked on the object. Theobject is released before the engine shuts down. Any Java Invoke activity can beconfigured to access the shared Java global instance when the process engine runs. AnyJava Invoke activity can access the shared java global instance by invoking the staticmethods of the configured Java class.

If multiple process instances access the shared Java global instance, you may want toensure that only one process instance can access the object at a time. You can accomplishthis by either declaring the methods of the configured class as synchronous or by using acritical section group.

General

The General field has the following fields.

Field Description






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.

ParameterInput

The input parameters for the constructor selected in the Method field. Eachinput parameter has the following three fields:

l Parameter: the name of the parameter

l Type: the datatype of the parameter

l Value: specify a value for the parameter in this field. You can set thevalue by using a module property.

Note: When string is the datatype for the parameter, do not use quotesaround the string when specifying the value.

Advanced Configuration


Field Description

InvokeCleanupMethod

Selecting this check box signifies that you want to invoke a method on theobject before the object is released from memory when the engine terminates.You can perform cleanup activities, such as closing connections, releasingresources, and so on.

Selecting this check box enables the Cleanup Method field.



Field Description

CleanupMethod

This field is only available when you select the Invoke Cleanup Method checkbox.

You can specify the name of the method to invoke before the object in memoryis released. The method selected cannot contain any parameters, therefore onlymethods without parameters are listed in this field. Any values returned by theselected method are ignored, but exceptions raised by the selected method aresent to the log.

Keystore ProviderKeystore Provider shared resource provides an access to a keystore.

General


Field Description




Keystore





Description

Provider None The name of the keystore provider. Select from thefollowing available options:

l SUN

l IBMJCE

When you select Keystore Type as PKCS#11, this fieldbecomes editable and a drop-down list shows a list ofPKCS#11 security providers.

Default: Empty. The first matching provider supporting theformat is selected.

URL Yes The location of the keystore.

This field is disabled when you select Keystore Type asPKCS#11.

Password Yes The password for the keystore.

Type None The type of the keystore. Select from the following types:

l JCEKS: Java Cryptography Extension KeyStore

l JKS: Java Key Store

l PKCS#11: Hardware keystore type

l PKCS#12: Standard keystore type

The default value is JKS.

Note: To configure PKCS#11, enable FIPS configurationof a system. For more information about enabling FIPSmode, see JDK 8 PKCS#11 Reference Guide atOracle.com.

RefreshInterval

Yes Refresh interval, greater than 0. If the keystore provider isaccessed after the refresh interval has expired:

https://docs.oracle.com/javase/8/docs/technotes/guides/security/p11guide.html




Description

l The refresh timer is reset to zero.

l The operations on the keystore provider areperformed on the refreshed copy.

This field is disabled when you select Keystore Type asPKCS#11.


Note: It is recommended not to use expired certificates.

LDAP AuthenticationLDAP Authentication shared resource represents configuring the connection to an LDAPserver. This connection is used by component implementations to look up names in anLDAP directory server.

LDAP Authentication is primarily used for HTTP basic authentication in ActiveMatrixBusinessWorks. The following fields are commonly used:

l Server URL: LDAP Server Location, such as, ldap://10.107.170.145:389

l User Search Expression: search expression for the user, such as (&(cn={0})(objectclass=user))

l User DN Template: user distinguished name template, such as cn={0},cn=users,dc=na,DC=tibco,DC=com

General




Field Description




LDAP Authentication

The LDAP Authentication section has the following tabs:

Connection

The Connection tab has the following fields.


Description

Server URL Yes The URL with the host and port number on which theLDAP server is listening for connections.

The default is ldap://localhost:389

User SearchExpression

Yes Search expression for the user, such as (&(cn={0})(objectclass=user)).

Admin UserCredential

None The username and password in LDAP format such ascn={0},CN=Users,DC=ce,DC=na,DC=tibco,DC=com. Create alimited or restricted user that can only search yourtree.

Selecting this check box displays the CredentialsProvider option.

CredentialProvider

None Select the identity provider having LDAP server admincredentials.




Description

User SearchBase DN

Yes The LDAP user search expression to be used forperforming the user search in a specified hierarchy.Leave this field blank to start search from the top levelelement in the directory.

User SearchScope

None This specifies the number of levels in the directoryserver that is searched for a matching user profile.Select any from the following available options:

l Subtree: indicates all the sub-entries (all lowerlevels)

l One level: indicates all entries immediately (onelevel)

The default value is Subtree.

User DNTemplate

Yes This field appears when the Admin User Credentialscheck box is not selected. Write user distinguishedname template, such as cn={0},cn=users,dc=na,DC=tibco,DC=com.

SSLConfiguration

None Select this check box to configure an SSL Client.

SSL Client None The name of the resource. In the SslClientResourceResource Template wizard, create a resource toconnect to the LDAP server over SSL using SSL clientshared resource.

Users and Groups

The Users and Groups tab has the following fields.




Description

User's name Yes The name of the user in the LDAP directory.

Additionaluserattributes toretrieve

Yes The field specifies the LDAP attribute used to search andretrieve the user profile. For example, using a differentattribute in your directory server such as the given name.

GroupIndication

None Specifies the following groups:

l No Group Info

l User Attributes Indicates Group: used for groupingthe user that matches the specified attribute. Whenselected, displays the User Attribute Group Namefield.

l User DN Indicates Group: group of user DN. Whenselected, displays the User Attribute Group Namefield.

l Search Groups:

Selecting the Search Groups option displays the followinggroups:

l Group Root DN

l Group Search Expression

l Group Attribute User Names

l Group Attribute Group Name

l Group Attribute Subgroup Name

Note: The Group Indication is useful for Authorizationby roles in the Basic Authentication policy resource.

Search

The Search tab has the following fields.




Description

User SearchScope

None This specifies the number of levels in the directory serverthat is searched for a matching user profile. Select anyfrom the following available options:

l Subtree: indicates all the sub-entries (all lowerlevels)

l One level: indicates all entries immediately (onelevel)

The default is Subtree.

Group RootDN

Yes The root distinguished name (DN) group name.

Group SearchScope

None Provides the search scope option, true or false.

l Select true, if you want to scan the entire LDAP treebeneath the DN (subtree scope).

l Select false, if you want to scan only direct childrenof that DN (one-level scope).

Group SearchExpression

Yes The group search expression property

Advanced



Description

FollowReferrals

None When you select this check box, the LDAP server does notreturn results. Instead it returns a reference (a referral) toanother LDAP server which may contain additional




Description

information such as the names and locations of otherobjects.

ConnectionPool

Yes Specify the number of the connections in this field. Thedefault is 10.

All activities that are part of the same transaction, usethe same connection in the connection pool. The firstactivity in a transaction attempts to reestablish an invalidconnection. If a connection becomes invalid during atransaction, the transaction is rolled back and must beretried, if necessary.

SearchTimeout

Yes Specifies the timeout in milliseconds for LDAP search. Thedefault is 0.

Test Configuration

The Test Configuration tab has the following fields.

Field Description

Test Click the Test button to start testing the LDAP search operation.

Search Results Shows the search results returned by the LDAP search operation.

OAuth Configuration ResourceThe OAuth Configuration Resource template represents an OAuth connection.

General

The General section has the following fields:



Field Description

Package The name of the package in which you want to create a shared resource

Name The name of the shared resource


OAuth Configuration Resource



Description

Client ID Yes Enter Client ID for Oauth Configuration.

Client Secret Yes Enter Client Secret for Oauth Configuration.

Access TokenURL

Yes Enter Access Token URL Authorization Server.

Scope Yes Enter scope for Oauth Configuration.

Grant Type None Select a grant type from the Grant Type dropdown list.

The following options are supported:

l Client credential

l Resource password

By default Client credential option is selected.

Username Yes Enter a username for the Resource passwordgrant type.

Password Yes Enter a password for the Resource passwordgrant type.



Test Connection

Click the Test Connection button to test whether the specified configuration fields resultin a valid connection to an Authorization Server.

Security

Select the Confidentiality check box to configure the SSL connection parameters.

Note:Module property is now supported for Confidentiality check box.

Field Description

SSL ClientConfiguration

Specify an SSL Client Shared Resource.

For more information about how to configure the shared resource, seeSSL Client Configuration.

Note: OAuth 2.0 is supported with HTTP Client shared resource only when usedwith REST reference binding. OAuth 2.0 is not supported with the Invoke RESTAPI or Send HTTP Request activities.

Proxy ConfigurationProxy Configuration shared resource is used to specify a proxy HTTP server when HTTPrequests are sent outside of a firewall.

General




Field Description




Proxy Connection Configuration


Field Literal Value/Module Property Description

Host Yes The host name or IP address of the proxy server.

Port Yes The port number of the proxy host.

Security


Field Description

Authentication Select the check box to specify the authentication to be used.

Identity Provider Create a UserId resource in the UserIdResource Resource Templatewizard. This provides access to the username and password credentials toaccess the proxy connection.

Rendezvous TransportRendezvous Transport resource describes a TIBCO Rendezvous ® transport. This resourceis used when specifying activities from the Rendezvous palette. For more informationabout specifying these fields, see the TIBCO Rendezvous documentation.



Configuration

The Configuration tab has the following fields.


Description

Name No Resource label.

Description No Short description of the shared resource.

Daemon Yes If the Rendezvous daemon is running on the samemachine as the process engine: Daemon is notspecified.

If the Rendezvous daemon is running on a differentmachine than the process engine:

Host name followed by the socket number.

For example:

ssl:acct:5785

Network Yes Host name, IP address, network name, or interfacename.

For example:

;224.34.103.4

Service Yes TIBCO Rendezvous service name or port number:

For example:

<service name>

<port number>

SSL No Use Secure Sockets Layer (SSL) when communicatingwith the TIBCO Rendezvous daemon. Select this field




Description

to enable the Configure SSL button.

For more information, see Configure SSL Button.

Configure SSL Button

The Configure SSL button allows you to configure the SSL parameters for communicatingwith the TIBCO Rendezvous daemon. For more information about how SSL is configured forTIBCO Rendezvous daemons and clients, see the TIBCO Rendezvous documentation.

The SSL Configuration for TIBCO RV dialog tab has the following fields:

Field Description

DaemonCertificate

File containing one or more certificates from trusted daemon certificateauthorities. Select this field to connect to a trusted (non-rogue) daemon andretrieve a daemon certificate.

Once a certificate is retrieved, select a project folder in the TIBCO Rendezvousadministration interface and choose Tools>Trusted Certificates>Import Into PEMFormat to import the certificate.

Alternatively, instead of importing or embedding them, configure certificatesat deployment time by declaring a global variable and setting its absolute pathto a certificate in PEM format.

To learn more about retrieving, importing, and configuring daemon certificatesusing the administration interface, see the TIBCO Rendezvous documentation.

Identity Identity resource used to authenticate the TIBCO Rendezvous daemon.

Click Browse to select an identity resource from a list of resources whose Typefield is set to Identity File or Username/Password.



Advanced

The Advanced tab has the following fields:


Description

RV Type No Type of Rendezvous connection (reliable (standard RVtransport), certified (RVCM), or Distributed Queue (RVCMQ)).

Note: Use Confirm activity with RV Certified messaging.

The fields on the Advanced tab correspond to the valueselected for this field.

Certified Transport

CM Name Yes Name of the delivery-tracking session, in the same format asTIBCO Rendezvous subject names.

Ledger File Yes Name and location of the persistent ledger file that trackscertified messages. If not specified, the certified message ledgeris kept in process memory only.

Sync LedgerFile

Yes Specifies whether to keep the ledger file synchronous with thecurrent messages.

Relay Agent Yes Name of the relay agent to use. Relay agents are useful whenclients are disconnected from the network from time to time.The relay agents store inbound certified messages and labeledmessages (and other messages related to certified deliveryfeatures) on behalf of their disconnected client programs. Whena client is connected, the relay agent receives inboundmessages immediately.

Require OldMessage

Yes Select this check box if you want to require the retention ofmessages for which delivery has not been confirmed. Thesemessages are be resent.

Message Yes Time limit for certified message delivery.




Description

Timeout(sec)

Distributed Queue Transport

CMQ Name Yes Name of the distributed queue, in the same format as TIBCORendezvous subject names.

WorkerWeight

Yes Weight of the worker (this pertains to the worker processingqueue requests, not to BusinessWorks process engines).Relative worker weights assist the scheduler in assigning tasks.When the scheduler receives a task, it assigns the task to theavailable worker with the greatest worker weight.

WorkerTasks

Yes Sets the task capacity for the worker (this pertains to theworker processing queue requests, not to BusinessWorksprocess engines). Task capacity is the maximum number oftasks that a worker can accept. When the number of acceptedtasks reaches this maximum, the worker cannot acceptadditional tasks until it completes one or more of them.

WorkerCompleteTime

Yes The amount of time the scheduler waits for a worker process tocomplete. If the worker process does not complete the processin the specified time, the scheduler reassigns the message toanother worker.

SchedulerWeight

Yes Weight represents the ability of this member to fulfill the role ofscheduler, relative to other members with the same name.Cooperating distributed queue transports use relative schedulerweight values to elect one transport as the scheduler. Memberswith higher scheduler weight take precedence. Acceptablevalues range from 1 to 65535.

SchedulerHeartbeat(sec)

Yes Interval in which scheduler sends heartbeat messages. Allmembers with the same name must specify the same value forthis parameter. The value must be strictly positive.




Description

SchedulerActivation(sec)

Yes Maximum amount of time that the heartbeat signal from thescheduler is silent before the member with the greatestscheduler weight becomes the new scheduler. All memberswith the same name must specify the same value for thisparameter. The value must be positive.

SMTP ResourceA SMTP Resource shared resource template represents a connection to an SMTP server.Using the SMTP Resource, you can transfer e-mail messages between servers. The SMTPcommunications are transported by TCP to ensure end-to-end transport.

General


Field Description




SMTP





Description

MachineName

Yes The name of the host that accepts the incoming requests.The default value is localhost.

Port Yes The port number on which you can listen for SMTPrequests. The default value is 25.

Timeout(ms)

Yes The waiting time for a response from the server. Thetimeout must be greater than zero (0). A timeout of zero isinterpreted as an infinite timeout. The timeout value inputin this field also applies to the socket I/O timeout.

Username Yes The valid username used to authenticate connections tothe server.

Password Yes The valid password used to authenticate connections tothe server.

EnableSTARTTLS

Module Property Select the Enable STARTTLS check box to use SMTP overSSL.

This check box is selected by default.

Security

Select the Confidentiality check box to display the SSL Client field.

Field Description

SSLClient

The name of the resource. In the SslClientResource Resource Template wizard,create a resource to connect to the SSL client.



SSL Server Configuration in the CloudTIBCO ® Cloud Integration (TCI) does not support SSL server configuration/user-defined SSLparameters for TIBCO applications.

However, you can accomplish the same functionality using Mashery EndpointConfiguration.

SSL Server ConfigurationYou can specify SSL parameters for the HTTP connection here.

The following are the fields in the SSL Server Configuration for the HTTP connector.

General


Field Description




Basic SSL Server Configuration

This contains the following fields.


Description

Identity StoreProvider

No Used to provide identity store.




Description

Key Alias Name Yes The name of the alias used to access the identity.

Key AliasPassword

Yes The password for the alias.

Enable MutualAuthentication

No Indicates whether the client in the SSL connectionauthenticates to the server. Selecting this check boxdisplays the identity fields.

Client Auth Type No Select the type of client authentication from the drop-down list. The available types are:

l optional

l required

KeystoreProvider as TrustStore

No The name of a keystore provider resource instance thatmaintains a keystore that confirms an identity.

Advanced SSL Server Configuration

Use the following fields for advanced SSL server configuration.


Description

SSL SecurityProvider

Yes Optional. The SSL security provider.

Note: Note: This is the name for the JSSE's cryptographicprovider implementing SSLContext. If you are using non-default providers, such as PDCS#11 ones, you might want tooverride it.

SSL Protocol No The SSL protocol to use in the SSL connection. Select from thefollowing options:




Description

l TLSv1

l TLSv1.1

l TLSv1.2

l TLSv1.3

l SSLv3 – Use of this protocol is discouraged.

The default value is TLSv1.2.

Selecting a protocol implies the support of higher versions aswell.

Note:l TSLv1.3 as SSL Protocol is supported for HTTP, REST,

SOAP, Mail and TCP Palettes.

l TLSv1.3 supports only RSA certificates.

SSL CipherClass

No The number of bits in the key used to encrypt data:

l No Exportable Ciphers

l All Ciphers

l At Least 128 Bit

l More Than 128 Bit

l At Least 256 Bit

l FIPS Ciphers

l Explicit Ciphers

ExplicitCipher List

Yes A list of ciphers. Enabled when SSL Cipher Class is set toExplicit Ciphers. Use the JSSE format for ciphers names.

VerifyRemote HostName

No Indicates whether the name on the server's certificate must beverified against the server's host name.




Description

If the server's host name is different than the name on thecertificate, the SSL connection fails. You can verify the name onthe certificate against another name by specifying ExpectedRemote Hostname.

Selecting this check box displays the Expected RemoteHostname field.

Default: This check box is deselected.

ExpectedRemoteHostname

Yes Optional. The expected name of the remote host.

The default is None.

Mashery End Point ConfigurationTIBCO® Cloud Integration (TCI) does not support user-defined SSL parameters for TIBCOapplications and will ignore any existing SSL server configuration shared resource duringapplication deployment.

Instead of user-defined SSL parameters, use Mashery end point configuration. Mashery canhost SSL certificates and ensure SSL/TLS connection encryption on your chosen domain orhost.

For more information see Domain and Traffic Routing in the TIBCO Mashery® API ControlCenter - The Design Controls guide.

Contact TIBCO Support for information on how to install and use an SSL certificate onMashery.

SSL Client ConfigurationYou can specify SSL parameters for the HTTP client shared resource here.

http://docs.mashery.com/design/GUID-B2D5C5B5-1D8D-4E2D-BD4A-DABE025AF8EE.html



SSL Client Configuration

The General section in the SSL Client Configuration has the following fields.

Field Description




Basic SSL Client Configuration



Description

KeystoreProvider As TrustStore

No The name of a keystore provider resource instance thatmaintains a keystore that confirms an identity.

Enable MutualAuthentication

No Indicates whether the client in the SSL connectionauthenticates to the server. Select this check box to enablethe identity fields.

Identity StoreProvider

No The name of keystore provider resource that maintains akeystore used to assert an identity.


Key AliasPassword


Advanced Client SSL Configuration

This section contains the following fields.




Description

SSL SecurityProvider

Yes Optional. The SSL security provider.

Note: This is the name for the JSSE's cryptographic providerimplementing SSLContext. If you are using non-defaultproviders, such as PDCS#11, you might want to override it.

SSL Protocol No The SSL protocol to use in the SSL connection:

l TLSv1

l TLSv1.1

l TLSv1.2

l TLSv1.3

l SSLv3 - Use of this protocol is discouraged.

The default value is TLSv1.2.

Selecting a protocol implies the support of higher versions aswell.

Note:l TSLv1.3 as SSL Protocol is supported for HTTP, REST,

SOAP, Mail and TCP Palettes.

l TLSv1.3 supports only RSA certificates.

SSL CipherClass

No The number of bits in the key used to encrypt data:

l No Exportable Ciphers

l All Ciphers

l At Least 128 Bit

l More Than 128 Bit

l At Least 256 Bit

l FIPS Ciphers




Description

l Explicit Ciphers

The greater the number of bits in the key (cipher strength), themore possible key combinations and the longer it takes tobreak the encryption.

The default is At Least 128 Bit.

ExplicitCipher List

Yes A list of ciphers. Enabled when SSL Cipher Class is set toExplicit Ciphers. Use the JSSE format for ciphers names.

VerifyRemote Hostname

No Indicates whether the name on the server's certificate must beverified against the server's host name. If the server's hostname is different than the name on the certificate, the SSLconnection fails. The name on the certificate can be verifiedagainst another name by specifying Expected RemoteHostname.

Selecting this check box displays the Expected RemoteHostname field.

Default: This check box is deselected.

ExpectedRemoteHostname

Yes Optional. The expected name of the remote host.

The default is None.

Subject ProviderThe Subject Provider resource provides support for authenticating user credentials througha Keystore or Trust Store.

General




Field Description




Subject Provider

The Subject Provider section has the following fields.


Description

CredentialProvider forIdentity Store

None Refers to a Keystore Provider resource. The KeystoreProvider maintains the keystore used to assert anidentity.


Key AliasPassword


CredentialProvider for TrustStore

None Optional. Select a Trust Provider resource.

Security

The Security section has the following fields.




Description

SOAPActor

Yes SOAP Actor field can be used to provide the SOAP actorattribute to address the SOAP header element to a specificendpoint.

ProtectToken

None Protect Token check box can enable or disable signing ofBinary Security Token. By default, the check box is selected.

TCP ConnectionThe TCP Connection shared resource specifies the connection information for the TCPserver. This resource is used when a process acts as a TCP client connecting to a remoteserver or when a process acts as a TCP server accepting incoming TCP.

General


Field Description




TCPConnection





Description

Host Yes When a process acts as a client, this field specifies thehost name or host IP address of the TCP server toconnect to.

When a process acts as a server, this field specifies thehostname or IP address of the machine where theprocess engine is running. You can specify localhost , orif the machine has more than one network interfacecard, you can specify the IP address of the card youwant to use to accept the TCP/IP connections.

Port Yes This field specifies the port number on which a TCPserver is listening for requests.

EnableConnectionPool

Yes Selecting this check box enables the When ExhaustedConnections, Maximum Connections, Maximum WaitTime, and Idle Timeout fields.

WhenExhaustedConnections

Yes When the connections are exhausted on the server,select any one option from the following availableoptions.

l Block: the pool is blocked when the pool isexhausted, that is, the maximum number of activeobjects has been reached, until a connection isavailable, or the maximum wait time has beenreached.

l Fail: when the pool is exhausted, that is, themaximum number of connections have beenconsumed, it fails.

l Grow: when this policy is selected a newconnection is created for every request of theclient, therefore there is no maximum connectionlimit.




Description

MaximumConnections

Yes Specifies the maximum number of simultaneous clientsessions that can connect with the server. Thisparameter is enabled only if connection pooling isenabled, that is, the Enable Connection Pool check boxis selected.


Maximum WaitTime (msec)

Yes Specifies the maximum wait time in milliseconds toconnect to the TCP server. This parameter is enabledonly if connection pooling is enabled. That is, theEnable Connection Pool check box is selected.


Idle Timeout(msec)

Yes Specify the idle timeout for the connections inmilliseconds.


Security

Select the Confidentiality check box to encrypt or decrypt messages. When you select thecheck box, the SSL Client Configuration field is visible.

For more information, see SSL Client Configuration.

Trust ProviderThe Trust Provider resource maintains the identity of a trusted resource.

General




Field Description

Package The name of the package in which you want to create a policy resource.



Trust Configuration

The Trust Configuration section has the following fields.

Field Description

Credential Store used for Trust Refers to a Keystore Provider. The keystore is a trust store.

Enable Tust Store Access Select this option to enable acess to the specified truststore.

WSS AuthenticationA WS-Security ASP resource template enables a connection to Web Services Securityauthentication services.

General


Field Description






Basic Configuration

The Basic Configuration section has the following fields.

Field Description

SecurityToken

Security Token is an online security credential that adds an extra layer ofidentity protection.

X.509 token is the default selection. X.509 is an ITU-T standard for a publickey infrastructure (PKI) and Privilege Management Infrastructure (PMI).

EnableSignatureVerification

Select to indicate whether to verify the signatures. By default, this option isnot selected. If selected, it activates the Trust Provider field.

EnableDecryption

Select to indicate whether to enable decryption. By default, this option is notselected. If selected, it activates the Subject Provider field.

Note: Select both Enable Signature Verification and Enable Decryptionto activate the Subject Provider (with Trust Credential) field.

User Authentication

The User Authentication section has the following fields.

Field Description

Select the type ofauthentication

Choose to authenticate users through XML File Authentication orLDAP Authentication.

XML File Resource The name of the XML Authentication shared resource used toauthenticate user credentials.

LDAP Resource The name of the LDAP Authentication shared resource used toauthenticate user credentials.



XML AuthenticationThe XML Authentication resource provides support for XML file-based authentication.

General


Field Description




XML Authentication Configuration

The XML Authentication Configuration section has the following fields.


Description

XMLFile

Yes The XML File containing user credentials and group mappings.

The group mappings are used in the Authorization by role inthe Basic Authentication policy resource.

Notify ConfigurationThe Notify Configuration specifies a schema to use for passing data between executingprocess instances. The corresponding Receive Notification, Notify and Wait forNotification activities use the same Nofity Configuration to define the data for inter-process communication. The schema can be empty, if you do not want to pass databetween processes.



General


Field Description

Package The name of the package in which you want to create a Configurationresource.

Name The name of the configuration resource.

Description A description of the configuration resource.

Notify Configuration Editor

The Notify Configuration Editor is used to define a custom schema. The schema can beempty, if you do not want to pass data between processes.

You can define your own datatype on this tab, and you can reference XML schema orActiveEnterpise classes stored in the project. Once defined, the data specified on the tabappears on the Input or Output tab of the Receive Notification, Wait for Notification orNotify activity where this shared configuration resource is used.

Thread PoolThe thread pool is a queue of threads available to run a collection of tasks. Thread poolsare used to improve performance when executing large numbers of asynchronous tasks byreducing per task invocation overhead. This provides a means of bounding and managingthe resources consumed when executing a collection of tasks.

General




Field Description

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

Description A short description of the resource.

Thread Pool



Description

Core PoolSize

Yes Must be greater than or equal to zero. The default is 5.

Max PoolSize

Yes The maximum number of threads in the pool. Must begreater than zero and greater than or equal to core poolsize.

The default is 10.

Keep AliveTime (s)

Yes The length of time an idle thread remains in the poolbefore being reclaimed, if the number of threads in pool ismore than core pool size.

The default is 30 seconds.

AutostartCoreThreads

Yes Indicates to create and start the core pool size threadswhen the thread pool is created. Normally core threads arecreated and started 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 bestarted as a daemon or a user. The default is false.




Description

Priority Yes The default priority of the threads in the pool. The defaultis 5.

RejectionPolicy

No The policy applied when no thread is available to run atask:

l BLOCKING: the task is blocked until a thread from thethread pool picks up this task.

l CALLER RUNS: the task is run in the calling thread.

l ABORT: the task is aborted and an exception isgenerated.

The default is BLOCKING.


527 | TCP Palette

TCP PaletteThe TCP palette provides activities and resources that can send and receive data using theTCP protocol. TCP is often the inherent communication layer for high-level protocols suchas HTTP or FTP.

You could use the resources in the TCP palette to communicate with HTTP or FTP severs,but the activities in the HTTP palette or FTP palette are best suited for this purpose. Usethis palette when communicating with TCP, when there is no corresponding ActiveMatrixBusinessWorks palette for the protocol. For example, using the TCP palette to handle theincoming and outgoing data from a custom application that communicates with otherapplications by way of TCP.

TCP PropertiesThis section describes custom engine properties that can be set for the resources in theTCP palette.

bw.plugin.tcp.waitUntilBytesToReadReceived

Set the property to true for the Read TCP Data activity to wait until it receives the exactnumber of bytes specified in the Bytes To Read field on the General tab , or the end ofstream is detected.

bw.plugin.tcp.closeSocketOnShutdown

Set the property to false to enable TIBCO ActiveMatrix BusinessWorks™ to keep the serverside socket enabled when the TCP server is shut down.

bw.plugin.tcp.server.acceptCount

This property specifies the maximum number of incoming requests that can be handled bythe TCP server. The default value for this property is 50.


528 | TCP Palette

Using the TCP Palette ActivitiesYou can use the TCP palette activities to create a general sequence of events in a process.

Procedure1. Create a TCP Connection shared configuration resource that describes the connection

information.

2. Depending on whether the process is a TCP client or server, one of the followingoccurs:

a. A connection opens using the TCP Open Connection activity, when a processworks as a TCP client communicating with a TCP server.

b. The process starts either with a TCP Receiver process starter or has a Wait forTCP Request activity that waits for an incoming connection request, when aprocess works as a TCP server waiting for the incoming TCP requests.

3. Use the Read TCP Data and Write TCP Data activities to read and write data to thein process TCP connection.

4. After the process is complete, close the TCP connection using the TCP CloseConnection activity.

Read TCP DataRead TCP Data is an asynchronous activity that reads data from an open TCP connection.The connection must be opened by an activity or a process starter that executed previouslyin the process.

Activities that can open a TCP connection are: TCP Receiver, TCP Open Connection, andWait for TCP Request. The activity that opens a TCP connection places a handle to theopen connection in its connectionKey output element. The connectionKey is mapped tothis activity’s input.

General



529 | TCP Palette


Description


Type None Type of data to be read. This can be either Text orBinary.

Specifying Text in this field enables the Separator andEncoding fields. When Binary is specified, the BytesTo Read field is enabled.

Separator Yes The type of separator. This activity reads data from theTCP connection until the separator or the end of thedata stream is encountered.

Select User-defined binary separator (specifycomma-separated byte values) from the drop-downlist to enable the User Defined Separator field.

UserDefinedSeparator

Yes This field specifies the separator character to use.

When Binary is selected in the Type field, a user-defined separator can be:

l A string representation of a single byte, or

l A comma-separated byte values (for example,0x0a, 0x0b, 0x0c, and so on).

For valid string representations of byte values, refer tothe Java documentation for the decode(String n) methodof Java.lang.Byte.

Encoding Yes Specifying Text in the Type field, determines thecharacter encoding of the text data in this field.

Bytes ToRead

Yes Specify the number of bytes to be read by this activity.

This field is enabled when you select Binary in the


530 | TCP Palette


Description

Type field.

Leaving this field blank makes the activity read untilthe end of the data stream is encountered.

Timeout(msec)

Yes The time to wait (in milliseconds) for this activity tocomplete.

Description

Provide a short description for the Read TCP Data activity.

Input


Note: When Text is specified in the Type field, the Input tab displaysconnection, encoding, separator, and timeout elements. Specifying Binary inthe Type field displays connection, bytesToRead, and timeout elements.


connection binary The handle to the connection to read the data from.

This connection is obtained from a previously executedactivity in the process that opened the connection.

encoding string Specifies the character encoding of the text when readingthe text data.

This value overrides the value specified in the Encoding fieldin the General tab.


531 | TCP Palette


separator string An optional element. Specifies the boundary between thebody elements after writing the body element to the TCPconnection, while reading the text data.

This element is available only when the User DefinedSeparator option is selected on the General tab.

This value overrides the value specified in the General tab.

bytesToRead number An optional element. Specifies the number of bytes to beread when reading the binary data.

This value overrides the value specified in the Bytes ToRead field in the General tab.

timeout number An optional element. The time to wait (in milliseconds) forthis activity to complete.

Output



data string When the data is specified as text, this outputelement contains the text read from the TCPconnection. The separator character if specified, isnot included in the output.

When the data is specified as binary, this outputelement contains the binary data read from the TCPconnection.

endOfStreamReached boolean This element is set to true, when the end of thedata stream is reached.

This is useful when the activity is in an iterationloop and the activity is configured to read a numberof bytes with each iteration. Use this element in the


532 | TCP Palette


condition of the loop, to determine when the lastset of bytes was read.

Fault



TCPActivityFault There is some problem associated with the activity at runtime.

TCP Close ConnectionTCP Close Connection is a synchronous activity that closes a TCP connection opened by apreviously executed activity or a process starter.

General


Field Description


Description

Provide a short description for the TCP Close Connection activity.

Input



533 | TCP Palette


connection binary The handle to the connection that you want to close.

This value is obtained from a previously executed activity inthe process that opened the connection.

Output

The activity has no output.

Fault




TCP Open ConnectionTCP Open Connection is a synchronous activity that opens a connection to a TCP server.After establishing the connection, the activity places a handle to the open connection inthe connection output element. The subsequent activities in the process use thisconnection key for the TCP Connection to read data from, write data to, or close theconnection.

General



534 | TCP Palette


Description


TCPConnection

Yes The TCP Connection is a shared configuration resourcethat specifies the connection information for the TCPserver. Specify the required value in the TCP connectionproperty.

Local Host None Specifies the IP address on the local machine to be usedas the TCP client.

Timeout None Specifies a timeout value for the TCP Connection.

l Default value : 0.

l Lower limit : 1.

l Upper limit : default OS timeout value.

Note: For default value and timeout value higher thanthe default OS timeout value, the timeout will occurwithin the OS default timeout.

Description

Provide a short description for the TCP Open Connection activity.

Input



connection complex An optional element. This element contains the informationabout the TCP server you want to connect to. It comprises


535 | TCP Palette


host, port, and localhost elements.

host string An optional element. The name or IP address of the TCP serveryou want to connect to.

This value overrides the value specified by the TCP connectionproperty in the General tab.

port number An optional element. The port number on which the TCPserver is listening for requests.

This value overrides the value specified by the TCP connectionproperty in the General tab.

localhost string An optional element. The name or the IP address of the TCPclient.

Output



connection binary The handle to the open connection.

The subsequent activities in the process use this connectionkey to read data from, write data to, or close the connection.

Fault





536 | TCP Palette

TCP ReceiverTCP Receiver is a process starter activity that starts the process when a client requests aTCP connection. The connection element in the activity output contains the handle to theTCP connection. The subsequent activities in the process can use this handle for the TCPconnection to read data from, write data to, or close the connection.

General

The General has the following fields.


Description


Security Yes To be included when encrypting or decrypting themessages. The drop-down list displays the SSL ServerConfiguration field. Use this field to specify the SSLparameters.

For more information, see SSL Server Configuration.

Host Yes The hostname or the host IP address of the TCP server toconnect to.

Port Yes Specify the port number on which this TCP server islistening for requests.

EnableDNSLookup

None Select this check box to enable a domain name system(DNS) lookup for resolving the IP address to a DNS name.

Caution: Select this element only when required, asthis may adversely affect throughput.

Keep Alive None Select this check box to specify for the TCP connectionsto use the keep alive feature of sockets.


537 | TCP Palette

Description

Provide a short description for the TCP Receiver activity.

Advanced

The Advanced tab contains the following fields.

Field Description

SequenceKey

This field can contain an XPath expression that specifies which processesshould run in a specified order.

Process instances with sequencing keys evaluating to the same value areexecuted sequentially in the order of the process instance creation.

Custom JobId


Conversations

You can initiate the conversation here. Click the Add New Conversation button toinitiate multiple conversations.

For more information about conversations, see the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Output



connection binary The handle to the open connection. This connection can beused by subsequent activities in the process definition tospecify the TCP connection to write data to, read data from orclose.


538 | TCP Palette


IP string The IP address of the client sending the TCP request.

Host string The host name of the client sending the TCP request. This fieldis available only when you select the Enable DNS Lookup fieldin the General tab.

Port integer The port number of the client sending the TCP request.

Wait for TCP RequestWait for TCP Request is a signal-in activity that waits for a TCP client connection request.When a connection request occurs, the activity places a handle to the open connection inthe connection output element. The subsequent activities in the process use thisconnection key to read data from, write data to, or close the connection.

General



Description


Security Yes To be included when encrypting or decrypting themessages. The drop-down list displays the SSL ServerConfiguration field. Use this field to specify the SSLparameters.

For more information, see SSL Server Configuration.

Host Yes The hostname or the host IP address of the TCP server to


539 | TCP Palette


Description

connect to.

Port Yes Specify the port number on which this TCP server islistening for requests.

EnableDNSLookup

None Select this check box to enable a domain name system(DNS) lookup for resolving the IP address to a DNS name.

Caution: Select this element only when required, asthis may adversely affect throughput.

Keep Alive None Select this check box for the TCP connection to use thekeep alive feature of sockets.

Note: TCP keep alive is different from HTTP keepalive.

Description

Provide a short description of the activity.

Event


Field Description


A message may arrive before this activity is executed. Specify the amount oftime (in seconds) for a message to wait, if the message is received before thisactivity is executed.


Specify the amount of time (in milliseconds) for an activity to wait before it isexecuted.


540 | TCP Palette

Conversations

You can initiate or join the conversation here. Click the Joining Existing Conversation

button to join multiple conversations. Click the Add New Conversation button toinitiate conversations.

For more information about conversations, see the TIBCO ActiveMatrix BusinessWorks™Application Development guide.

Output



connection binary The handle to the open connection. This connection key canbe used by subsequent activities in the process definition tospecify the TCP connection to write data to, read data from, orclose.

IP string The IP address of the client sending the TCP request.

Host string The host name of the client sending the TCP request. Selectthe Enable DNS Lookup field in the General tab to enablethis field.

Port integer The port number of the client sending the TCP request.

Fault





541 | TCP Palette

Write TCP DataWrite TCP Data is an asynchronous activity that sends data on the specified TCPconnection. The connection must be opened by an activity or process starter that executedpreviously in the process.

General



Description


Type None The type of the data to write. This can be either Textor Binary.

Specifying Text in this field displays the Separator andEncoding fields.

Specifying Binary in this field displays the UserDefined Separator field.

Separator Yes The type of separator to use. The separator is writtento the TCP connection after the specified data iswritten.

Select User-defined separator from the drop-down listto enable the User Defined Separator field.

UserDefinedSeparator

Yes This field specifies the separator character to use.

When Binary is selected in the Type field, a user-defined separator can be a string representation of asingle byte value or it can be comma-separated bytevalues (for example, 0x0a, 0x0b, 0x0c). For valid stringrepresentations of byte value, refer to the Java


542 | TCP Palette


Description

documentation for the decode(String n) method ofjava.lang.Byte.

Encoding Yes When text data is specified, this field determines thecharacter encoding to use for the text data.

Description

Provide a short description for the Write TCP Data activity.

Input

The following is the input for activity.


connection binary The handle to the connection that you want to write data to.This connection is obtained from a previously executedactivity in the process that opened the connection.

data string orbinary

The data to write to the TCP connection. The data type of thisfield is either String or Binary, depending upon the dataselected in the Type field in the General tab.

encoding string An optional element. When writing text data, this specifies thecharacter encoding of the text. This value overrides the valuespecified in the Encoding field in the General tab.

separator binary An optional element. This is available only when you select thes option on the General tab.

timeout number An optional element. The time to wait (in milliseconds) for thisactivity to complete.


543 | TCP Palette

Output

This activity has no output.

Fault





544 | XML Activities Palette

XML Activities PaletteThe XML Activities palette provides activities for parsing XML strings into schemas andrendering schemas into XML strings.

Parse XMLParse XML is a synchronous activity that takes a binary XML file or an XML string andconverts it into an XML schema tree based on the XSD specified.

Parsing Date and Datetime Strings

In XML documents parsed by the Parse XML activity, datetime values are read inaccordance with the ISO-8601 standard, as described in the XML Schema specification. Forexample, 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 atime zone that is 8 hours, 0 minutes behind UTC.

If no time zone field is present, the value is interpreted in the time zone of the machinethat is performing the parsing. This can lead to complications if you are processing XMLfrom a different time zone, so you are encouraged to always use a time zone.

General


Field Description


Input Style Can be Binary, Text, or Dynamic.



Field Description

In Binary mode, the binary content is read. The encoding used for parsing thecontent is either the value specified in the forceEncoding input item, theencoding specified in the XML header or the xmlBinary input item, or UTF-8 (thedefault encoding, 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 mappingto supply the correct type of input at run time.

ValidateOutput

When selected, specifies that the output of the activity should be validatedagainst the schema specified in the Output Editor tab.

Description

Provide a short description for the Parse XML activity.

Output Editor

Use the Output Editor tab to define a schema for the XML output.

Input



xmlString string The XML string to parse.

This input element is available when the Input Stylefield in the General tab is set to Text.

xmlBinary complex Available when you set the Input Style field in theGeneral tab to Binary.

This input item contains a required bytes item for




which you specify the input XML bytes.

This input item also contains an optionalforceEncoding item. This specifies the encoding touse when parsing the XML. If this element is notspecified, the encoding specified in the XML header ofthe byte element is used to parse the XML. If theencoding value is not specified in the XML header, thedefault encoding (UTF-8) is used.

xmlBinary|xmlString choice Available when the Input Style in the General fieldis set to Dynamic.

You can specify a choice statement and setsubstitution and supply the correct input type at runtime.

Output


OutputItem


XMLSchema

complex The parsed XML schema is the output of this activity. Thecontents of the schema are determined by the schema defined inthe Output Editor tab.

Fault





XMLParseException An exception occurred when parsing the data.

UnsupportedEncodingException An unsupported encoding was specified in theforceEncoding input item.

MissingByteCountException An exception occurred while parsing the data with aninvalid or missing byte count.

ValidationException The XML data supplied to the parser was invalid withrespect to its governing XML Schema.

Render XMLRender XML is a synchronous activity that takes an instance of an XML schema elementand renders it as a stream of bytes containing XML or an XML string.

The Render XML activity takes an instance of an XML schema element and renders it as astream of bytes containing XML or an XML string. The schema is processed based on theXSD 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 berepresented by the Render XML activity as 2002-02-10T14:55:31.112Z

General





Description

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

Output Style No Specifies whether the output should be text or binarydata.

Validate Input No When selected, specifies that the data input to theactivity should be validated against the schemaspecified in the Input Editor tab.


Format UsingDefaultNamespacePrefix

No Prepends the namespace with the default namespaceprefix.

Disable PrettyPrint

No Returns output data in the form of non formattedXML.


Suppress XMLDeclaration

No Removes XML declaration in the beginning of a XMLdocument of the form <?xml version = "1.0" encoding ="UTF-8" standalone = "no" ?>.


Encoding Yes This field is visible only when the Output Style fieldis first set to Binary, then set to Text. This fieldspecifies the encoding value to place into the XMLheader of the rendered XML data.

You can specify any valid XML encoding value listed inIANA-Charsets.



Description

Provide a short description for the Render XML activity.

Advanced

Click the Advanced tab and specify which elements in the input schema can containCDATA sections. Using CDATA sections you can enclose text within an element that shouldnot be treated as XML.

Click the Add button to add elements of the input schema to the list. When you click theAdd button, a dialog displays. Using this dialog locates and selects the input schema bylocation in the project or by namespace. Use the By Location tab if your input schema islocated in the project directory. Use the By Namespace tab if you constructed the inputschema on the Input Editor tab.

Use the X button to remove the elements from the list and the up and down arrows tomove elements in the list.

Input Editor

From the Input Editor tab, you can define a schema for the incoming XML data you wantto 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 headerin the rendered XML output. This is also the encoding used toencode the binary data. If this item is not specified, the defaultencoding of the java virtual machine used by the process engineis used to encode the binary data. This value may not be a validXML encoding.



Input Item Type Description

You can specify any valid XML encoding value listed in IANA-Charset. For a complete list, refer tohttp://www.iana.org/assignments/character-sets. The encodingnames are case sensitive.

XML Schema string The XML schema to render. The contents of the schema aredetermined by 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 theGeneral tab. This item contains a stream of bytes representing therendered XML.

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



XMLRenderException An exception occurred when rendering the data.

UnsupportedEncodingException An unsupported encoding was specified in thebyteEncoding input item.

http://www.iana.org/assignments/character-sets




MissingByteCountException An exception occurred while rendering the data with aninvalid or missing byte count.

Transform XMLTransform XML is a synchronous activity that invokes the built-in XSLT processor to applyan XSLT stylesheet to an XML source document and produce a result document.

Normally, transformation of data occurs by mapping process variables to an activity's inputand applying XPath expression to perform any transformation. If you have an XSLT file thatyou are using for transformation, or if an outside source supplies an XSLT file, this activityhelps you to use the XSLT file instead of manually creating the mappings.

For more information about creating and editing XSLT files, see the XSLT specifications athttp://www.w3.org/TR/xslt.

General



Description

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

Stylesheet Yes The XSLT file shared configuration resource to usewhen transforming the XML. You can also specify anXSLT stylesheet in the stylesheet input element, ifdesired. Stylesheets specified in the activity inputoverride the stylesheet specified in this field.

Disable No Returns output data in the form of non formatted XML.

http://www.w3.org/TR/xslt




Description

Pretty Print By default, the check box is clear.

Input andOutput Style

No Specifies whether the input and output is Text orBinary.

Description

Provide a short description for the Transform XML activity.

Input



xmlString text orbinary

The XML to transform. If the Input and Output Style isset to binary, this element is named xmlBytesIn. If theInput and Output Style is set to text, this element isnamed xmlString.

styleSheet string This optional element contains the XSLT stylesheet to useto transform the XML input. This stylesheet overrides thestylesheet specified in the styleSheet field in the Generaltab.

parameter complex This repeating element contains the input parameters forthe stylesheet.

Each input parameter is specified as name/value pairs.The name is a string that corresponds to the name of theparameter specified in the XSLT stylesheet parameter list.

name string The name of the stylesheet input parameters.




value string The value to supply for the specified stylesheet inputparameters.

isXMLDocument boolean Specifies whether the parameter is an XML document.

Output


OutputItem


xmlString text orbinary

A binary or text value.

The element is named xmlString and is of type Text when youselect Text for the Input and Output Style on the General tab.The element is named xmlOutput and is of type binary whenyou select Binary for the Input and Output Style on theGeneral tab.

Fault



XMLTransformException An exception occurred when transforming the data.

UnsupportedEncodingException Data was supplied that is encoded in an unsupportedencoding.

MissingByteCountException An exception occurred while transforming the data withan invalid or missing byte count.


554 | Activity Icons Reference

Activity Icons ReferenceThis section gives you a list of the palettes and activities available in TIBCO Business Studiofor BusinessWorks.

Basic Activities Palette

Critical Section

Throw

For Each Iterate

Repeat Repeat on Error Scope While

Constructor

Compensate Empty

End

Exit Get Context Invoke Rethrow

Receive ReplySet Context

Start



Basic Activities Palette

Set EPR

General Activities Palette

Assign Call Process

Confirm Get Shared Variable

Inspector Log MapperNotify

.On Notification Timeout Receive NotificationSet Shared Variable Sleep

TimerWait For Notification



HTTP Palette

HTTP Receiver Send HTTP Request Send HTTP Response

Java Palette

JAVA Invoke Java Process Starter Java To XML XML To Java

JDBC Palette

JDBC Call Procedure JDBC Query JDBC Update SQL Direct

JMS Palette

Get JMS QueueMessage

JMS Receive Message JMS SendMessage

Reply to JMSMessage



JMS Palette

JMS Request Reply

Mail Palette

Receive Mail Send Mail

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


558 | TIBCO Documentation and Support Services

TIBCO Documentation and Support ServicesFor information about this product, you can read the documentation, contact TIBCOSupport, and join TIBCO Community.

How to Access TIBCO Documentation

Documentation for TIBCO products is available on the TIBCO Product Documentationwebsite, mainly in HTML and PDF formats.

The TIBCO Product Documentation website is updated frequently and is more current thanany other documentation included with the product. To access the latest documentation,visit https://docs.tibco.com.

Product-Specific Documentation

Documentation for TIBCO ActiveMatrix BusinessWorks™ is available on the TIBCOActiveMatrix BusinessWorks™ Product Documentation page.

To directly access documentation for this product, double-click the following file:

TIBCO_HOME/release_notes/TIB_BW_6.8.1_docinfo.html where TIBCO_HOME is the top-leveldirectory in which TIBCO products are installed. On Windows, the default TIBCO_HOME isC:\tibco. On UNIX systems, the default TIBCO_HOME is /opt/tibco.

The following documentation for this product is available on the TIBCO ActiveMatrixBusinessWorks™ page:

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

l TIBCO ActiveMatrix BusinessWorks™ Release Notes

l TIBCO ActiveMatrix BusinessWorks™ Installation

l TIBCO ActiveMatrix BusinessWorks™ Application Development

l TIBCO ActiveMatrix BusinessWorks™ Bindings and Palettes Reference

l TIBCO ActiveMatrix BusinessWorks™ Concepts

l TIBCO ActiveMatrix BusinessWorks™ Error Codes


https://docs.tibco.com/products/tibco-activematrix-businessworks





559 | TIBCO Documentation and Support Services

l TIBCO ActiveMatrix BusinessWorks™ Getting Started

l TIBCO ActiveMatrix BusinessWorks™ Migration

l TIBCO ActiveMatrix BusinessWorks™ Performance Benchmarking and Tuning

l TIBCO ActiveMatrix BusinessWorks™ REST Implementation

l TIBCO ActiveMatrix BusinessWorks™ Refactoring Best Practices

l TIBCO ActiveMatrix BusinessWorks™ Samples

How to Contact TIBCO Support

You can contact TIBCO Support in the following ways:

l For an overview of TIBCO Support, visit http://www.tibco.com/services/support.

l For accessing the Support Knowledge Base and getting personalized content aboutproducts you are interested in, visit the TIBCO Support portal athttps://support.tibco.com.

l For creating a Support case, you must have a valid maintenance or support contractwith TIBCO. You also need a user name and password to log in tohttps://support.tibco.com. If you do not have a user name, you can request one byclicking Register on the website.

How to Join TIBCO Community

TIBCO Community is the official channel for TIBCO customers, partners, and employeesubject matter experts to share and access their collective experience. TIBCO Communityoffers access to Q&A forums, product wikis, and best practices. It also offers access toextensions, adapters, solution accelerators, and tools that extend and enable customers togain full value from TIBCO products. In addition, users can submit and vote on featurerequests from within the TIBCO Ideas Portal. For a free registration, go tohttps://community.tibco.com.

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

https://support.tibco.com/

https://support.tibco.com/

https://ideas.tibco.com/

https://community.tibco.com/


560 | Legal and Third-Party Notices

Legal and Third-Party NoticesSOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDEDOR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITEDADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLEDSOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FORANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF ALICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENTWHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH ISDUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT ORCLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OFTHE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THESAME.

This document is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, the TIBCO logo, the TIBCO O logo, ActiveMatrix BusinessWorks, ActiveSpaces, Business Studio,TIBCO Business Studio, TIBCO Designer, TIBCO Enterprise Administrator, Enterprise Message Service,Rendezvous, and TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCOSoftware Inc. in the United States and/or other countries.

Java and all Java based trademarks and logos are trademarks or registered trademarks of Oracleand/or its affiliates.

This document includes fonts that are licensed under the SIL Open Font License, Version 1.1, which isavailable at: https://scripts.sil.org/OFL

Copyright (c) Paul D. Hunt, with Reserved Font Name Source Sans Pro and Source Code Pro.

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

This software may be available on multiple operating systems. However, not all operating systemplatforms for a specific software version are released at the same time. See the readme file for theavailability of this software version on a specific operating system platform.

https://scripts.sil.org/OFL


561 | Legal and Third-Party Notices

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

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGESARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATEDIN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/ORCHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANYTIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY ORINDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUTNOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.

This and other products of TIBCO Software Inc. may be covered by registered patents. Please refer toTIBCO's Virtual Patent Marking document (https://www.tibco.com/patents) for details.

Copyright © 2015-2022. TIBCO Software Inc. All Rights Reserved.

https://www.tibco.com/patents

TIBCO ActiveMatrix BusinessWorks™ Binding & Pallete ...

Documents

Transcript of TIBCO ActiveMatrix BusinessWorks™ Binding & Pallete ...