Professional Documents
Culture Documents
Palette Reference
Software Release 2.0.0
November 2002
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE.
THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY
ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT,
THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING
DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE
TIBCO BUSINESSWORKS CONCEPTS). USE OF THIS DOCUMENT IS SUBJECT TO THOSE
TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE
OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright
laws and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
Technologies described herein are covered by existing patents and pending patent applications.
TIBCO technology is protected under US patent number 6,003,011.
TIB, TIBCO, Information Bus, The Power of Now, TIBCO Rendezvous, TIBCO AlertServer, TIBCO
Adapter SDK, TIBCO AdapterAdministrator, TIBCO Repository, and TIBCO Hawk are either
registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other
countries.
EJB, J2EE, JMS and all Java-based trademarks and logos are trademarks or registered trademarks of
Sun Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of
their respective owners and are mentioned for identification purposes only.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
Copyright © 2001-2002 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
TIBCO BusinessWorks Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Other Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxi
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Figures
Tables
Preface
Topics
Related Documentation
Other Documentation
TIBCO BusinessWorks is bundled with other products. You will therefore find the
documentation for those products useful:
• TIBCO Designer documentation. TIBCO Designer is an easy to use graphical
user interface for design-time configuration of TIBCO applications. TIBCO
Designer includes online help for each palette.
• TIBCO Administrator documentation. TIBCO Administrator is the
monitoring and managing interface for new-generation TIBCO products such
as TIBCO BusinessWorks.
• TIBCO Adapter product documentation
For comments or problems with this manual or the software it addresses, please
contact TIBCO Product Support at:
http://support.tibco.com
Entry to this site requires a username and password. If you do not have a
username, you can request one. You must have a valid maintenance or support
contract to use this site.
The Deployment palette contains resources for deploying your project to its
intended environment. See TIBCO BusinessWorks Concepts for more information
on deployment concepts and see TIBCO BusinessWorks Process Design Guide for
more information on how to deploy a project.
This chapter describes the resources available in the Deployment palette.
Topics
Deployment Configuration
You can have only one deployment configuration per project, but the
configuration can describe any number of machines and components to run.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the deployment
within TIBCO Designer and the TIBCO Administrator
GUI.
Variables button Allows you to view and change the global variables
defined for this project.
Machine
Once you create a deployment configuration, you can drag and drop machine
resources into the deployment. You can have as many machines as there are in
your TIBCO administration domain. You can only configure one copy of each
machine.
Initially, only the Machine field is shown. Once you select a machine from the
drop-down list and click the Apply button, the other fields on the dialog are
shown.
Configuration
The configuration tab has the following fields. None of these fields are editable.
Field Description
Machine A selection list of the available machines in the
administration domain. You can configure each
machine once.
Note: Once a machine is configured, you can change
the configuration, but you can add a machine to the
deployment only once.
Installed Components
The installed components tab describes the components installed on the machine.
Field Description
Installed Component Name of the installed component. This list contains all
of the TIBCO adapter products and TIBCO
BusinessWorks products installed on the machine.
Monitor
The Monitor resource allows you to create conditions for monitoring the
machine’s CPU, disk, and process usage. You access the Monitor resource by
clicking on a Machine resource in the deployment configuration, then click on the
"Monitor" tab above the palette panel. You can then drag and drop monitors into
the machine resource.
Once you drag and drop a monitor into a machine, you must choose what type of
monitor it is: CPU, Disk, or Process. Each type of monitor has its own tab for
specifying the condition to monitor. For example, in a CPU monitor, you can
specify a condition of the machine’s CPU usage is over 80%.
You can create more than one monitor of each type. Each monitor you create will
monitor for the specified condition, and the actions placed within the monitor are
taken when the condition is reached. You can double click on a Monitor resource
in the design panel to open it, and then you can place any of the following actions
to take into the monitor:
• Alert — send an alert to the administration server.
• Email — send an email to a user or list of users.
• Custom — execute an operating system command or script.
Example
You may have the following rules in your organization:
• If the CPU usage goes above 80%, send an email to the operations supervisor
and an alert to the administration server.
• If the CPU usage goes above 98%, reboot the machine.
• If the disk usage goes above 85%, execute a script that writes a form for
ordering more disks and send an email to the operations supervisor.
• If there are more than 75 processes on the machine, execute commands to kill
some of the running processes.
To implement those rules, follow this procedure:
1. Select the machine on which to implement the rules within a deployment
configuration in the project panel.
2. Click on the Monitor tab and drag a Monitor resource from the palette panel
to the design panel.
3. In the Monitoring Type field, select CPU.
Configuration
The configuration tab has the following fields.
Field Description
Monitoring Type The type of the monitor. The monitor can be one of the
following types, each type corresponds to an aspect of
the machine you wish to monitor:
• CPU
• Disk
• Process
CPU
The CPU tab is available for monitors of type CPU and has the following fields.
Field Description
Processor The numeric identifier of the processor on the
machine you wish to monitor. For machines with
multiple CPUs, the first processor is zero, and
subsequent processors are numbered sequentially.
CPU Usage The condition you wish to monitor. You can specify
either equal to, not equal to, greater than, greater than
or equal to, less than, or less than or equal to as the
condition. You then must specify a percentage value
for the CPU usage.
For example, you can specify greater than 95%, which
means the actions specified for the monitor will be
taken when the CPU usage is greater than 95%.
Disk
The Disk tab is available for monitors of type Disk and has the following fields.
Field Description
Logical Disk The numeric identifier of the disk on the machine you
wish to monitor. For machines with multiple disks,
the first disk is zero, and subsequent disks are
numbered sequentially.
Disk Usage The condition you wish to monitor. You can specify
either equal to, not equal to, greater than, greater than
or equal to, less than, or less than or equal to as the
condition. You then must specify a percentage value
for the disk usage.
For example, you can specify greater than 95%, which
means the actions specified for the monitor will be
taken when the disk usage is greater than 95%.
Process
The Process tab is available for monitors of type Process and has the following
fields.
Field Description
Process Count The condition you wish to monitor. You can specify
either equal to, not equal to, greater than, greater than
or equal to, less than, or less than or equal to as the
condition. You then must specify the limiting number
for the total number of processes executing on the
machine.
Note that this number does not refer to TIBCO
BusinessWorks processes but to machine processes.
For example, you can specify greater than 128, which
means the actions specified for the monitor will be
taken when the number of processes executing on the
machine is greater than 128.
Process Engine
Configuration
The Configuration tab has the following fields.
Field Description
Name The name of the process engine. Give a unique name to each
process engine in your deployment configuration.
TIBCO User ID under which the process engine should run on the
Username machine.
This user must have been defined in the TIBCO
Administrator user management module and have
appropriate privileges. See TIBCO BusinessWorks
Administrator’s Guide for more information.
Field Description
Is Master Specifies whether the process engine is the master or a
(Secondary if secondary engine in the fault-tolerant group. There can be
Unchecked) only one master process engine in a fault-tolerant group.
View Command Allows you to view the command that will be used to start
Button the process engine. This command is view-only and not
available for editing.
Process Definitions
The Process Definitions tab contains a list of the process definitions that this
engine will load. By default, the "Select All" checkbox is checked, and all process
definitions are loaded.
To load a specific process model or set of models, uncheck the "Select All"
checkbox and use the Browse Resources button at the top of the tab. When
specific process definitions are loaded, the engine can then only create process
instances of the specified process definitions.
Only process models with process starters can be loaded. All subprocesses called
by the loaded process are automatically loaded. See TIBCO BusinessWorks Process
Design Guide for more information about process starters and subprocesses.
You can also modify or delete any loaded process models with the Modify and
Delete buttons.
The process definitions tab is a table of process models. The table has the
following column.
Column Description
Enabled Enables the process definition upon startup.
Column Description
Process Starter The name of the process starter for the process
definition.
Recovery
The Recovery tab has the following fields.
Field Description
Reset Failure Count Specifies how many failures occur before the failure
count is reset to zero.
You can specify actions to perform on the first, second,
subsequent (any after the second), or any (all) failures.
Setting this field allows you to reset the failure count
to zero after a specified number of failures. For
example, after the fifth failure, you may wish to return
to the actions performed for the first failure.
See Any Failure on page 20 and Component failure
event on page 21 for more information about
specifying actions to perform upon failure.
Reset Failure Interval Specifies the time (in seconds or minutes) to elapse
before the failure count is reset to zero.
For example, you may wish to set the failure count to
zero each day, so that the first failure of the day causes
one set of actions to be performed, and any
subsequent failures result in a different set of actions.
Advanced
The Advanced tab has the following fields.
Field Description
Thread Count This specifies the number of active threads to use for
executing process instances. The number of threads
effectively limits the number of process instances
that can be executing concurrently.
Set this to a value that is appropriate for your
operating system and your physical machine
configuration.
Default is 8.
Field Description
Max Log Files Specifies the maximum number of log files to use.
When log files reach the size specified in the Max
Log File Size field, the engine switches to the next
log file. When the maximum number of log files
have been written, the engine begins writing to the
first log file again.
Max Log File Size (KB) Specifies the maximum size (in Kilobytes) a log file
can reach before the engine switches to the next log
file.
Use Database for When checked, this field specifies that process
Storage (File if engine information (for example, checkpoint data
Unchecked) and other configuration information) should be
stored in a database. If this field is unchecked, the
process engine stores the information in files.
Checking this field allows the information to be
shared among all process engines that specify the
same JDBC Connection. There are several
advantages to using a database for process engine
storage. See TIBCO BusinessWorks Process Design
Guide for more information about specifying process
engine storage.
Java
The Java tab has the following fields.
Field Description
Extra ClassPath The items you supply here are prepended to your
CLASSPATH environment variable. You may specify
a Java code editor, or the jar file from a JNDI provider
if you wish to use TIBCO BusinessWorks to receive
and process JMS messages.
Field Description
Initial JVM Size Initial size for the JVM used for the process engine.
Default is 32 MB.
Maximum JVM Size Maximum size for the JVM used for the process
engine. Default is 128 MB.
Thread Stack Size Size for the thread stack. Default is 128 KB.
Custom
The Custom tab allows you to specify custom properties for the process engine.
These properties are used in specific circumstances, and only under the direction
of TIBCO Support. Do not attempt to add or modify custom properties unless
specifically told to do so by TIBCO Support.
Fault Tolerance
The Fault Tolerance tab allows you to specify the fault-tolerance characteristics of
the process engine.
Field Description
Member Weight of Specifies the setting for the member weight of this
Master/Secondary as a: process engine. The possible values are:
• Peer — specifies a constant weight for all
engines. If all engines are specified as peers, a
random secondary is selected in the event of a
failure. Also, when a peer takes over during
failover, the peer becomes the master until it
experiences a failure.
• Primary — only available for the master engine.
Specifies the weight of the master.
• Secondary — specifies this secondary engine as
a lower weight than the engines specified as
"peer". Secondary engines resume operation
during a failover until the master engine is once
again available. Once the master engine is
available, the secondary engine shuts down and
the master engine starts up.
• Custom — signifies that you want to specify a
custom value in the Member Weight field. The
Member Weight field is only available when the
Advanced field is checked.
Field Description
Activation Interval (ms) Secondary process engines track heartbeat
messages from the master engine. This field
specifies the amount of time since the last heartbeat
from the master that before the secondary restarts
the process starters and process instances.
Member Weight The weight of the member. The engine with the
highest weight is the master engine. You can only
edit this field if you specify Custom in the first field
on this tab.
Adapter
You can use the Adapter resource inside the Machine resource to specify that one
or more adapters should run on that machine, and configure the adapter
instance(s).
Adapter instances are operating system processes that execute pre-configured
adapter services. See your adapter documentation for more information about
configuring adapter services and runtime adapter instances.
Configuration
The configuration tab has the following fields.
Field Description
Name The name of the adapter instance.
Field Description
User ID User ID under which the process engine should run
on the machine.
This user must have been defined by way of the
TIBCO Administrator user management module have
appropriate privileges. See TIBCO BusinessWorks
Administrator’s Guide for more information about
creating and managing users.
View Command Allows you to view the command that will be used to
start the process engine. This command is view-only
and not available for editing.
Recovery
The recovery tab has the following fields.
Field Description
Reset Failure Count Specifies how many failures occur before the failure
count is reset to zero.
You can specify actions to perform on the first, second,
subsequent (any after the second), or any (all) failures.
Setting this field allows you to reset the failure count
to zero after a specified number of failures. For
example, after the fifth failure, you may wish to return
to the actions performed for the first failure.
See Any Failure on page 20 and Component failure
event on page 21 for more information about
specifying actions to perform upon failure.
Field Description
Reset Failure Interval Specifies the time (in seconds or minutes) to elapse
before the failure count is reset to zero.
For example, you may wish to set the failure count to
zero each day, so that the first failure of the day causes
one set of actions to be performed, and any
subsequent failures have a different set of actions.
Custom
The custom tab allows you to specify custom properties for the adapter. See the
adapter manual for more information about properties you can add on the
custom tab.
Any Failure
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the failure
resource.
Only actual failures are counted by the failure count. Manually stopping and
restarting the process is not considered a failure.
You specify the actions to take by dragging and dropping one of the following
actions into the Component failure event resource. The Component failure event
resource is like a folder, because it can hold multiple actions.
• Restart — Restart the process engine or adapter instance.
• Alert — Send an alert to the administration server.
• Email — Send an email to a specified user.
• Custom — Perform an operating system command.
Configuration
The configuration tab has the following fields.
Field Description
Failure Type The type of failure that occurred. This can be one of
the following:
• First Failure
• Second Failure
• Subsequent Failure
You can have only one resource for each type of
failure. Once the failure type is set, the Name and
description fields appear.
Log Event
You specify the actions to take by dragging and dropping one of the following
actions into the Log Event resource. The Log Event resource is like a folder,
because it can hold multiple actions.
• Alert — Send an alert to the administration server.
• Email — Send an email to a specified user.
• Custom — Perform an operating system command.
If you are using an Alert as the log event, you can use the variable ${nextLine}
in the Alert’s message field. In this case, ${nextLine} is replaced by the text of a
new line as it is added to the log.
For example, assume you specify a Log Event and use an alert which uses
Log:${nextLine} in the message. If logfile has the following text appended to it:
"Error 1351 - message expired"
then the following LogEvent message will appear in the TIBCO Administrator
GUI:
"Log Error 1351 - message expired"
If you use ${nextLine}, each log event is considered a separate event and is sent
even if Once is selected as the Performance Policy.
Restart
The Restart resource specifies that the process engine or adapter instance should
be restarted in the event of a failure.
You can drag and drop this resource into the Any Failure resource or one of the
Component failure event resources within a Process Engine or Adapter in a
deployment configuration. When the specified failure occurs, the machine is
restarted.
Configuration
The configuration tab has the following fields.
Field Description
Name The name of the resource. This name is fixed as
"Restart".
Alert
The Alert resource specifies that an alert should be sent to the administration
server.
You can drag and drop this resource into the following resources:
• Any Failure
• Component failure event
• Suspend Process Event
• Log Event
• Monitor
When the condition of the resource occurs (for example, a process instance is
suspended or a Monitor condition is met), the alert is sent and is displayed in the
TIBCO Administrator interface.
Configuration
The configuration tab has the following fields.
Field Description
Name The name of the resource. This name is fixed as
"Alert".
Perform Policy Frequency of the alert. If you choose Once, the action
is performed only once even if the condition for the
event is met multiple times. If you choose Always,
multiple alerts are sent.
Choosing Always is useful for situations where the
alert does not become visible because the refresh rate
of TIBCO Administrator is 30 seconds.
Field Description
Level The alert level of the alert to send. This level appears
in the TIBCO Administrator interface. The level can be
one of the following:
• High
• Medium
• Low
The Email resource specifies that an email should be sent to the specified user(s).
You can drag and drop this resource into the following resources:
• Any Failure
• Component failure event
• Suspend Process Event
• Log Event
• Monitor
When the condition of the resource occurs (for example, a process instance is
suspended or a Monitor condition is met), the alert is sent and is displayed in the
TIBCO Administrator interface.
Configuration
The configuration tab has the following fields.
Field Description
Name The name of the resource. This name is fixed as
"Email".
Perform Policy Frequency of the email. If you choose Once, one email
is sent even if the condition for the event is met
multiple times. If you choose Always, multiple emails
are sent.
SMTP Server The mail server to use to send the message. You may
specify the host name or the host IP address.
Custom
Configuration
The configuration tab has the following fields.
Field Description
Name The name of the resource. This name is fixed as
"Custom".
Topics
Process Definition
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the process.
Custom Icon File You can chose your own custom icon for the process,
if you desire. Use the Browse button to locate an
image file (GIF, JPEG, and so on) to use as the icon for
this process.
You can use these activities to communicate with adapters that are supported by
TIBCO BusinessWorks. See your adapter documentation for information on
whether BusinessWorks is supported.
Topics
Application
Adapter
Request-
Response
Invocation
Service
Request
Business Process
Adapter
Request-
Response
Server
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
The advanced tab has the following fields.
Field Description
Client The publisher for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Output
The output for the activity is the following.
Adapter Subscriber
Application
Adapter
Publishing
Service
Publish
Business Process
Adapter
Subscriber
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
Field Description
Publisher The publisher for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Output
The output for the activity is the following.
Application
Adapter
Request-
Response
Service
Request
Business Process
Invoke an Adapter
Request-Response
Service
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Field Description
Description Short description of the activity.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
The advanced tab has the following fields.
Field Description
Server The server for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Publish to Adapter
Application
Adapter
Subscription
Service
Publish
Business Process
Publish to
Adapter
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
Field Description
Subscriber The subscriber for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
This activity produces no output.
Application
Adapter
Request-
Response
Invocation
Service
Reply
Business Process
Respond to Adapter
Request
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Reply For Drop-down list of activities that this activity can send
a response for.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
This activity produces no output.
Waits for the receipt of a message from the publication service of the
specified adapter.
Publication services are configured during adapter configuration,
and the activity uses the information in the adapter configuration to
fill in most of the fields of this activity. See your adapter
documentation for more information about creating adapter configurations and
creating adapter publication services.
Figure 6 illustrates an adapter publishing service publishing a message and the
Wait for Adapter Message activity receiving the message within a business
process.
Application
Adapter
Publishing
Service
Publish
Business Process
Wait for
Adapter
Message
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
Field Description
Publisher The publisher for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming
message. This expression should evaluate to a string
and it is compared to the "key" field of the activity’s
input. If the Candidate Event Key and the activity’s
key match, then the process accepts the incoming
message.
For example, you may have a Publish to Adapter
activity that sends a message with a particular ID.
You are expecting a reply message that contains that
same ID so that you can determine the message is a
response to your sent message. You would specify
the field of the incoming message that contains your
ID in the Candidate Event Key. You would then use
the message ID of the message you sent earlier in the
process as the "key" field in the input.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For Adapter Message activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Application
Adapter
Request-
Response
Invocation
Service
Request
Business Process
Wait for
Adapter
Request
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Advanced
The advanced tab lists information based on the Adapter Service selected on the
Configuration tab. This information is supplied when the adapter configuration is
created. You should not normally need to change information on the advanced
tab. See your adapter documentation for more information on these fields.
Field Description
Client The server for the specified Adapter Service.
RV Session
The RV Session tab allows you to override any of the TIBCO Rendezvous session
parameters for the specified adapter service. See your adapter documentation for
more information about TIBCO Rendezvous session parameters.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming
message. This expression should evaluate to a string
and it is compared to the "key" field of the activity’s
input. If the Candidate Event Key and the activity’s
key match, then the process accepts the incoming
message.
For example, you may have a Invoke an Adapter
Request-Response activity that sends a request with
a particular ID. You are expecting a response
message that contains that same ID so that you can
determine the message is a response to your sent
message. You would specify the field of the
incoming reply that contains your ID in the
Candidate Event Key. You would then use the
message ID of the request you sent earlier in the
process as the "key" field in the input.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For Adapter Request activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The BusinessConnect palette contains activities for creating a private process that
interacts with a TIBCO BusinessConnect server. This chapter assumes that you are
familiar with the concepts and features of TIBCO BusinessConnect. See the
TIBCO BusinessConnect documentation for more information.
Topics
Using TIBCO BusinessWorks, you can create process definitions that serve as
private processes for a TIBCO BusinessConnect installation. TIBCO
BusinessWorks can either send requests by way of a TIBCO BusinessConnect
server, or receive replies from a TIBCO BusinessConnect server. Figure 8
illustrates TIBCO BusinessWorks operating in conjunction with TIBCO
BusinessConnect.
Company A
Private Process
Outbound Request
TIBCO BusinessWorks
Internet
Company B
Private Process
Inbound Request
TIBCO BusinessWorks
Receive Request/
Notification
TIBCO
Legend BusinessConnect
Reply
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
This activity requires no input.
Output
The output tab lists output schema information. The schema that displays is
based on the input of the message selected in the Configuration tab for this
process starter.
Receive Request/Notification
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
This activity requires no input.
Output
The output tab lists output schema information. The schema that displays is
based on the input of the operation selected in the Configuration tab for this
activity.
Receive Response
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
The input tab lists input schema information. The schema that displays is based
on the input of the operation selected in the Configuration tab for this activity.
Output
The output tab lists output schema information. The schema that displays is
based on the output of the operation selected in the Configuration tab for this
activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
The input tab lists input schema information. The schema that displays is based
on the input of the miscellaneous message selected in the Configuration tab for
this activity.
Output
The output tab lists output schema information. The schema that displays is
based on the input of the message selected in the Configuration tab for this
activity.
Send Request/Notification
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Field Description
Server Details The BusinessConnect Connection shared
configuration resource used to connect to the TIBCO
BusinessConnect server. See BusinessConnect
Connection on page 302 for more information.
Wait for Response Specifies that the activity should wait for a response
from the TIBCO BusinessConnect server.
Response Wait Time Specifies the amount of time to wait for a response
from the TIBCO BusinessConnect server. This field
only appears when the Wait for Response field is
checked.
Input
The input tab lists input schema information. The schema that displays is based
on the input of the operation selected in the Configuration tab for this activity.
Output
The output tab lists output schema information. This is used only for a
synchronous request/reply operation. The schema that displays is based on the
output of the operation selected in the Configuration tab for this activity.
Send Response
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
The input tab lists input schema information. The schema that displays is based
on the input of the operation selected in the Configuration tab for this activity.
Output
This activity produces no output.
Topics
FTP Get
The FTP Get activity issues an FTP get command to the specified server.
The file content is retrieved into a process variable, but you can write the
file to the local disk as well by checking the Write Data to Local File field
on the Configuration tab.
The following sections describe the fields on the tabs of the FTP Get activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Write Data to Local Specifies that you would like to write contents of the
File file retrieved from the FTP server to a file on the local
disk.
Timeout (msec) Time to wait (in milliseconds) for the FTP command
to complete. An error is returned if the command
does not finish before the specified time.
The default timeout is 120000 (two minutes). The
maximum time you can specify for the timeout is
3600000 (1 hour).
Field Description
Firewall Indicates whether the FTP server resides inside or
outside of a firewall relative to the location of the
TIBCO BusinessWorks process engine. If checked, the
FTP server resides outside a firewall, and therefore
the Proxy fields must be specified.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
FTP Put
The FTP Put activity issues an FTP put command to the specified server.
The content of the file to put onto the remote server can be either read
from a file on the local disk or it can be supplied in a process variable
and mapped to the BinaryData or ASCIIData input items for this
activity.
The following sections describe the fields on the tabs of the FTP Put activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
FTP Shared Path to the shared configuration resource containing
Connection the user information such as host name, user name,
and password. See FTP Connection on page 308 for
more information about FTP resources.
Timeout (msec) Time to wait (in milliseconds) for the FTP command
to complete. An error is returned if the command
does not finish before the specified time.
The default timeout is 120000 (two minutes). The
maximum time you can specify for the timeout is
3600000 (1 hour).
Get Data from Disk Specifies that you will supply the path and name of a
file on the local disk to use in the FTP Put command.
If no local file is specified, you can supply the file’s
data to the ASCIIData or BinaryData input items.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The file palette is used to read, write, delete, or create files. This palette also has a
process starter that allows you to poll for files and start a process based on the
presence of a file.
Topics
Create File
The Create File activity creates a new file with the specified file name
and contents. The following sections describe the fields on the tabs of
the Create File activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
File Poller
The File Poller process starter polls for files or directories with the given
name and starts a process when a change (creation, modification,
deletion) is detected.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
File Name The path and name of the file or directory to monitor.
Use the Browse button to locate an existing file.
You can also use wildcards to monitor a directory for
files that match the given specification. For example,
"C:\files\*.log" would match any change to a file
in the "files" directory whose extension is ".log".
Polling Interval (sec) Polling interval (in seconds) to check for the specified
file.
Include Existing Files Check for the file among the files that existed before
the process engine started running.
When this field is checked, if an existing file matches
the specification in the File Name field when a
process engine starts, then a new process instance is
created.
If this field is not checked, any existing files that
match the specification in the File Name field are
ignored until there is some change in the file.
Exclude File Content Do not load the data from the file into this activity’s
output. If this checkbox is selected, the contents of the
file are not available to subsequent activities in the
process definition.
Output
The output for the activity is the following.
Read File
The Read File activity is used to read a file and place its contents into
the process’ available data.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Exclude File Content Do not load the data from the file into this activity’s
output. If this checkbox is selected, the contents of the
file are not available to subsequent activities in the
process definition.
Field Description
Read as The type of content in the file. Can be either text or
binary.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Remove File
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The Wait for File Change activity waits for a file change (creation,
modification, or deletion) to occur during process execution. When this
activity is encountered, the process instance is suspended and waits for
the specified file to change before resuming.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
File Name The path and name of the file to poll for. You can use
the Browse button to locate an existing file.
You can also use wildcards to monitor a directory for
files that match the given specification. For example,
"C:\files\*.log" would match any change to a file
in the "files" directory whose extension is ".log".
Polling Interval (sec) Polling interval (in seconds) to check for changes in
the specified file.
Include Existing Files Check for the file among the files that existed before
the process engine started running.
When this field is checked, if an existing file matches
the specification in the File Name field when a
process engine starts, then the Wait for File Change
activity accepts that file as changed and proceeds to
the next activity.
If this field is not checked, any existing files that
match the specification in the File Name field are
ignored until there is some change in the file.
Exclude File Content Do not load the data from the file into this activity’s
output. If this checkbox is selected, the contents of the
file are not available to subsequent activities in the
process definition.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming file
change event. This expression should evaluate to a
string and it is compared to the "key" field of the
activity’s input. If the Candidate Event Key and the
activity’s key match, then the process accepts the
incoming file change event.
For example, you may have created a file earlier in
the process and you may want to wait for an
external application to modify the file. When the
external application modifies the file, it appends the
word "Changed" to the filename to signify the file is
ready for processing.
You should specify the $fileInfo/fileName for the
Candidate Event Key field, and you should specify
concat("$CreateFile/fileName", "Changed")
for the "key" field on the Input tab.
$CreateFile/filename is the name of the file
created earlier in the process. This expression is
specified in XPath, and only data from the incoming
event is available for use in this XPath expression.
See TIBCO BusinessWorks Process Design Guide for
more information about XPath expressions.
Event Timeout (msec) A file change may occur before this activity is
executed. This field specifies the amount of time (in
milliseconds) to wait if the file change occurs before
this activity is reached within the process instance. If
the event timeout expires, an error is logged and the
event is discarded
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For File Change activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Write File
The Write File activity writes the desired contents to the specified file.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Topics
Call Process
You should only call processes that have Start activities. It is possible to call
processes that have process starters, but this could cause behavior that you may
not have intended in your process definition.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Process Name The process definition you would like to call. You can
browse the available process definitions.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
Checkpoint
Called Processes
Checkpoints save the state of the entire process instance. By default when a
process calls another process, the subprocess is executed in the same process
instance as the calling process. If the called process spawns a new machine
process, however, the called process is a new process instance.
When a checkpoint occurs in a called process, the checkpoint saves the state of the
current process instance. If no called processes spawn new process instances, then
a checkpoint in any called process saves the state of the process instance,
including state from the parent process(es) of the current process. In the case of a
called process that spawns a new process instance, only the spawned process
instance is saved.
Confirm
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
External Command
Long-Running Commands
If you wish to execute long-running commands (such as daemons), it may not be
practical to execute the command directly. Because the specified command must
terminate before control is passed to the next activity, the process instance must
run until the external command completes. To avoid this problem, you may wish
to create a script that runs the desired commands in the background.
The syntax of executing commands as background processes differs by operating
system. For example, on UNIX, to run a command in the background, you
append the ampersand character (&) to the command. On Microsoft Windows,
you use the START command within a batch file to run a command in a different
process.
After creating a script to run commands in the background, specify the script as
the command to run in the External Command activity. The script runs the
desired command and returns the process ID of the process it started. The return
code of the script is stored in the returnCode item of the External Command
activity’s output.
If you wish to start a long-running command in the background and then later
terminate the background process, you should store the process ID returned by
the script in a file or database table. Another process instance can then read the
process ID and kill the process with the appropriate operating system command
when necessary.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Field Description
Command to Execute The command line to execute. You can also specify
any input and command-line arguments to the
command in this field.
You can specify a global variable for this
configuration field. This allows you to easily specify
different commands on different operating systems.
For example, you may specify
%%EXTERNAL_COMMAND%% as the value for this field.
On MS Windows, the value of the global variable
may be the following:
cmd /c dir
Make Output Available When checked, this field specifies that the output
as Activity Output sent to standard output and standard error by the
command should be available in the output schema
of this activity.
For commands the produce a large amount of
output, it is recommended to uncheck this field and
write the output to a file. This saves memory and
allows you to use other activities (for example Read
File and Parse Data) to handle the output file more
efficiently.
Output Filename Name and location of the file in which to store any
output or errors produced by the command. If this
field is blank, no output file is created.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
Generate Error
... ...
CreditCheck Subprocess
See TIBCO BusinessWorks Process Design Guide for more information about
handling errors in process definitions.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Select Error Schema The process error schema to send to the parent
process. - Default - specifies that the error should be
propagated only in the $_error process variable.
Process error schemas are defined on the Error
Schemas tab of the End activity for the process. The
schema specified in this field is added to the Input
schema for this activity. Data you map to the error
schema is propagated to the parent process.
See TIBCO BusinessWorks Process Design Guide for
more information about specifying process error
schemas.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
Java Code
You can add custom code to your process definition with the Java Code
activity. This activity allows you to write a standard Java class that can
manipulate any of the process data or perform any action you choose.
When you specify input and output parameters for the Java Code
activity, get/set method code is automatically generated for the activity. You can
use that code in your Java class, and it is displayed when you click the Show
Source button on the Code tab.
The Java Code activity automatically creates an invoke() method in which you
should put the code you wish to execute. This method is called when the engine
processes the Java Code activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input Parameters The input parameters for the Java Code activity. These
parameters will appear on the Input tab after they are
specified. Each input parameter has three fields:
• Field Name — Name of the parameter.
• Type — Datatype of the parameter. Specify one of
the supplied Java primitive types, or specify
"Object Reference" if you are accepting a Java
object from another Java Code activity as input.
See Passing Java Objects Between Java Code
Activities on page 104 for more information about
passing Java objects between Java Code activities.
• Required — Whether the parameter is required,
optional, or repeating.
Field Description
Output Parameters The output parameters for the Java Code activity.
These parameters will appear on the Output tab after
they are specified. Each output parameter has three
fields:
• Field Name — Name of the parameter.
• Type — Datatype of the parameter. Specify one of
the supplied Java primitive types, or specify
"Object Reference" if you are accepting a Java
object from another Java Code activity as input.
See Passing Java Objects Between Java Code
Activities on page 104 for more information about
passing Java objects between Java Code activities.
• Required — Whether the parameter is required,
optional, or repeating.
Code
The code tab has the following fields/buttons.
Field/Button Description
Code Body The source code of the Java class. Specify the code you
wish to execute in the automatically generated
invoke() method. The get/set methods for the input
and output parameters are automatically generated
and displayed when you click the Show Source
button.
When the Java code is run by the engine, the
automatically generated get/set methods are called,
then the invoke() method within the Java class is
called.
Field/Button Description
Compile Button Compiles the current source code. JDK 1.3 and 1.3.1
are supported for this release.
After compilation, the source and compiled java code
are placed into the lib/palettes/javaCode
directory within the TIBCO BusinessWorks
installation directory.
View Errors Button Displays the errors encountered when the code was
compiled.
Show Source Button Displays the source code in the editor specified with
the TIBCO Designer preferences. If no editor is
specified, a simple popup editing window is used.
Any objects passed by input and output parameters between Java Code activities
must be serializable.
Figure 10 illustrates two Java code activities. The CreateObject activity creates a
Java object and passes a reference to the object in its output parameter named
out_object. The UseObject activity defines an input parameter named
in_object of type ObjectReference and maps the CreateObject activity’s
output object reference to its input parameter of type ObjectReference.
The UseObejct activity can invoke methods on the input object as it would for any
other object. For example, if you wish to call a method named m1 that returns an
integer, you would use the following code within the UseObject activity:
int(in_object.m1());
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Label
The Label allows you to create a generic label so that you can provide
documentation and comments within your process definition. The Label
is not actually an activity, because you cannot draw transitions to or from
it, and it does not perform any action. You use the label to create a
descriptive tag that you can place anywhere within a process definition.
Configuration
The configuration tab has the following fields.
Field Description
Description Descriptive text that you would like to add to the
label. You can add comments here about the process
diagram. Use this field to provide documentation for
the process.
Label Color Allows you to pick a color for the text of the label. Use
the Color button to bring up the Choose a Label Color
dialog.
Field Description
Label Font Allows you to pick a font for the text of the label. Use
the Choose Font button to bring up the Font Panel
dialog.
Mapper
Output Schema
The Output Schema tab defines the structure of the process variable to add to the
process definition.
You can use a simple datatype, or you can define a group of data elements on this
tab. You can also reference XML schema or ActiveEnterprise classes stored in the
project. Once defined, the data specified on the Output Schema tab becomes the
output schema of the Mapper activity. This data then becomes available to other
activities within the process definition.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is defined by the specified data elements on the Output
Schema tab.
Output
The output for the activity is defined by the specified data elements on the Output
Schema tab.
Notify
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
Null
Receive Notification
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Output
The output for the activity is the following.
Sleep
The Sleep activity suspends the process on the current transition for the
given amount of time. If you have multiple control flows in your
process, only the current execution branch of the process is suspended.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Timer
The Timer process starter starts a process at a specific time. You can also
specify that processes are to be started periodically.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Start Time The day and time to start the process. If the process is
to be run periodically, then the start time indicates the
first time to run the process.
Run once Indicates this process should be run only once at the
day and time indicated by the Start Time field. If
unchecked, the Time Interval and Runs Every fields
appear to allow you to specify the frequency of the
process.
Output
The output for the activity is the following.
Wait
The Wait activity suspends execution of the process instance and waits for
a Notify activity with a matching key to be executed in another process
instance. The key specified in the Notify Configuration specified on the
Configuration tab and the Key field of the Input tab creates a relationship
between the Wait activity and the corresponding Notify activity.
The same Notify Configuration shared configuration resource must be specified
by corresponding Wait and Notify so that data can be passed from the process
instance containing the Notify activity to this process instance. The schema in the
Notify Configuration resource can be empty, if you do not wish to pass data
between processes.
The Wait, Receive Notification, and Notify activities allow running process
instances to communicate. See TIBCO BusinessWorks Process Design Guide for more
information on inter-process communication.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Write To Log
This activity writes a message to the log. The logs are stored within the
TIBCO BusinessWorks installation directory under the logs
subdirectory. There is one log file for each process engine. A process
definition with the Write To Log activity will write a message to the log
of the process engine that is running the process instance corresponding to the
process definition.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
This activity produces no output.
The HTTP palette allows you to send and receive HTTP requests.
Topics
HTTP Receiver
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Parse Post Method Specifies that the attributes of the request should be
Data parsed into a schema tree for the Output tab.
HTTP Authentication Specifies that the client sending the HTTP request
must be authenticated. The user name and password
specified in the incoming request must exist in the
domain (users are created and managed within the
domain using TIBCO Administrator).
Headers
The headers tab describes the data structure for the headers of the HTTP request.
You can use the default structure, or you can alter the structure, if the incoming
request has a specific data structure for the header of the request. This tab uses the
same mechanism described Appendix A, Specifying Data Schema, on page 341 in
to specify the data structure for the headers. See that section for more information
about creating a customized data structure.
Header structure is defined by the HTTP protocol. See the HTTP Protocol
specification for more information about the fields and content of the header of a
HTTP request. You can obtain this specification at www.w3.org.
The default header fields are the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Port The port on the host machine to send the request to.
The default port is 80.
Field Description
Use Proxy Setting Specifies that a proxy server is to be used to gain
access outside of a firewall. The Proxy Configuration
shared configuration resource specifies the
configuration of the proxy server.
User Name (HTTP User name to log onto the HTTP server.
Authentication)
Use Secure Socket Specifies to use the HTTPS (secure socket layer, or
(HTTPS) SSL) for the request. This protocol authenticates the
server to the client, and optionally, the server can
require that the client authenticate itself to the server.
SSL requests require that the client have the
appropriate digital certificate. See the documentation
from your certificate provider for more information
about configuring SSL.
Enabling this field allows you to specify the Trusted
Certificate Location, Client Identity, and Client
Identity Password fields.
For more information about creating keystores for
private keys and trusted certificate chains, see
http://java.sun.com/j2se/1.3/docs/tooldocs/win32
/keytool.html.
Field Description
Trusted Certificate Only available when HTTPS is enabled.
Location
This field specifies the Trusted CA shared
configuration resource. This certificate should contain
the list of certificate authorities the client will accept
for sever certificates. The server’s certificate is
checked against this list, and if the certificate is not
from a listed certificate authority, the connection is
refused.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Reply For The Wait for HTTP Request activity or HTTP Receiver
process starter that received the request. This is a
selection list of available activities that can receive
HTTP requests.
Headers
The headers tab describes the data structure for the headers of the HTTP
response. You can use the default structure, or you can alter the structure, if the
outgoing response has a specific data structure for the header of the request. This
tab uses the same mechanism described Appendix A, Specifying Data Schema, on
page 341 in to specify the data structure for the headers. See that section for more
information about creating a customized data structure.
Header structure is defined by the HTTP protocol. See the HTTP Protocol
specification for more information about the fields and content of the header of a
HTTP request. You can obtain this specification at www.w3.org.
The default header fields are the following.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Parse Post Method Specifies that the attributes of the request should be
Data parsed into a schema tree for the Input tab.
Field Description
Attributes The attributes of the HTTP request. For each attribute,
you must provide a field name, datatype for the field,
and whether the field is required, optional, or
repeating.
Headers
The headers tab describes the data structure for the headers of the HTTP request.
You can use the default structure, or you can alter the structure, if the incoming
request has a specific data structure for the header of the request. This tab uses the
same mechanism described Appendix A, Specifying Data Schema, on page 341 in
to specify the data structure for the headers. See that section for more information
about creating a customized data structure.
Header structure is defined by the HTTP protocol. See the HTTP Protocol
specification for more information about the fields and content of the header of a
HTTP request. You can obtain this specification at www.w3.org.
The default header fields are the following.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming file
change event. This expression should evaluate to a
string and it is compared to the "key" field of the
activity’s input. If the Candidate Event Key and the
activity’s key match, then the process accepts the
incoming message.
For example, you may have sent an HTTP request
earlier in the process, and you may be waiting for a
response from the HTTP server. You may specify a
requestID as an attribute of the HTTP request and
responseTo attribute on the Wait for HTTP request
activity. The HTTP server presumably will set the
responseTo attribute of its response to the same
value as the requestID attribute of the request. You
would then specify the responseTo attribute as the
Candidate Event Key and the requestID attribute
of the HTTP request as the "key" in the Input tab.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For HTTP Request activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The JDBC palette contains activities for querying, updating, or calling stored
procedures within a database.
Topics
The JDBC Call Procedure activity calls a database procedure using the
specified JDBC connection.
If this activity is not part of a transaction group, it is committed after it
completes. If this activity is part of a transaction group, it is committed
or rolled back with the other JDBC activities within the group at the end of the
transaction. See TIBCO BusinessWorks Process Design Guide for more information
about creating groups for transactions.
If you wish to override the default behavior of transaction groups for certain
JDBC activities within a transaction group, you can check the Override
transaction behavior field. This specifies that the activity is outside of the
transaction and is committed when it completes, even if it is within a transaction
group.
The Refresh button on this activity allows you to synchronize the activity with
the contents of the database. This is useful if you make a change to the database
while you are editing a process definition containing this activity in TIBCO
BusinessWorks.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Procedure Name Name of the database procedure to call. You can use
the Select Procedure button to query the database for
available procedures once the JDBC Connection field
is specified.
Note: The input parameters and output parameters
for the procedure are displayed when you use the
Select Procedure button. TIBCO Designer retrieves
the signature of each stored procedure from the
database once. If you change the stored procedure
while editing your project, you must click the Refresh
button to retrieve the changes from the database.
Timeout (sec) Time to wait for the procedure call to complete. If the
call does not complete within the given time limit, an
error is returned.
Input
The input for this activity is dependent upon the input parameters of the database
procedure.
Output
The output for the activity is dependent upon the output parameters of the
database procedure.
JDBC Query
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Timeout (sec) Time (in seconds) to wait for the query to complete. If
the query does not complete within the given time
limit, an error is returned.
Field Description
Prepared parameters If you wish to replace static names within the SQL
and their datatypes statement with process variables, you must edit the
SQL Statement field and replace the variable items
with a question mark (?). For example, if you wish to
specify a variable for the first column returned, you
would specify the following SQL statement:
SELECT DEMO.ITEM.ITEM_ID FROM DEMO.ITEM
WHERE DEMO.ITEM.ITEM_ID = ?
Field Description
Use Nil Specifies whether NULLs are represented as optional
schema elements or whether each item that can
contain a NULL has sub-items.
For example, in the following schema, the NAME
column can contain NULLs. If Use Nil is unchecked,
the NAME element appears with a ? indicating it is
optional (and if the column is NULL, the schema item
is not included for that row). If Use Nil is checked, the
NAME element is not optional, and it has two
sub-items, @nil and Text. The @nil item indicates
whether the column value for the row is NULL, the
Text item contains the column value when the
column is not NULL.
Use Nil Checked Use Nil Unhecked
Field Description
Manual Refresh TIBCO BusinessWorks refreshes the schema from the
database when any operation may cause the input or
output schema for this activity to change. For
example, editing the SQL Statement may cause the
output schema to change. However, not all changes
actually cause a change in the input or output
schemas, so you may wish to prevent automatic
schema refreshing to improve performance.
Checking this field causes TIBCO BusinessWorks to
stop automatically querying the database for changes
in input and output schema when configuring the
activity. If you want to refresh the schema from the
database, you must use the Refresh button on this
activity.
This field is useful if you make several changes to a
query’s WHERE clause, but make no changes to the
list of columns to return. For large databases, each
change would require a refresh from the database,
and this can dramatically slow performance. WIth
manual schema refreshing, the schema is only
refreshed when you click the Refresh button.
Input
The input for the activity is the following.
Output
The output for the activity is the following.
JDBC Update
Configuration
The Configuration tab has the following fields:
Field Description
Name The name to appear as the label for this field
in the process definition.
Field Description
Description Short description of the activity.
Field Description
Prepared Parameters and If you wish to replace static names within the
Their Datatypes SQL statement with process variables, you
must edit the SQL statement field and replace
the variable items with a question mark (?).
For example, you might specify the following
statement:
UPDATE emp SET ename = ?, phone = ?
WHERE id = ?
Input
The input for the activity is the following:
Output
The output for the activity is the following:
Query Designer
The Query Designer is a GUI tool for building SQL queries, testing syntax, and
previewing results before running the process. You can use the Query Designer in
one of the following ways:
• to automatically generate SQL queries
• to manually edit and check the syntax of existing queries
In the JDBC Query activity, you must first specify a JDBC Connection shared
configuration resource to connect to a database. Once the database connection is
specified in the JDBC Query activity, you can click on the Build Using Wizard
button to create a query using the Query Designer wizard. Figure 11 illustrates the
query designer.
After you customize a query on the SQL tab, you cannot go back to the design tab
without loosing your changes. You should first create a query using the Design
tab that is close to the query you want, then click the Customize checkbox on the
SQL tab to further customize it as needed.
By default, all table columns are included in the query. To constrain query
syntax, click the Design tab in the SQL panel. You can drag individual
columns from the Table Diagram panel to the Add Column area of this tab to
refine the query. The Add Column entry is a placeholder only, and does not
affect the output. It is meant to be the area where you can drag columns from
the tables to add to the query.
The following example shows the results of dragging the CUSTOMER_ID,
NAME, TOTAL, and SALESPERSON_ID columns to the SQL tab:
Clicking the SQL tab to view the modified syntax shows the query now selects
only from the set of columns:
SELECT DEMO.CUSTOMER.CUSTOMER_ID, DEMO.CUSTOMER.NAME,
DEMO.CUSTOMER.SALESPERSON_ID, DEMO.SALES_ORDER.TOTAL
FROM DEMO.CUSTOMER, DEMO.SALES_ORDER
WHERE (DEMO.CUSTOMER.CUSTOMER_ID = DEMO.SALES_ORDER.CUSTOMER_ID)
2. To group sales by customer and show sales totals, perform the following:
— For the TOTAL column, click in the Total field and select Sum from the list.
The other columns are automatically updated to select the Group By value
required for this function.
— For the CUSTOMER_ID column, click the Show checkbox to deselect it.
This column is necessary for the query, but can be hidden in the output.
Clicking the SQL tab to view the syntax shows the SUM function and GROUP BY
clause has been added to the SQL:
SELECT DEMO.CUSTOMER.NAME, DEMO.CUSTOMER.SALESPERSON_ID,
SUM(DEMO.SALES_ORDER.TOTAL)
FROM DEMO.CUSTOMER, DEMO.SALES_ORDER
WHERE (DEMO.CUSTOMER.CUSTOMER_ID =
GROUP BY DEMO.CUSTOMER.CUSTOMER_ID, DEMO.CUSTOMER.NAME,
DEMO.CUSTOMER.SALESPERSON_ID
Other criteria can be applied using the Sort, Criteria, and Or fields.
3. To check the SQL syntax, click the Check Syntax button.
A dialog displays either a success message, or a database error code and
message.
4. After checking the syntax, click the Execute button on the Test tab to preview
the query results:
SQL Direct
The SQL Direct activity executes a SQL statement that you provide. This
activity allows you to build a SQL statement dynamically (using other
activities), then pass the SQL statement into this activity’s input. This
activity also allows you to execute SQL statements that are not supported by other
activities in the JDBC palette. For example, DDL commands (for example, CREATE
TABLE) are not available by using any other activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Timeout (sec) Time (in seconds) to wait for the query to complete. If
the query does not complete within the given time
limit, an error is returned.
Field Description
Override transaction Overrides the default behavior of a transaction group.
behavior If this activity is within a transaction group, the
activity is normally committed or rolled back with the
other JDBC activities within the transaction.
If this checkbox is checked, this activity is not part of
the transaction group and is committed when it
completes. Checking this option uses a separate
database connection to perform the activity and
commit the SQL statement.
Input
The input for the activity is the following.
Output
The output for the activity is the following.
Java Message Service (JMS) is a specification for how messages are sent and
received between applications in a Java environment.
The JMS palette is used to send and receive JMS messages within a process
definition. Both the JMS point-to-point (queues) and publish/subscribe (topics)
models are supported.
Refer to the documentation of your JMS provider or the JMS specification for
more information about JMS and its message models.
Topics
JMS Properties
Table 1 table describes message headers and message properties used in JMS
messages. MessageHeader properties are set by the JMS application sending the
message and are available to view once the message is received.
MessageProperties can be set on outgoing messages using the Input tab of the
activity that sends the message.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Field Description
Output XML Schema XML Schema that describes the data of the incoming
message. This field allows you to specify an XML
schema to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Message selector A string to determine whether a message should be
received. The syntax of the message selector is
determined by the JMS provider, but it is usually a
subset of SQL92 (where message properties are used
instead of table column names).
See your JMS provider documentation for more
information and syntax for a message selector string.
Data
The Data tab defines the schema to use for incoming messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the incoming message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Field Description
Input XML Schema XML schema that describes the data of the outgoing
request.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the outgoing request is represented as an
XML schema in the Input tab.
Input Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Input XML
Schema field.
Output XML Schema XML Schema that describes the data of the incoming
response.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the incoming response is represented as
an XML schema in the Output tab.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Queue Name of the queue of the outgoing message.
The syntax of the queue name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about queue
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String
• XML Text — the message is XML text.
Input XML Schema XML schema that describes the data of the outgoing
message.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the outgoing message is represented as
an XML schema in the Input tab.
Input Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Input XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Reply-to destination The name of the queue to which replies should be
sent. This field is optional, and replies are sent to the
queue specified on the Configuration tab by default.
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Data
The Data tab defines the schema to use for outgoing messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the outgoing message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The JMS Topic Publisher sends a message to the specified JMS topic.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Topic Name of the topic of the outgoing message.
The syntax of the topic name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about topic
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Input XML Schema XML schema that describes the data of the outgoing
message.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the outgoing message is represented as
an XML schema in the Input tab.
Input Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Input XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Reply-to destination The name of the topic to which replies should be sent.
This field is optional, and replies are sent to the topic
specified on the Configuration tab by default.
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Data
The Data tab defines the schema to use for outgoing messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the outgoing message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Topic Name of the topic of the outgoing message.
The syntax of the topic name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about topic
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Input XML Schema XML schema that describes the data of the outgoing
request.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the outgoing request is represented as an
XML schema in the Input tab.
Input Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Input XML
Schema field.
Field Description
Output XML Schema XML Schema that describes the data of the incoming
response.
For XML Text messages, the body of the message is an
XML schema. This field allows you to specify an XML
schema to use for validating the body of the message.
The body of the incoming response is represented as
an XML schema in the Output tab.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Field Description
JMS Application Any application-specific message properties that will
Properties be part of the message. This is specified by the JMS
Application Properties shared configuration object.
Once specified, these properties appear on the Output
tab as "OtherProperties".
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Starts a process based on the receipt of a message for the specified JMS
topic.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Field Description
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Output XML Schema XML Schema that describes the data of the incoming
message. This field allows you to specify an XML
schema to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Field Description
Suppress local Specifies that this process starter should not receive
messages messages on the specified topic name when the
message was sent by the JMS application on the same
connection as the process engine.
If your process definition publishes and subscribes to
messages with the same topic name, this option is
useful if you wish to specify whether to receive
messages sent by yourself (that is, the same JMS
application that published the message).
Checking this field prevents the process from
receiving messages sent by the same connection.
Unchecking this option specifies messages sent by the
same connection should be received.
Max Sessions (Read When the Acknowledge Mode field is set to "Client",
Only) this read-only field appears to notify you that only
one session can receive incoming topic messages until
the message is confirmed.
When a JMS topic message is received, the session is
blocked until the message is acknowledged. Because
all sessions subscribed to JMS topics receive the same
messages, only one session can be actively listening
for new messages until each message is confirmed.
Advanced
The advanced tab has the following fields.
Field Description
Message selector A string to determine whether a message should be
received. The syntax of the message selector is
determined by the JMS provider, but it is usually a
subset of SQL92 (where message properties are used
instead of table column names).
See your JMS provider documentation for more
information and syntax for a message selector string.
Data
The Data tab defines the schema to use for incoming messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the incoming message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Input XML Schema XML Schema that describes the data of the outgoing
reply. This field allows you to specify an XML schema
to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Field Description
Input Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Input XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Reply-to destination The name of the queue or topic to reply to. This
should be automatically handled by the JMSReplyTo
property of the incoming message from the activity
selected in the Reply To field on the Configuration
tab. If you wish the reply to go to a different queue or
topic, specify the name here.
Delivery mode The delivery mode of the message. Can be one of the
following:
• PERSISTENT — signifies the messages are stored
and forwarded.
• NON_PERSISTENT — messages are not stored
and may be lost due to failures in transmission.
Data
The Data tab defines the schema to use for outgoing replies whose message type
is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the outgoing message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Input tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The activity has no output.
The Wait for JMS Queue Message waits for the receipt of a
message for the specified JMS queue.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Queue Name of the queue of the incoming message.
The syntax of the queue name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about queue
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Output XML Schema XML Schema that describes the data of the incoming
message. This field allows you to specify an XML
schema to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Advanced
The advanced tab has the following fields.
Field Description
Message selector A string to determine whether a message should be
received. The syntax of the message selector is
determined by the JMS provider, but it is usually a
subset of SQL92 (where message properties are used
instead of table column names).
See your JMS provider documentation for more
information and syntax for a message selector string.
Data
The Data tab defines the schema to use for incoming messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the incoming message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming file
change event. This expression should evaluate to a
string and it is compared to the "key" field of the
activity’s input. If the Candidate Event Key and the
activity’s key match, then the process accepts the
incoming message.
For example, you may have JMS Queue Sender
activity earlier in the process diagram and you are
expecting a message in response to the sent
message. You would place the JMSCorrelationID
from the header of the incoming message into the
Candidate Event Key field. You would then place
the JMSMessageID from the header of the outgoing
message earlier in the process in the "key" field on
the input tab.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For JMS Queue Message activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The Wait for JMS Topic Message waits for the receipt of a message
for the specified JMS topic.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Topic Name of the topic of the outgoing message.
The syntax of the topic name is specific to the JMS
provider you are using. See your JMS provider
documentation for more information about topic
names.
Connection reference The JMS connection. See JMS Connection on page 318
for more information about creating a JMS
connection.
Message type The type of the message. This can be one of the
following:
• Simple — A message with no body portion.
• Bytes — A stream of bytes.
• Map — A set of name/value pairs. The names are
strings, and the values are simple data types (Java
primitives), an array of bytes, or a string. Each
item can be accessed sequentially or by its name.
• Object — A serializable Java object.
• Stream — A stream of Java primitives, strings, or
arrays of bytes. Each value must be read
sequentially.
• Text — the message is a java.lang.String.
• XML Text — the message is XML text.
Output XML Schema XML Schema that describes the data of the incoming
message. This field allows you to specify an XML
schema to use for validating the body of the message.
The incoming message body is parsed into an XML
schema based on the schema definition specified in
this field.
Field Description
Output Schema root Element within the XML schema to use when parsing
element the XML string. The message body is validated with
respect to this particular element, instead of using the
entire XML schema specified in the Output XML
Schema field.
Suppress local Specifies that this process starter should not receive
messages messages on the specified topic name when the
message was sent by the JMS application on the same
connection as the process engine.
If your process definition publishes and subscribes to
messages with the same topic name, this option is
useful if you wish to specify whether to receive
messages sent by yourself (that is, the same JMS
application that published the message).
Checking this field prevents the process from
receiving messages sent by the same connection.
Unchecking this option specifies messages sent by the
same connection should be received.
Advanced
The advanced tab has the following fields.
Field Description
Message selector A string to determine whether a message should be
received. The syntax of the message selector is
determined by the JMS provider, but it is usually a
subset of SQL92 (where message properties are used
instead of table column names).
See your JMS provider documentation for more
information and syntax for a message selector string.
Field Description
JMS Application Any application-specific message properties that will
Properties be part of the message. This is specified by the JMS
Application Properties shared configuration object.
Once specified, these properties appear on the Output
tab as "OtherProperties".
Data
The Data tab defines the schema to use for incoming messages whose message
type is "Map" or "Stream". Map messages are name/value pairs, and the schema
allows you to define the structure of the incoming message. Once defined, the
schema on the Data tab becomes the structure used for the body of the message
displayed on the Output tab.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming file
change event. This expression should evaluate to a
string and it is compared to the "key" field of the
activity’s input. If the Candidate Event Key and the
activity’s key match, then the process accepts the
incoming message.
For example, you may have JMS Topic Publisher
activity earlier in the process diagram and you are
expecting a message in response to the sent
message. You would place the JMSCorrelationID
from the header of the incoming message into the
Candidate Event Key field. You would then place
the JMSMessageID from the header of the outgoing
message earlier in the process in the "key" field on
the input tab.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For JMS Topic Message activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The Mail palette is used to receive incoming email or send outgoing email.
Topics
Receive Mail
The Receive Mail process starter polls a POP3 mail server for new
mail. When new mail is detected and retrieved, the Receive Mail
process starter starts a new process for the process definition it
resides in and passes the mail data to the next activity in the process
flow.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
User Name User name to use when logging into the POP3 server.
Polling Interval (sec) Polling interval (in seconds) to check for new mail.
The interval can be specified in milliseconds, seconds,
minutes, hours, and days.
Delete Mail If checked, mail will be deleted from the POP3 server
once the process starter has retrieved it.
Output
The output for the activity is the following.
Send Mail
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
The Manual Work palette is useful for automated business processes that have a
few steps that require user interaction. The Manual Work palette works with
TIBCO InConcert to provide some workflow capability in automated business
processes.
Topics
The Manual Work palette includes activities that you can add to your business
processes when the process requires user interaction for completion. For example,
your enterprise may provide international monetary transfers. Some of the steps
in this process can be automated, but a final approval or rejection may be required
by an approval clerk. The clerk views the transfer request in a web interface, and
then either approves or rejects the request.
Figure 12 illustrates an example business process that requires manual work. A
request for funds transfer is received, and the country of origin is checked. If the
transfer is local and under $100,000, the transfer is automatically approved. If the
transfer is international or over $100,000, the request is assigned to a pool of users
for approval. One user accepts the request, and approves or rejects it. If no one
accepts the request, the manual approval times out, and then the status of the
request is checked. If no errors were returned, then the work is still in the users’
queue, so the process waits for the completion of the manual work. If errors were
reported in the manual work, the work is marked as not approved and the
process completes.
The Manual Work palette allows you to assign a task to a pool of users, check the
status of the task, change the status of the task, download documents associated
with a task, or wait for the completion of a task. TIBCO Administrator allows you
to create roles and assign users to roles. These roles are the pools of users to which
you can assign manual work tasks.
The Manual Work palette works with TIBCO InConcert to provide workflow
capabilities. Users and roles (groups of users) are defined in TIBCO
Administrator and then exported to TIBCO InConcert. An activity that assigns
work creates a TIBCO InConcert job. The job can be viewed and modified using
TIBCO BusinessWorks Manual Work Organizer web interface described in
Working With Tasks Assigned to a Role on page 218. This task can also be viewed
or modified using the TIBCO InConcert tools and APIs.
Table 2 describes the two shared configuration resources used when configuring
activities in the Manual Work palette.
Table 3 describes the general purpose of each of the activities in the Manual Work
palette.
Activity Description
Assign Work This activity creates a new task (with associated data)
and assigns it to the specified role. A user then
acquires the task, views the data supplied by the
activity, and completes the work.
The process definition can either wait for the user to
complete the work or it can continue processing and
later query for the status of the task.
Get Work Status Retrieves the current status of a task that was
previously created with the Assign Work activity.
Normally you use this activity to determine if the
task has been completed or if there are any errors.
You can use the status to determine where to
conditionally transition to in the process definition. If
the status is Complete, you may want to transition to
the next step of the business process. You may want
to put the Get Work Status in a loop to check the
status periodically and transition out of the loop
when the status is marked as complete or an error is
returned.
Activity Description
Modify Work This activity changes the status of an existing task
created with the Assign Work activity. You can
change the status to one of the following:
• Update — signifies the task has been updated
• Complete — signifies the task is complete
• Reassign — reassigns the task to a role
You would normally use the Modify Work task to
change the status of a task that has not been acquired
by any user or if errors have been returned.
Wait for Completion Waits for the specified period for the status of a task
to be set to Complete. This is useful if the timeout for
the Assign Work activity has passed and you wish to
wait for an additional amount of time.
If the original Assign Work has timed out, you may
wish to use the Modify Work activity to reassign the
task to a different role, and then use the Wait for
Completion activity to wait again for the task to be
complete.
Documents can be associated with tasks created by the Assign Work activity. For
example, you may wish to attach a Microsoft Word document containing a loan
application to a credit approval task. These documents are managed by the
workflow server, and they can be of any type.
If you wish to associate documents with a task, the schema for the task must
contain one or more elements of type Document. This is a special datatype
available only for workflow schemas. Document is a complex datatype containing
two elements:
• name — a string element containing the name of the document (be sure to use
the proper file name extension so that the files can be easily opened using the
browser-based Manual Work Organizer).
TIBCO BusinessWorks provides a simple web interface for viewing manual work
tasks assigned to users. This interface is named the TIBCO BusinessWorks
Manual Work Organizer. When you log into the web interface, you can see any
task that you have acquired. Logging in requires that you specify a valid
username, password, and TIBCO InConcert server name.
To log into the Manual Work Organizer, you must be a valid user created using
TIBCO Administrator. See the TIBCO Administrator documentation for more
information about creating users. When logging in, you can specify a proxy
TIBCO InConcert ICJava server name. This ICJava server allows you to log into
TIBCO InConcert servers that are not part of your network subnet. See the TIBCO
InConcert documentation for more information about configuring ICJava servers.
You can log in to the Manual Work Organizing by invoking the following URL:
http://<machine>:8080/administrator/servlet/bwmanualwork
where <machine> is the name of the machine where the TIBCO Administrator
server is installed.
Once you log in, each user is presented with lists of tasks:
• Acquired — the list of tasks the user is currently working on. This list is
shown by default when a user logs in.
• Ready — the tasks available to the role that the user belongs to. This is the list
of tasks that need to be acquired by one of the users in the role.
• Completed (last 7 days) — the tasks the user has completed. Only tasks
marked completed within the last seven days are displayed.
• Manage — a list created by a custom search of the existing manual work tasks.
This list is only visible to system administrators, and it is used to perform
administrative actions.
Table 4 describes the columns of the task lists.
Ready Date The time the task was placed in the Ready
Ready list.
You can sort the task lists based on any column in the list by clicking on the
column heading. You can also navigate to the previous, next, first, or last page in
the list. Figure 13 illustrates the task lists.
You can select any task within a task list to view the detail of the task. You can
view the header, detail, or documents attached to a task. The Details tab allows
you to edit the task details. Figure 14 illustrates the task detail.
Acquiring Tasks
When a task is assigned to a role, it is placed into the Ready list for each user in
the role. Users can view the Ready list, and select tasks to acquire. When a user
acquires a task, that task is removed from the Ready list and placed in the user’s
Acquired list. Once a user acquires a task, other users cannot view or modify the
task unless the user routes, delegates, transfers, or releases the task.
Command Description
Complete Change the status of the task to Complete and move the
task to the Completed list.
A user performs this command after the user has
completed work on the task. For example, a user may
need to view the data in the task and then change the
Approved property to either true or false.
Release Releases the task from the user’s Acquired list and puts
the task back into the Ready list of the role.
Update (Save) Saves any changes made to properties of the task, but
does not change the status of the task.
Administering Tasks
Users belonging to the admin role can perform administrative activities on tasks.
When an administrator logs into the task web interface, the administrator can
select the Manage list and query for tasks.
The user icdba is the predefined administrator in TIBCO InConcert. If you wish
to use this user to create users and roles and administer manual work tasks, you
must first create this user in TIBCO Administrator and grant the user the
necessary permissions.
To perform a query, the administrator must supply a role and a status to query for
tasks. The administrator can then supply a string to search for in the Work Type
field, and all tasks that contain the supplied string are returned. The
administrator can also supply date ranges in the Due Date, Completed Date,
Ready Date, or Acquired Date fields to search for tasks based on those criteria.
Once tasks are returned by a search, the administrator can perform the following
actions on each task or a selected range of tasks.
Command Description
Release (only for Releases the task from a user’s Acquired list and puts
acquired tasks) the task back into the Ready list of the role.
Delete (only for Deletes the task from the completed list.
completed tasks)
The Assign Work activity creates a TIBCO InConcert job that runs on a TIBCO
InConcert server. You do not need to know a great deal about TIBCO InConcert to
perform simple workflow functions. However, TIBCO InConcert must be
installed and configured before you can use the Manual Work palette.
The Assign Work activity creates TIBCO InConcert jobs that can be viewed or
manipulated using the standard TIBCO InConcert facilities (that is, either the
ICWeb API, or any other TIBCO InConcert API). TIBCO BusinessWorks provides
an easy-to-use web interface for viewing, modifying, and completing manual
tasks. You can create your own ICWeb interface, if you prefer.
Assign Work
The Assign Work activity creates a manual work task and assigns it to
the specified role. Users can view tasks assigned to their role by
logging into the Manual Work web interface provided with TIBCO
BusinessWorks.
An Assign Work activity creates a standard TIBCO InConcert task. If you wish to
do more sophisticated task processing, all TIBCO InConcert tools and APIs can be
used to handle tasks created with the Assign Work activity.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Assign To The name of the role to assign this task to. These users
and roles are created using TIBCO Administrator and
then exported to TIBCO InConcert.
Wait for Completion Specifies that this activity should wait for status of the
task to be Complete before continuing on to the next
activity.
Field Description
Wait till The amount of time to wait for the status of the task to
change. This field is only valid when the Wait for
Response field is checked.
Advanced
The advanced tab has the following fields.
Field Description
Extended Details The Workflow Schema shared configuration resource
that defines the data for use when a task is routed or
delegated to another user.
The Work Details field specifies the schema to use that
contains the global data for the task. Data in the Work
Details schema can be edited by all users that the task
is routed or delegated to. The Extended Details
schema is used to supply data that is passed on to the
next user the task is routed or delegated to.
Data in the Extended Details schema is manipulated
during the Route or Delegate operation. If you are
using the web interface supplied by TIBCO
BusinessWorks, extended details are not used, and
therefore you do not need to supply a schema for this
field.
If you are using TIBCO InConcert to create your own
interface for managing manual tasks, you can use this
schema to supply data that is passed onto the next
user. For example, you may create a schema to
contain notes to pass on to the next user. These notes
will only be available to the next user the task is
delegated or routed to, and if the task is routed or
delegated again, the user can supply new notes.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
Download Document
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Download From The Assign Work activity from which you wish to
download documents.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
The Get Work Status activity is used to retrieve the current status of
the specified manual task from the TIBCO InConcert server.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Extended Details The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Modify Work
The Modify Work activity is used to change the status of a manual task
created by the Assign Work activity. This activity changes the status to
one of the following: Complete, Reassign, or Update.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Extended Details The extended details (assigned on the Advanced tab
of the Assign Work activity) associated with this task.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Wait For The name of the Assign Work activity that you wish
to wait for completion.
Field Description
Server Details The Workflow Server Connection shared
configuration resource that describes the connection
to the TIBCO InConcert server. See Workflow Server
Connection on page 328 for more information.
Wait Till The amount of time to wait for the status of the task to
change.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The Parse palette provides activities for parsing and rendering formatted text.
This is useful if you wish to transform formatted lines of text into a data schema.
The text lines can be formatted by either delimiters separating each field or offsets
can be specified to determine where each field begins and ends. This is also useful
if you wish to transform a data schema into a formatted text string.
Topics
Parse Data
The Parse Data activity takes a text string or input from a file and
processes it, turning it into a schema tree based on the specified Data
Format shared configuration.
You can use any mechanism to obtain or create a text string for processing. For
example, you can use the Read File activity to obtain text from a file, or you can
retrieve a text field from an adapter message. You can also specify a text file to
read using this activity.
Only files with ASCII or Unicode encoding can be read by this activity. If you
wish to read files that use another encoding, use the Read File activity to retrieve
the file contents into a process variable. Then use the process variable as input to
this activity.
You might use this activity in a number of situations. For example, you may have
a file that consists of multiple lines of comma-separated values (as in data
obtained from a spreadsheet). You may also want to insert that data into a
database table. To do this, read and parse the file into a data schema with the
Parse Data activity. Then use a JDBC Update activity to insert the data schema
into a database table.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Encoding The encoding of the input file. This field is only
available when "File" is chosen in the Input Type field.
Only ASCII or Unicode encoded files can be read by
this activity. Use the Read File activity to read data
from files using other encodings.
Skip Blank Lines Skips any empty records when parsing the text input.
When this field is unchecked, parsing stops at the first
blank line encountered in the input.
Skip First Record Skips the first record of the file. This option is for
(Header) eliminating the header record, if desired.
Manually Specify Allows you to specify the record in the input where
Start Record you wish to start parsing.
This is useful if you have a large number of records
and you wish to read the input in parts (to minimize
memory usage). Checking this checkbox causes the
startRecord input item to appear. See Parsing a
Large Number of Records on page 251 for more
information on how to read the input stream in parts.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Render Data
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
The Rendezvous palette allows you to send and receive TIBCO Rendezvous
messages. For more information about TIBCO Rendezvous, see the TIBCO
Rendezvous documentation.
Topics
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Input Schema Specifies whether the input schema is shared
(available as a stored schema in the repository), or
custom. The input schema becomes the body of the
TIBCO Rendezvous message to send.
If the input schema is shared, you must locate the
stored schema using the Input Reference field. If the
input schema is custom, you must specify the fields of
the input schema using the Input Schema tab.
Input Reference The location of the shared schema to use as the input
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Input Schema
The Input Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Output Schema tab becomes the body of the TIBCO Rendezvous message.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
Rendezvous Subscriber
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
XML Encoding If checked, this field receives the TIBCO Rendezvous
message as a single field named "xml". The datatype
of the field is RVXml.
Schema Reference The location of the shared schema to use as the output
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Output Schema
The Output Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Output Schema tab becomes the body of the TIBCO Rendezvous message.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Input
This activity requires no input.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Reply Subject The reply subject of the received TIBCO Rendezvous
message. You can override this value by specifying a
subject on the Input tab.
Input Reference The location of the shared schema to use as the input
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Output Schema
The Output Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Output Schema tab becomes the body of the TIBCO Rendezvous message.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
This activity produces no output.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Transport The TIBCO Rendezvous transport parameters. These
are specified as a Rendezvous Transport shared
configuration resource. See Rendezvous Transport on
page 322 for more information about shared
configuration resources.
Input Ref The location of the shared schema to use as the input
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Field Description
Output Ref The location of the shared schema to use as the output
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Input/Ouput Schema
The Input Schema and Output Schema tabs allow you to define custom schemas
for the outgoing TIBCO Rendezvous request and the incoming TIBCO
Rendezvous response.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Data tab becomes the body of the TIBCO Rendezvous messages.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Data tab.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Field Description
Transport The TIBCO Rendezvous transport parameters. These
are specified as a Rendezvous Transport shared
configuration resource. See Rendezvous Transport on
page 322 for more information about shared
configuration resources.
Schema Reference The location of the shared schema to use as the output
for this activity. This schema becomes the body of the
TIBCO Rendezvous message.
Output Schema
The Output Schema tab allows you to define a custom schema for the TIBCO
Rendezvous message.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Output Schema tab becomes the body of the TIBCO Rendezvous message.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of using the Output Schema tab.
Event
The Event tab has the following fields.
Field Description
Candidate Event Key Expression built from the data of the incoming
message. This expression should evaluate to a string
and it is compared to the "key" field of the activity’s
input. If the Candidate Event Key and the activity’s
key match, then the process accepts the incoming
message.
For example, you may have a Publish Rendezvous
Message activity that sends a message with a
particular ID. You are expecting a reply message
that contains that same ID so that you can determine
the message is a response to your sent message. You
would specify the field of the incoming message
that contains your ID in the Candidate Event Key.
You would then use the message ID of the message
you sent earlier in the process as the "key" field in
the input.
This expression is specified in XPath, and only data
from the incoming event is available for use in this
XPath expression. See TIBCO BusinessWorks Process
Design Guide for more information about XPath
expressions.
When building an expression in the Candidate Event Key field, only data from
the incoming event is available. The idea is that you want to place an expression
containing incoming event data in the Candidate Event Key field. When the
results of this expression match the results of the expression in the "key" item on
the Input tab, the Wait For Rendezvous Message activity proceeds.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Simple Object Access Protocol (SOAP) is a lightweight protocol for the exchange
of information between web services. The SOAP palette allows you do the
following:
• create process definitions that implement web services
• send a SOAP request to a web service and receive a reply from that service
• generate a WSDL file containing a concrete service description of any process
containing a SOAP Event Source process starter.
See the SOAP specification available at www.w3.org/TR/SOAP for more
information about SOAP.
Topics
Retrieve Resources
To use the Retrieve Resources activity, the HTTP request must have the following
form:
http://<host>:<port>/bw/services/<path>/<resource name>?wsdl
where host and port are the host name of the machine that is listening for the HTTP
request (the machine where this process instance is running) and port should be
the same port specified by the HTTP Receiver process starter. path is the location
of the resource or path in the project tree. resource name is the name of the process
definition.
For example, the following is an HTTP request that retrieves the WSDL file for the
process named GetPurchaseOrder stored within the folder Purchasing:
http://purch:8877/bw/services/Purchasing/GetPurchaseOrder?wsdl
When sending the HTTP Response, set the Headers/Content-Type item on the
Input tab to "text/xml".
If you wish to test a process definition containing this activity, you must load the
process definition containing this activity along with the process definition
containing the SOAP Event Source process starter into the test window. For more
information about loading multiple process definitions when testing, see TIBCO
BusinessWorks Process Design Guide.
See the descriptions of the Input and Output tabs for this activity for more
information about binding the HTTP request to this activity’s input and binding
this activity’s output to an HTTP response.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
At runtime, a client can retrieve the WSDL file for a process containing this
process starter using an HTTP request (see the description of the Retrieve
Resources activity for more information). Once the WSDL is retrieved, the client
can perform a SOAP request to invoke the web service.
When using the SOAP Event Source activity to create a web service, the web
service uses "literal" encoding and is of type "document". See the SOAP
specification for more information about the types of web services and the
encoding used in a web service.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
WSDL File The stored WSDL file that contains the abstract
service description. This is specified or imported as a
shared configuration resource. See WSDL File on
page 329 for more information about abstract and
concrete service descriptions.
The stored service description can be either abstract
or concrete, but because the process definition is the
implementation of the web service, any concrete
endpoint binding is ignored.
The best practice is to generate an abstract service
description using the WSDL File shared configuration
resource. Then use that abstract service description
for this activity’s service.
However, you may wish to use an existing WSDL file
as a template for your service. If there is an existing
concrete service description, you can also use that for
this activity, but the concrete endpoint information
will be replaced by BusinessWorks’ endpoint binding
when the Retrieve Resources activity is used to
generate the WSDL File.
Field Description
Service The name of the web service that this process
definition represents.
You can use the Select button to bring up the Select a
Resource dialog. This dialog allows you to select the
available operations and the service from the
specified WSDL file. The Operation and Endpoint
URL fields will then be populated by the choices
made in this dialog.
Output
The output for the activity is the following.
Input Headers
The Input Headers tab allows you to define a custom schema used for any
headers supplied by the incoming SOAP request. The specified input header is
also specified in the concrete bindings in the WSDL file created by this process
starter.
When an incoming request supplies a header, the SOAP Event Source process
starter places the information contained in the header into the output process
variables for the SOAP Event Source. The header information is then available to
subsequent activities in the process definition.
You can define your own datatype on this tab, and you can reference XML
elements stored in the project. Once defined, the data specified on the Input
Headers tab becomes part of the Output schema for this activity.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of how to specify custom schemas.
Output Headers
The Output Headers tab allows you to define a custom schema used for any
headers supplied for the reply to the SOAP request. Once defined, the data
specified on the Output Headers tab becomes part of the Input schema for the
SOAP Send Reply activity that is used to send the reply for the incoming SOAP
request.
You can define your own datatype on this tab, and you can reference XML
elements stored in the project.
See Appendix A, Specifying Data Schema, on page 341 for a complete description
of how to specify custom schemas.
Service Description
This tab displays the WSDL file that can be used to call the web service
implemented by this activity. This information is presented for display purposes
only, and this file cannot be edited. You can copy this WSDL file and send it to
anyone who wishes to invoke the web service for this process.
Normally, an application would use a web request to retrieve the WSDL file of a
web service (see the description of the Retrieve Resources activity for more
information about sending a WSDL file as a response to a web request). This tab
allows you to see the WSDL file that contains the concrete service description for
this process.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
WSDL File The WSDL file that describes the web service. This is
imported as a shared configuration resource. See
WSDL File on page 329 for more information about
SOAP resources.
Endpoint URL The URL of the web service that you are sending a
request to. This field is automatically populated with
the choice made when selecting the service.
You can specify URLs that use the HTTPS (secure
sockets) protocol. If you specify HTTPS as the
protocol, the Server Certificate, Client Keystore,
Keystore Password, and Keystore Type fields appear.
For more information about creating keystores for
private keys and trusted certificate chains, see
http://java.sun.com/j2se/1.3/docs/tooldocs/win32
/keytool.html.
Field Description
Action The soapAction header for the operation. See the
SOAP specification for more information about
soapAction.
Timeout (secs) The time to wait (in seconds) for the operation to
complete.
Use HTTP Proxy When checked, this field specifies that an HTTP proxy
server is used to connect to the SOAP server. Enabling
this field causes the Proxy field to appear.
Use Basic When checked, this field specifies that you wish to
Authentication supply a username and password to the SOAP server.
The Username and Password fields appear when this
field is enabled.
Field Description
Client Keystore Only available when HTTPS is the specified protocol
in the Endpoint URL field.
This field specifies the location of the client’s digital
certificate and private key.
Key Store Type Only available when HTTPS is the specified protocol
in the Endpoint URL field.
The file type for the trusted certificate. This file type
can be Java Key Store (JKS) or PKCS12.
Verify Host Name Only available when HTTPS is the specified protocol
in the Endpoint URL field.
This field specifies that the host name of the HTTP
server should be checked against the host name listed
in the server’s digital certificate. This provides
additional verification that the host name you believe
you are connecting to is in fact the desired host.
If the host name specified in the Endpoint URL field
on the Configuration tab is not an exact match to the
host name specified in the server’s digital certificate,
the connection is refused.
Note: If you specify an equivalent hostname (for
example, an IP address) in the Endpoint URL field,
but the name is not an exact match of the hostname in
the host’s digital certificate, the connection is refused.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
Output
The output for the activity is the following.
Error Output
This tab lists the possible output in the event of an error. Errors are described by
fault schemas defined in the WSDL file (see WSDL File on page 329 for
information on creating fault schemas in generated WSDL files). The errors are
presented as a choice element that can contain any of the defined SOAP fault
schemas in the WSDL file for the specified operation, or the element can contain
the defaultFault schema.
If a fault is returned by the SOAP server, you can use an error transition out of the
SOAP Request Reply activity to go to a set of activities to be performed in the
event of an error. The activities after the error transition can access a process
variable named $_error_<activity-name> where <activity-name> is the name of the
SOAP Request Reply activity. This process variable contains the fault schema
returned by the SOAP server.
Handling of SOAP faults is similar to handling errors from other activities. See
TIBCO BusinessWorks Process Design Guide for more information on error
handling.
This activity is used when the SOAP Event Source process starter is handles
incoming SOAP requests. The WSDL file for the request can have one or more
defined fault schemas for any operation (for generated WSDL files, see WSDL File
on page 329 for a description of creating fault schemas). The SOAP Send Fault
activity can use the fault schema to send application-specific data about the fault
back to the client that made the SOAP request.
The fault schema must be a valid XSD schema. You can map data to the schema
on the Input tab, and this data is returned to the client along with the required
fault information.
SOAP faults are required to send the fault code and the fault string. These values
are required input items on the Input tab. See the SOAP specification at
www.w3.org/TR/SOAP for more information about the syntax of SOAP fault
codes.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Fault Details The name of the fault schema to send. This field
provides a drop-down list of the fault schemas
defined in the WSDL file specified for the SOAP
Event Source process starter.
You must select one of the fault schemas to return to
the client, and that schema becomes part of the input
schema for this activity’s Input tab.
The option <Default> is always available and can be
used to send the default fault schema.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The activity has no output.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The activity has no output.
The XML palette provides activities for parsing XML strings into schemas and
rendering schemas into XML strings.
Topics
Parse XML
The Parse XML activity takes a binary XML file or an XML string and
processes it, turning it into an XML schema tree based on the XSD or
DTD specified.
The preferred way to parse XML files is to use a Read File activity set to
binary mode to read the XML file. Then pass the binary file contents to the Parse
XML activity.
is 55 minutes, 31 seconds, and 112 milliseconds after 2PM on February 10th, 2002
in a timezone that is 8 hours, 0 minutes behind UTC.
If no timezone field is present, the value is interpreted in the timezone of the
machine that is performing the parsing. This can lead to complications if you are
processing XML from different timezones, so you are encouraged to always use
timezones.
Configuration
The Configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Schema The XSD or DTD file to use when parsing the XML
string. This schema file is specified as a shared
configuration resource that can be used by many
activities. See Schema Definition on page 326 for more
information about XML resources.
Field Description
Input Style Can be binary, text, or dynamic.
In binary mode (the default and preferred choice), the
binary content is read. The encoding used for parsing
the content is either the default encoding specified in
the XML or you can specify encoding using the
"forceEncoding" input item.
In text mode, an XML string is passes as an input
item.
In dynamic mode, a choice is offered for input. You
can either supply binary or text input. You can use a
choice statement and set substitution in the mapping
to supply the correct type of input at run time.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Render XML
Configuration
The Configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in the
process definition.
Schema The XSD or DTD file to use when rendering the XML
schema. This schema file is specified as a shared
configuration resource that can be used by many
activities. See Schema Definition on page 326 for more
information about XML resources.
Text-only Output Specifies that the output should be text when this
checkbox is checked. If this field is unchecked, the
output is a stream of bytes.
When this field is unchecked (binary output), an
optional byteEncoding input item is available.
Input
See TIBCO BusinessWorks Process Design Guide for more information about
mapping and transforming input data.
The input for the activity is the following.
Output
The output for the activity is the following.
Transform XML
For more information about creating and editing XSLT files, see the XSLT
specification at http://www.w3.org/TR/xslt. For more information about
creating an XSLT File shared configuration resource see XSLT File on page 336.
See Example of Transforming XML on page 297 for an example of using the
Transform XML activity.
Configuration
The Configuration tab has the following fields.
Field Description
Name The name to appear as the label for the activity in
the process definition.
Input
The input for the activity is the following.
Output
The output for the activity is the following.
The Transform XML activity uses an XSLT file that accepts two input parameters,
catalogNumber and catalogDate. These input parameters are added as elements
to the Book schema. The following is the source of the XSLT File shared
configuration resource for the example Transform XML activity:
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
version="1.0"
xmlns:pfx="http://www.books.org">
<xsl:param name="catalogNumber"> <!--type="string"--></xsl:param>
<xsl:param name="catalogDate"> <!--type="string"--></xsl:param>
<xsl:template match="/*">
<pfx:BookStore>
<xsl:for-each select="Book">
<xsl:call-template name="handle-book">
<xsl:with-param name="inDate" select="$catalogDate"/>
</xsl:call-template>
</xsl:for-each>
</pfx:BookStore>
</xsl:template>
<xsl:template name ="handle-book">
<xsl:param name="inDate"> <!--type="string"--></xsl:param>
<pfx:Book>
<pfx:Title><xsl:value-of select="Title"/></pfx:Title>
<pfx:Author><xsl:value-of select="Author"/></pfx:Author>
<pfx:Date><xsl:value-of select="$inDate"/></pfx:Date>
<pfx:ISBN><xsl:value-of
select="$catalogNumber"/></pfx:ISBN>
When you configure the Transform XML activity, you specify the incoming XML
to transform as well as any input parameters to the schema. Figure 17 illustrates
the input for the example Transform XML activity.
The process variable containing the XML for the book is a string. The function
string-to-base64($ProcessBook/parameters/book) converts the incoming
XML string into the binary value required for input to the Transform XML
activity.
Also, the stylesheet has two input parameters. By default, only one input
parameter is supplied for input into the Transform XML activity. To supply more
than one value, use the Modify Statement button to create a list statement. In this
case, the list has two items, one for each of the input parameters of the stylesheet.
Each parameter is specified as a name/value pair. Notice that the name of each
parameter corresponds to the name specified for that parameter in the XSLT file.
The output of the Transform XML activity is a binary stream containing the
parsed XML. In our example process definition, we must insert the transformed
data into a database table. To map the transformed data into the database
UPDATE statement, the data must first be represented as a schema. To do this, we
use the Parse XML activity to parse the binary output of Transform XML into an
XML schema. Figure 18 illustrates the mapping of the Transform XML output into
the input of the Parse XML activity.
The Parse XML activity requires a string for input. The function
base64-to-string($TransformXML/xmlOutput) converts the binary output of
the Transform XML activity into the string required by the Parse XML activity.
The Shared Configuration palette holds resources that can be shared among
activities. These resources include database connections, WSDL files, schema
definitions, and connections to other servers. This chapter describes the shared
configuration resources available in TIBCO BusinessWorks and the activities that
make use of each resource.
Topics
BusinessConnect Connection
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the shared
configuration item.
Show Advanced Displays the advanced fields for locating local and
remote repositories.
User Name The user name for the repository. This is optional.
Field Description
Password The password for the repository. This is optional.
Timeout (msec) Timeout (in milliseconds) to wait for the list of remote
repositories to load. The default is 5000 milliseconds
(5 seconds).
Advanced
Advanced tab lists connection details used by the TIBCO BusinessWorks to
interact with the TIBCO BusinessConnect server. These fields are automatically
populated based on the Repository Name, Installation Name, and Protocol Name
selection in the Configuration tab.
Normally, users should not change these values. Doing so may cause problems in
the BusinessConnect activities. Use caution if it is necessary to alter the values of
the fields on the Advanced tab.
Field Description
Installation Name Installation name of the BusinessConnect server.
Field Description
Daemon TIBCO Rendezvous daemon for interaction between
TIBCO BusinessWorks and the TIBCO
BusinessConnect server.
Ledger File Name TIBCO Rendezvous certified ledger file name for
interaction between TIBCO BusinessWorks and the
TIBCO BusinessConnect server.
You can replace these values with custom values, however, be careful, or your
configuration setup may fail.
Data Format
Figure 19 illustrates how an input text string is parsed into a specified data
schema.
When rendering text, each record in the input data schema is transformed into a
line of output text. The first item of the data schema is transformed into the first
column of the text line, the second item is transformed into the second column,
and so on. Each record in a repeating data schema is transformed into a separate
line in the output text string. Rendering a data schema into a text string is exactly
the opposite process of parsing a text string into a data schema. Rendering is the
reverse of the process illustrated in Figure 19.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
Format Type The type of formatting for the text. The text can be
either "Delimiter separated" or "Fixed format".
In delimiter-separated text, each column is separated
by a delimiter character, specified in the Column
Separator field. Each line is separated by the character
specified in the Line Separator field.
In Fixed format text, each column occupies a fixed
position on the line. For fixed format text, you must
specify the Fill Character, the line length, and the
column offsets. See Field Offsets on page 307 for more
information.
Line Separator The character(s) that determine the end of each line.
When parsing text, each line is treated as a new record
in the output data schema. When rendering text, each
data record is separated by the line separator
character in the output text string.
Data Format
The Data Format tab allows you to define a custom schema for the text.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Data Format tab is used to parse a text string into the specified schema or
render the specified schema as a text string.
See Appendix A, Specifying Data Schema, on page 341 for a description of how to
define a schema.
Field Offsets
When processing fixed format text, you must specify the line length and the
column offsets. This allows a Parse Data or Render Data activity to determine
where columns and lines begin and end. The Field Offsets tab allows you to
specify the format of fixed-width text.
The line length is the total length of each input line, including the line separator
character(s). Include the appropriate number of characters for the selected line
separator on the Configuration tab to the total length of each line.
The column offset is the starting and ending character position on each line for the
column. Each line starts at 0 (zero). For each column of the line, you must specify
the name of the data item associated with this column (this is the same name you
specified for the corresponding element in the data schema), the starting offset for
the column, and the ending offset for the column.
It is a good idea to have each column offset begin where the last column offset
ended. Many fixed format data files are used by databases (for example, ISAM
files) or are generated by automated processes. These types of files have rigid file
record formats and may not have additional padding space between columns.
When you define each column offset to begin where the last column offset ends,
the data can be read more quickly by TIBCO BusinessWorks because the bytes of
the input records can be read in sequentially.
Consider the following text file. The first two lines of the file indicate offset
numbers (each 0 indicates another 10 characters), and the fill character between
columns is spaces:
0 12 30 45
0123456789012345678901234567890123456789012345678901234567
57643 Smith Chris Account
57644 Jones Pat Marketing
57645 Walker Terry Develpment
Figure 20 illustrates the Field Offset tab for the file above. Notice that the line
length is specified as 60, even thought the offsets end at character number 58. The
line separator is specified as "Carriage Return/Line Feed (windows)", so this adds
two additional characters for a total line length of 60.
FTP Connection
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
User Name User name to use when logging into the FTP server.
HTTP Connection
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
Use Secure Socket Specifies whether incoming requests can use the
(HTTPS) HTTPS (secure socket layer or SSL) protocol. This
protocol authenticates the server to the client, and
optionally authenticates the client to the server.
Enabling this field allows you to specify the Trusted
Certificate Location, Server Key Store, Key Password,
and Client Authentication Request fields.
Static variables are not supported within Java custom functions. Do not write
custom functions that use static variables.
If there are different classes that have methods with the same names, the Prefix
field allows you to specify a prefix for qualifying which method you wish to use
in an XPath function. See the description of the Prefix field below for more
information.
See TIBCO BusinessWorks Process Design Guide for more information about
building XPath expressions and using the XPath editor.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
Prefix A folder with the name you specify in this field
appears within the Functions tab in the XPath
editor. You can drag and drop methods from the
loaded class into your XPath expression, just as
you would with any standard XPath function.
This is also the name to use to prefix the function
names in this class, if multiple classes are loaded
and function names are not unique among the
classes.
For example, if you have class1.method1 and
class2.method1, you will need to specify "class1"
in the Prefix field when you load class1 into a Java
Custom Resource. You would specify "class2" in
the prefix field when loading class2. When using
method1 in XPath expressions, you must qualify
which method1 you are using by specifying
class1:method1 or class2:method1 in the XPath
expression.
The value of this field must be unique across all
loaded Java Custom Function resources, and the
value must be a valid XPath identifier. Also, you
cannot use global variables (that is, %variable%) in
this field.
Class File The location of the class file you wish to load. Use
the Browse button to locate the class file.
Note: This field is used to locate the file initially,
but the file is actually loaded and stored in the
repository. Once the file is loaded, it can be
removed from its original location in the file
system. If you wish to change the file stored in the
repository, you can use this field to reload a
changed file or load a new file for this resource.
/**
* The following method will not be available because it is
* a constructor.
*/
public Sample(int value)
{
mInternalValue = value;
}
/**
* This method is used to concat two strings together. It
* must be declared as public static to be made available in
* TIBCO BusinessWorks.
*/
public static String stringConcat(String s1, String s2)
{
return s1 + s2;
}
/**
* This method is used to add two ints together. Note, that
* it takes both an int type and an Integer object.
*/
public static int intAdd(int lhs, Integer rhs)
{
return lhs + rhs.intValue();
}
/**
* The following method will not be available because it
* throws an exception.
*/
public static int badAdd(int lhs, int rhs)
throws Exception
{
long result = lhs + rhs;
if (result > Integer.MAX_VALUE) {
throw new ArithmeticException();
}
return new Long(result).intValue();
}
/**
* The following method will not be availabe because it
* returns nothing: its void.
*/
public static void returnsNothing(String s)
{
System.out.println(s);
}
/**
* The following method will not be available because it
* is not static.
*/
public int add(int rhs)
{
return mInternalValue + rhs;
}
/**
* The following method will not be available becauses it
* is not public.
*/
protected static int protectedAdd(int lhs, int rhs)
{
return lhs + rhs;
}
}
JDBC Connection
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
JDBC Driver The name of the JDBC driver class. You can select
from a list of supported drivers.
If you select a supported driver, the Database URL
field is populated with a template for the URL of
the driver.
The following drivers are included in the TIBCO
BusinessWorks installation:
• tibcosoftwareinc.jdbc.oracle.
OracleDriver
• tibcosoftwareinc.jdbc.sqlserver.
SQLServerDriver
• weblogic.jdbc.mssqlserver4.Driver
Field Description
Maximum Connections The maximum number of database connections to
allocate. The default maximum is 10. The
minimum value that can be specified is 1.
TIBCO BusinessWorks creates a pool of JDBC
connections for every JDBC Connection shared
resource. The maximum size of this pool is
specified by this parameter.
Activities that use this JDBC Connection resource
are given a connection from the pool. Once the
maximum number of connections is reached,
activities requesting a connection cannot proceed.
Once a connection is freed by an activity, the
connection is returned to the pool. Connections
that are left open will eventually timeout and be
closed. These connections can be reopened at a
later time, until the maximum number of
connections specified in this field is reached.
If an activity detects a connection in the pool is
invalid (for example, the database is restarted), the
activity attempts to reestablish the connection.
All activities that are part of the same transaction
will use the same connection in the connection
pool. The first activity within a transaction can
attempt to reestablish an invalid connection. If a
connection becomes invalid during a transaction,
the transaction is rolled back and must be retried,
if necessary.
The Test Connection button allows you to test that the specified fields result in a
valid connection to a database.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Data
The Data tab allows you to define a custom schema for the JMS application
properties.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Data tab appears as "OtherProperties" on the Input or Output tab of the
JMS activity where this shared configuration resource is used.
See Appendix A, Specifying Data Schema, on page 341 for a description of how to
define a schema.
JMS Connection
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
User Name User name to use when logging into the JMS server.
If the JMS provider does not require authentication,
this field can be empty.
Not all JMS servers require user names and
passwords. Refer to your JMS provider
documentation and consult your system
administrator to determine if your JMS server
requires a user name and password.
JNDI Context Factory This is the initial context factory class for accessing
JNDI.
See your JNDI provider documentation for the name
of the InitialContextFactory class. For example,
TIBCO Enterprise for JMS provides the following
class:
com.tibco.tibjms.naming.TibjmsInitialContex
tFactory
Field Description
JNDI Context URL This is the URL to the JNDI service provider.
See your JNDI provider documentation for the syntax
of the URL. An example of a JNDI URL is the
following: tibjmsnaming://localhost:1099
JNDI User Name User name to use when logging into the JNDI server.
If the JNDI provider does not require authentication,
this field can be empty.
JNDI Password Password to use when logging into the JNDI server.
If the JNDI provider does not require authentication,
this field can be empty.
Advanced
The advanced tab has the following fields.
Field Description
Queue Connection The QueueConnectionFactory object stored in JNDI.
Factory This object is used to create a queue connection with a
JMS application.
See your JNDI provider documentation for more
information about creating and storing
QueueConnectionFactory objects.
Notify Configuration
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Data
The Data tab allows you to define a custom schema. The schema can be empty, if
you do not wish to pass data between processes.
You can define your own datatype on this tab, and you can reference XML schema
or ActiveEnterprise classes stored in the project. Once defined, the data specified
on the Data tab appears on the Input or Output tab of the Receive Notification,
Wait, or Notify activity where this shared configuration resource is used.
See Appendix A, Specifying Data Schema, on page 341 for a description of how to
define a schema.
Proxy Configuration
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Rendezvous Transport
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
Daemon In the case of TIBCO Rendezvous daemon running on
the same machine as TIBCO BusinessWorks process
engine, this is not specified. If Rendezvous is running
on a different machine, then the Daemon field is
specified as the remote host name followed by the
socket number.
For example:
tcp:acct_host:6555
or
<port number>
Advanced
The advanced tab has the following fields.
Field Description
RV Type The type of TIBCO Rendezvous connection to use.
This can be reliable (standard RV transport), certified
(RVCM), or Distributed Queue (RVCMQ).
The fields of the advanced tab correspond to the value
selected for this field.
Certified Transport
Field Description
Ledger File The name and location of the persistent ledger file
that tracks certified messages. If not specified, the
certified message ledger is kept in process memory
only.
Sync Ledger File Specifies whether to keep the ledger file synchronous
with the current messages.
Relay Agent Name of the relay agent to use. Relay agents are
useful when clients are disconnected from the
network from time to time. The relay agents store
inbound certified messages and labeled messages
(and other messages related to certified delivery
features) on behalf of their disconnected client
programs. When a client is connected, it receives
inbound messages immediately.
Require Old Message Check this box if you wish to require the retention of
messages for which delivery has not been confirmed.
These messages will be resent.
Message Timeout The time limit (in seconds) for certified message
(sec) delivery.
Worker Weight The weight of the worker (this pertains to the worker
processing queue requests, not to BusinessWorks
process engines). Relative worker weights assist the
scheduler in assigning tasks. When the scheduler
receives a task, it assigns the task to the available
worker with the greatest worker weight.
Worker Tasks Sets the task capacity for the worker (this pertains to
the worker processing queue requests, not to
BusinessWorks process engines). Task capacity is the
maximum number of tasks that a worker can accept.
When the number of accepted tasks reaches this
maximum, the worker cannot accept additional tasks
until it completes one or more of them.
Field Description
Schedule Weight Weight represents the ability of this member to fulfill
the role of scheduler, relative to other members with
the same name. Cooperating distributed queue
transports use relative scheduler weight values to
elect one transport as the scheduler; members with
higher scheduler weight take precedence. Acceptable
values range from 1 to 65535.
Schedule Activation When the heartbeat signal from the scheduler has
been silent for this interval (in seconds), the member
with the greatest scheduler weight takes its place as
the new scheduler. All members with the same name
must specify the same value for this parameter. The
value must be positive
Trusted CA
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Schema Definition
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Schema Contents The contents of the XML schema. You can type in the
contents of the file, or you can import an existing file
by using the Browse button.
Workflow Schema
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Editor
The Editor tab allows you to define a custom schema for the manual task.
The schema defined by this resource is similar to a TIBCO InConcert class.
However, the definition of the schema is stored in the TIBCO BusinessWorks
project, and no TIBCO InConcert class is created. Only Document, String, Integer,
and Date/Time datatypes can be used in the Workflow schema.
Document is a special datatype for use with Manual Work activities. This schema
item is used to upload/download documents from the Workflow Server for a
particular manual work task. This is a complex datatype that contains two
elements: name (string) and content (binary).
You define a schema in the same way you define schema for other types of
activities in TIBCO BusinessWorks. The only exception is that the schema is
restricted as described above. See Appendix A, Specifying Data Schema, on
page 341 for a complete description of using the Editor tab.
Output View
This tab displays the output of an activity that uses this Workflow Schema
resource. The displayed output schema contains all attributes defined in this
resource and all attributes inherited from the schema in the Extends From field on
the Configuration tab.
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
The Test Connection button can be used to verify the connection using the
specified configuration.
WSDL File
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Field Description
Mode One of the following:
• Import File — Import a WSDL file stored on disk.
• Import URL — Import a WSDL file using a URL.
• Generate — Create a new WSDL file using XML
schemas stored in the project. This is used to
create abstract service descriptions based on
existing, stored schema files.
Import File
Import URL
Location The URL of the WSDL file to import. Click the Load
WSDL button once the URL has been located to
import the WSDL code into the repository. The WSDL
code appears on the Source tab once it has been
imported.
You can import WSDL files that contain abstract,
concrete, or a mixture of both types of service
descriptions.
The Check URL button allows you to check whether
the specified URL is active.
You can also use UDDI search services to locate Web
Service WSDL files or retrieve WSIL files from web
service providers. See Using WSIL and UDDI on
page 332 for more information.
Operation Name The name of the web services operation. This is the
name used within a SOAP request to perform the
operation within the web service.
Field Description
Input Schema The input schema of the operation. You can browse
and select a schema definition shared resource for this
field.
Output Schema The output schema of the operation. You can browse
and select a schema definition shared resource for this
field.
Source
The source tab displays the source of the WSDL file. The source appears after the
Import or Generate buttons are clicked on the Configuration tab. If the source file
or generated file specification changes after the file has been placed in the
repository, click the Import or Generate button again to re-import or regenerate
the file.
Field Description
URL The URL of the UDDI search service or the
address to use to retrieve a WSIL file.
When UDDI is selected, there are several
UDDI services provided in a drop-down list,
or you can enter the desired URL by typing it
into this field.
When WSIL is selected, you can enter the
URL of the web service provider, if the
provider supplies WSIL files.
Field Description
Search Type The type of search. The types of searches
available depend upon whether UDDI or
WSIL is selected in the URL field.
There are several types of searches defined by
UDDI. This field provides a drop-down list of
available search types for the selected UDDI
service. Each search type may be performed
differently. Help is provided in blue text at
the bottom of the dialog for the selected
search type. See Search Type on page 335 for
more information about different types of
UDDI searches.
Field Description
Timeout (msec) Specifies the amount of time (in milliseconds)
to wait before cancelling the search. Some
search directories can take significant time
when searching. This field allows you to
timeout the search if it is not performed
promptly.
Search Type
Some UDDI search types provide a list of web services. Other search types
provide a directory of service types that you can select and explore for specific
web services. The search type determines the kind of search that is performed.
When a specific type is specified in the Search Type field, help for how to perform
that search type appears in blue at the bottom of the dialog. Also, either the Get
Services or the Explore button is enabled depending upon the type of search
selected.
XML Document
Configuration
The configuration tab has the following fields.
Field Description
Name The name to appear as the label for the resource.
Document contents The contents of the XML file. You can type in the
contents of the file, or you can import an existing file
by using the Browse button.
XSLT File
The XSLT File resource allows you to load an XSLT file to use to
transform XML schemas using the Transform XML activity. See
Transform XML on page 294 for more information about using this
shared configuration resource within a Transform XML activity.
A transformation expressed in XSLT is called a stylesheet. A stylesheet contains a
set of template rules. Each template rule has two parts: a pattern that is matched
against nodes in the source document and a template that can be instantiated to
form part of the result document.
A transformation expressed in XSLT describes rules for transforming a source
document into a result document. The transformation is achieved by associating
patterns with templates. A pattern is matched against elements in the source
document. A template is instantiated to create all or part of the result document.
The structure of the result document can be completely different from the
structure of the source document. In constructing the result document, elements
from the source document can be filtered and reordered, and arbitrary structure
can be added.
The XSLT File resource allows you to add and edit XSLT source, view or modify
templates and their parameters, and view or modify stylesheets and their
parameters. This section describes how to use the XSLT File resource to store and
modify XSLT source. It is beyond the scope of this document to completely
describe XSLT. See http://www.w3.org/TR/xslt for the XSLT specification.
Different tabs appear in the configuration panel appear based on which tab is
selected in the design panel. The following describes the configuration panel tabs
and when they are enabled:
Available
when This
Configuration
Panel Tab Description Design Panel
Tab Is
Selected
Configuration Allows you to specify a name and Source,
short description of the XSLT File Templates,
resource. Stylesheet
Available
when This
Configuration Description Design Panel
Panel Tab
Tab Is
Selected
Parameters Allows you to modify the parameters Templates,
of the item selected in the design Stylesheet
panel.
For example, when the Templates tab
is selected, this tab allows you to
modify the parameters of the template
selected in the design panel. When the
Stylesheet tab is selected, this tab
allows you to modify global
parameters for the stylesheet.
Parameters are edited in the same way
that schemas are edited. XSLT
parameters are limited to datatypes
available in XSLT: string, decimal,
boolean, a reference to an XML
element, or "any" type (any available
XSLT type). See Appendix A,
Specifying Data Schema, on page 341
for more information about editing
schemas.
There are also four buttons that appear on the toolbar when editing the XSLT File
shared configuration resource. The following describes these toolbar buttons:
Available
when This
Toolbar Button Description Design Panel
Tab Is
Selected
Load Stylesheet. Allows you to Source,
browse your file system for a Templates,
stylesheet file to load into this Stylesheet
resource.
Many activities within TIBCO BusinessWorks allow you to specify a custom data
schema for input or output of the activity. This appendix describes the mechanism
for specifying a custom data schema for an activity’s input or output.
Topics
Schema
The Schema tab is used to specify a data schema for input or output of an activity.
This is useful when the data does not have a well-known structure. The Schema
tab is usually named for the type of schema you are creating. For example, the tab
may be named "Input Schema" or "Output Schema".
For example, an email message has a well-known data structure, and therefore
does not need a special datatype for its input. A JMS message, however, can have
application-specific properties of any datatype. The Schema tab allows you to
define the schema for any activities that require a specialized input or output
schema.
You can use a simple datatype, or you can define a group of data elements on this
tab. You can also reference XML schema or ActiveEnterprise classes stored in the
project. Once defined, the schema appears on the Input tab, the Output tab, or
both tabs of the activity. The data within the schema then becomes available to
other activities within the process definition.
The following illustrates the Schema tab. In this example, the Schema tab is
labeled "Output Schema" indicating this is the activity’s output.
To define a schema on this tab, use the icons above the schema tree to add, delete,
or move data items. Then use the fields of the dialog to specify the datatype of
each item.
Field Description
Name The name of the data item.
Field Description
Cardinality The qualification for the data item. Data items can be
specified as one of the following:
• Required — the data item is required and must be
supplied when the process is called.
• Optional — the data item is optional.
• Repeating, Zero or More — The data item is a list
that has zero or more elements.
• Repeating, One or More — The data item is a list
that has one or more items.
Schema Name Stored XML schema that contains the element or type
you wish to reference.
Icon Description
Complex element. Container for other datatypes. This is a
branch in the schema tree.
Icon Description
Integer value. You can specify the size of the integer as one of
the following:
• Byte
• Short
• Int
• Long
• Unsigned Byte
• Unsigned Int
• Unsigned Long
• Integer
• Positive Integer
• Negative Integer
• Non-positive Integer
• Non-negative Integer
Boolean value.
Icon Description
Base 64 or hexidecimal value.
Index
A Read File 80
Receive Mail 208
ActiveEnterprise Adapter palette 33 Receive Misc Msg 59
activities Receive Notification 110
Adapter Request-Response Server 34 Receive Request/Notification 60
Adapter Subscriber 36 Receive Response 62
Assign Work 224 Remove File 82
Call Process 92 Render 253
Checkpoint 93 Render XML 292
Confirm 95 Rendezvous Subscriber 258
Create File 76 Reply to JMS Message 191
Download Document 229 Reply to Rendezvous Request 260
External Command 96 Respond to Adapter Request 45
File Poller 77 Retrieve Resources 273
FTP Get 68 Send HTTP Request 123
FTP Put 71 Send HTTP Response 129
Generate Error 99 Send Mail 209
Get Work Status 232 Send Misc Msg 63
HTTP Receiver 120 Send Rendezvous Request 262
Invoke an Adapter Request-Response Service 39 Send Request/Notification 64
Java Code 102 Send Response 65
JDBC Call Procedure 140 Sleep 112
JDBC Query 143 SOAP Event Source 273
JDBC Update 148 SOAP Request Reply 277
JMS Queue Receiver 163 SOAP Send Fault 283
JMS Queue Requestor 167 SOAP Send Reply 286
JMS Queue Sender 173 SQL direct 156
JMS Topic Publisher 177 Timer 113
JMS Topic Requestor 181 Transform XML 294
JMS Topic Subscriber 187 Wait 114
Label 106 Wait for Adapter Message 47
Map Data 107 Wait for Adapter Request 52
Modify Work 236 Wait for Completion 241
Notify 108 Wait for File Change 84
Null 110 Wait for HTTP Request 133
Parse 248 Wait for JMS Queue Message 195
Parse XML 290 Wait for JMS Topic Message 200
Publish Rendezvous Message 256 Wait for Rendezvous Message 265
Publish to Adapter 42 Write File 89
E
B
Email resource 28
BusinessConnect Connection resource 302 executing a command in the event of a failure 29
BusinessConnect palette 57 External Command activity 96
C F
Call Process activity 92 failures 20
Checkpoint activity 93 executing a command 29
Component failure event 21 recovery specification 21
Confirm activity 95 sending email 28
confirming a message 95 File palette 75
conventions used in this manual xxi File Poller activity 77
CPU resource 7 FTP Connection shared configuration 308
Create File activity 76 FTP Get activity 68
creating schemas 342 FTP palette 67
Custom resource 29 FTP Put activity 71
customer support xxi
G
D
General Activities palette 91
Data Format resource 304 Generate Error activity 99
H L
handling failures 20 Label activity 106
HTTP Connection shared configuration 309 Log Event resource 24
HTTP palette 119
HTTP Receiver activity 120
M
I Machine resource 3
machines
interaction with TIBCO InConcert 223 Any Failure resource 20
inter-process communication monitoring 5
Notify 108 CPU 7
Notify Configuration 321 disks 7
Wait 114 processes 8
Invoke an Adapter Request-Response Service Mail palette 207
activity 39 Manual Work palette 213
how to work with tasks 218
overview 214
TIBCO InConcert 223
J working with documents 217
Map Data activity 107
Java Code activity 102 mapping
Java Custom Function shared configuration 311 with XSLT 336
JDBC Call Procedure activity 140 messages
JDBC Connection shared configuration 315 confirming 95
JDBC palette 139 Modify Work activity 236
working with the Query Designer 151 Monitor resource 5
JDBC Query activity 143 monitoring
Query Designer 151 CPU 7
JDBC Update activity 148 disks 7
JMS Application Properties shared configuration 318 example 5
JMS Connection shared configuration 318 restarting machines 25
JMS palette 159 sending email 28
JMS properties 160
JMS Queue Receiver activity 163
JMS Queue Requestor activity 167
JMS Queue Sender activity 173 N
JMS Topic Publisher activity 177
JMS Topic Requestor activity 181 Notify activity 108
O
Q
overview
Manual Work palette 214 Query Designer 151
TIBCO BusinessConnect palette 58
R
P
Read File activity 80
palettes Receive Mail activity 208
ActiveEnterprise Adapter 33 Receive Misc Msg activity 59
BusinessConnect 57 Receive Notification activity 110
Deployment Configuration 2 Receive Request/Notification activity 60
File 75 Receive Response activity 62
FTP 67 Recovery resource 21
General Activities 91 Remove File activity 82
HTTP 119 Render activity 253
JDBC 139 Render XML activity 292
JMS 159 Rendezvous palette 255
Mail 207 Rendezvous Subscriber activity 258
Manual Work 213 Rendezvous transport shared configuration 322
Parse 247 Reply To JMS Message activity 191
Process 31 Reply to Rendezvous Request activity 260
Rendezvous 255 resources
Shared Configuration 301 Adapter 17
SOAP 269 Alert 26
XML 289 Any Failure 20
Parse activity 248 Component failure event 21
Parse palette 247 CPU 7
Parse XML activity 290 Custom 29
Process Engine resource 9 Deployment Configuration 2
process engines Disk 7
Any Failure resource 20 Email 28
executing commands on failure 29 Log Event 24
recovery from failure 21 Machine 3
recovery from failures 12 Monitor 5
restarting after failure 25 Process 8
Process palette 31 Process Engine 9
Process resource 8 Recovery 21
S
T
Schema Definition shared configuration 326
Send HTTP Request activity 123 technical support xxi
Send HTTP Response activity 129 TIBCO BusinessConnect
Send Mail activity 209 overview of working with 58
Send Misc Msg activity 63 TIBCO InConcert 223
Send Rendezvous Request activity 262 Timer activity 113
Send Request/Notification activity 64 Transform XML activity 294
Send Response activity 65 Trusted CA shared configuration 325
sending
alerts to the console 26
email 28
shared configuration 301 U
Data Format 304
FTP Connection 308 UDDI 332
HTTP Connection 309
Java Custom Function 311
JDBC Connection 315
JMS Application Properties 318 W
JMS Connection 318
Notify Configuration 321 Wait activity 114
Proxy Configuration 321 Wait for Adapter Message activity 47
Rendezvous transport 322 Wait for Adapter Request activity 52
Schema Definition 326 Wait for Completion activity 241
Trusted CA 325 Wait for File Change activity 84
Workflow Schema 327 Wait for HTTP Request activity 133
Workflow Server Connection 328 Wait for JMS Queue Message activity 195
WSDL File 329 Wait for JMS Topic Message activity 200
XML document 336 Wait for Rendezvous Message activity 265
XSLT File 336 web services
Sleep activity 112 locating 332
SOAP Event Source activity 273 Workflow Schema shared configuration 327
SOAP palette 269 Workflow Server Connection shared
SOAP Request Reply activity 277 configuration 328
SOAP Send Fault activity 283 working with
SOAP Send Reply activity 286 documents in manual tasks 217
X
XML Document shared configuration 336
XML palette 289
XSLT File shared configuration 336