TIBCO ActiveMatrix Adapter Framework Reference ®

TIBCO ActiveMatrix Adapter Framework Reference ®
TIBCO ActiveMatrix® Adapter Framework
Reference
Software Release 1.3
February 2016
Two-Second Advantage®
2
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY
(OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND
CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED
SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE
CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD
OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE)
OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER
LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE
SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND
YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE
BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws
and treaties. No part of this document may be reproduced in any form without the written
authorization of TIBCO Software Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix Adapter for Database, TIBCO ActiveMatrix
Adapter for Database (TIBCO Business Studio), TIBCO ActiveMatrix Adapter for Files for Unix/Win,
TIBCO ActiveMatrix Adapter for Files for Unix/Win (TIBCO Business Studio), TIBCO ActiveMatrix
Adapter for SAP, TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio), TIBCO ActiveMatrix
Adapter Framework, TIBCO ActiveMatrix BusinessWorks, TIBCO Adapter SDK, TIBCO Business
Studio, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Rendezvous, and
TIBCO Runtime Agent are either registered trademarks or trademarks of TIBCO Software Inc. in the
United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise
Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of
Oracle Corporation in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT
ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED
AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE
VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL
ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE
CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO
SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S)
AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE,
INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 2010-2016 TIBCO Software Inc. All rights reserved.
TIBCO Software Inc. Confidential Information
TIBCO ActiveMatrix® Adapter Framework Reference
3
Contents
TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
Adapter Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Adapter Request-Response Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Adapter Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
Invoke an Adapter Request-Response Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Publish to Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Respond to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Send Exception to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Wait for Adapter Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Wait for Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Transport Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Supported Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
TIBCO ActiveMatrix® Adapter Framework Reference
4
TIBCO Documentation and Support Services
Documentation for this and other TIBCO products is available on the TIBCO Documentation site. This
site is updated more frequently than any documentation that might be included with the product. To
ensure that you are accessing the latest available help topics, please visit:
https://docs.tibco.com
Product-Specific Documentation
Documentation for TIBCO products is not bundled with the software. Instead, it is available on the
TIBCO Documentation site. To directly access documentation for this product, double-click the
following file:
TIBCO_HOME/release_notes/TIB_adapteruipack_version_docinfo.html
where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows,
the default TIBCO_HOME is C:\Program Files\tibco. On UNIX systems, the default TIBCO_HOME
is /opt/tibco.
The following documents for this product can be found in the TIBCO Documentation site:
●
TIBCO ActiveMatrix Adapter Framework Administration
●
TIBCO ActiveMatrix Adapter Framework Reference
●
TIBCO ActiveMatrix Adapter Framework Installation
●
TIBCO ActiveMatrix Adapter Framework Release Notes
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact TIBCO Support:
●
For an overview of TIBCO Support, and information about getting started with TIBCO Support,
visit this site:
http://www.tibco.com/services/support
●
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name, you can
request one.
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a
place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers
forums, blogs, and access to a variety of resources. To register, go to the following web address:
https://www.tibcommunity.com
TIBCO ActiveMatrix® Adapter Framework Reference
5
Adapter Palette Overview
Adapter Palette contains activities for communicating with configured TIBCO adapters. You can
publish messages to a specified adapter or invoke an operation of an adapter.
TIBCO adapters provide a bridge between an application and the TIBCO integration environment.
With TIBCO adapters, packaged applications, databases, and other technologies can be used in the
enterprise information flow, regardless of their data formats or communication protocols.
After installing TIBCO ActiveMatrix® Adapter Framework, the following activities from the Adapter
palette are available in TIBCO Business Studio:
●
Adapter Request-Response Server: starts a process based on the receipt of a request from an
adapter.
●
Adapter Subscriber: subscribes to incoming data published by an adapter.
●
Invoke an Adapter Request-Response Server: communicates (as a client) with Request-Response
Service.
●
Publish to Adapter: publishes data from a business process to an adapter, which subscribes to data
coming from the process and passes the data to the target application.
●
Respond to Adapter Request: sends a response to an adapter for a previously received request.
●
Send Exception to Adapter Request: sends an exception to an adapter for a previously received
request.
●
Wait for Adapter Message: waits for the receipt of a message from Publication Service of a specified
adapter.
●
Wait for Adapter Request: waits for the receipt of a request from Request-Response Invocation
Service.
The following figure shows the Palette Library panel in TIBCO Business Studio and activities available
in the Adapter Palette panel:
TIBCO ActiveMatrix® Adapter Framework Reference
6
Adapter Request-Response Server
The Adapter Request-Response Server activity is a process starter activity. It starts a process based on
the request received from an adapter.
Adapter Request-Response Invocation Service is configured during adapter configuration, and the
activity uses the information in the adapter configuration to configure this activity.
The following figure illustrates an Adapter Request-Response Server activity starting a business
process to handle an incoming request from Request-Response Invocation Service. In the business
process, the Respond to Adapter Request activity is used to perform the response at a later point.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is AdapterRequest-ResponseServer.
Adapter Service
No
The preconfigured Request-Response Invocation Service. You
must specify the adapter service when configuring the adapter.
Click
Operation
No
to locate the appropriate service for this activity.
Operations defined by the schema used in the selected adapter
service.
Select the operation that the process implements from the list.
TIBCO ActiveMatrix® Adapter Framework Reference
7
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
configure an output schema for this activity.
If you select the check box, you can configure the output schema
in the Output Editor tab.
The feature of Custom Schema in TIBCO ActiveMatrix
BusinessWorks™ 6 is the same as CustomAESchema in
TIBCO ActiveMatrix BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Advanced
The Advanced tab has the following fields:
Field
Module
Property?
Description
Transport Type
No
Select a transport type. See Transport Type for more information.
Sequence Key
No
This field contains an XPath expression that specifies how to run
processes in order. Process instances with sequencing keys that
evaluate to the same value are executed sequentially in the order
the process instances were created.
To edit the XPath expression, click
.
For more information about XPath expressions and how to control
the execution of process instances in order, see TIBCO ActiveMatrix
BusinessWorks Application Development.
Custom Job Id
No
This field contains an XPath expression that specifies a custom ID
for the process instance. This ID is also available in the $_process
context process variable.
To edit the XPath expression, click
.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
You can use the schema to define the structure of the retrieved messages. The schema defined in the
Output Editor tab becomes the body of the message in the Output tab.
Conversations
You can initiate the conversation. Click Add New Conversation
to initiate multiple conversations.
TIBCO ActiveMatrix® Adapter Framework Reference
8
For details about conversations, see TIBCO ActiveMatrix BusinessWorks Application Development.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
subject
String
The subject of the message.
replySubject
String
The reply subject of the message.
certifiedSequence
String
This element contains the sequence number in which this
message was received.
Number
It is available only when Tibrv Certified is the transport.
certifiedSender
String
This element contains the CM name of the message sender.
It is available only when Tibrv Certified is the transport.
MessageID
String
The ID of the message.
This element is available only when JMS Queue or JMS
Topic is the transport.
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name + User_Part
(Business_Key).
JMSHeaders
Complex
This element contains the message header fields for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport.
For more information about message header fields, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
OtherProperties
Complex
This element contains the message properties for the message.
Only properties applicable to this type of message are
displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport
Type configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
body
Complex
A complex schema type specified for the adapter service or a
complex schema type designated by a user.
TIBCO ActiveMatrix® Adapter Framework Reference
9
Adapter Subscriber
The Adapter Subscriber activity is a process starter activity. It starts a process based on the receipt of a
message from Publication Service of the specified adapter.
Publication Service is configured during adapter configuration, and the activity uses the information in
the adapter configuration to configure this activity.
The following figure illustrates Publication Service publishing a message and Adapter Subscriber
starting a business process.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is AdapterSubscriber.
Adapter Service
No
The preconfigured Publication Service. You must specify the
adapter service when configuring the adapter.
Click
to locate the appropriate service for this activity.
TIBCO ActiveMatrix® Adapter Framework Reference
10
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for the activity.
●
Cleared (default): The Output Editor tab is read-only.
●
Selected: The Output Editor tab is editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Advanced
The Advanced tab has the following fields:
Field
Module
Property?
Description
Transport Type
No
Select a transport type. See Transport Type for more information.
Sequence Key
No
This field contains an XPath expression that specifies how
processes run in order. Process instances with sequencing keys
that evaluate to the same value are executed sequentially in the
order the process instances were created.
To edit the XPath expression, click
.
For more information about XPath expressions and how to
control the execution of process instances in order, see TIBCO
ActiveMatrix BusinessWorks Application Development.
Custom Job Id
No
This field contains an XPath expression that specifies a custom
ID for the process instance. This ID is also available in the
$_process context process variable.
To edit the XPath expression, click
.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
You can use the schema to define the structure of the retrieved messages. The schema defined in the
Output Editor tab becomes the body of the message in the Output tab.
TIBCO ActiveMatrix® Adapter Framework Reference
11
Conversations
You can initiate the conversation. Click Add New Conversation
to initiate multiple conversations.
For details about conversations, see TIBCO ActiveMatrix BusinessWorks Application Development.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
subject
String
The subject of the message.
replySubject
String
The reply subject of the message.
certifiedSequence
String
This element contains the sequence number in which this
message was received.
Number
It is available only when Tibrv Certified is the transport.
certifiedSender
String
This element contains the CM name of the message sender.
It is available only when Tibrv Certified is the transport.
MessageID
String
The ID of the message.
This element is available only when JMS Queue or JMS
Topic is the transport.
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." +
Application_Name + Module_Name + Process_Name +
Activity_Name + User_Part (Business_Key).
JMSHeaders
Complex
This element contains the message header fields for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport.
For more information about message header fields, see
"JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference.
OtherProperties
Complex
This element contains the message properties for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport
Type configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings
and Palette Reference.
TIBCO ActiveMatrix® Adapter Framework Reference
12
Output Item
Data Type
Description
body
Complex
A complex schema type specified for the adapter service or
a complex schema type designated by a user.
TIBCO ActiveMatrix® Adapter Framework Reference
13
Invoke an Adapter Request-Response Server
The Invoke an Adapter Request-Response Server activity is used to communicate with RequestResponse Service. This service invokes an operation with input and output of the adapter.
Invoke an Adapter Request-Response Service is configured based on adapter configuration, and the
activity uses the information in the adapter configuration to configure this activity.
The following figure illustrates an Invoke an Adapter Request-Response Server activity sending a
request to Request-Response Service.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is InvokeanAdapterRequest-
ResponseServer.
Adapter Service
No
The preconfigured Request-Response Service. You must specify
the adapter service when configuring the adapter.
Click
Operation
No
to locate the appropriate service for this activity.
Operations defined by the schema used in the selected adapter
service.
Select the operation that the process definition implements
from the list.
One Way
No
A read-only field that displays whether the selected operation
is one-way.
TIBCO ActiveMatrix® Adapter Framework Reference
14
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Input Editor tab and the Output
Editor tab are read-only.
●
Selected: The Input Editor tab and the Output Editor tab
are editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Advanced
The Advanced tab contains the Transport Type field. You can select a transport type in the Transport
Type list. For more information, see Transport Type.
Input Editor
The Input Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages
are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Input Editor tab becomes the body of the message in the Input tab.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Output Editor tab becomes the body of the message in the Output tab.
Input
The following table lists the input items for this activity:
Input Item
Data Type
Description
subject
String
The subject of the message.
requestTimeout
Integer
When publishing in request/reply mode, you can specify the
timeout (in milliseconds) to wait for the reply.
replySubject
String
The reply subject of the message.
TIBCO ActiveMatrix® Adapter Framework Reference
15
Input Item
Data Type
Description
businessKey
String
This string is appended to the AE tracking specified in the
trackingInfo field.
It is good practice to have all publishers in a process
use the same business key. Only the most recent
business key of the publisher is used in the tracking
info for the message.
OtherProperties
Complex
This element contains the message properties for the message.
Only properties applicable to this type of message are displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport Type
configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
replyDestination
String
A reply message can have a reply destination, so that the two
applications can communicate with incoming messages.
This element contains the reply subject (RV) or destination
(JMS) set on the reply message, if one is set. If no reply subject
or destination is set on the reply message, this element is not
populated.
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name + User_Part
(Business_Key).
JMSHeaders
Complex
This element contains the message header fields for the
message. Only properties applicable to this type of message are
displayed.
It is available only when JMS Queue or JMS Topic is the
transport.
For more information about message header fields, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
TIBCO ActiveMatrix® Adapter Framework Reference
16
Output Item
Data Type
Description
OtherProperties
Complex
This element contains the message properties for the message.
Only properties applicable to this type of message are
displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport
Type configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
body
Complex
A complex schema type specified for the adapter service or a
complex schema type designated by a user.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be serialized.
DeserializationException
The incoming response message cannot be serialized.
ConfirmationException
The message cannot be confirmed.
TimeoutException
A timeout error occurs.
OperationException
The adapter service returns an exception encountered while
performing the operation. Any exception class defined on the
schema can be returned.
The potential exceptions are displayed as a choice element for
activities after an error transition.
TIBCO ActiveMatrix® Adapter Framework Reference
17
Publish to Adapter
The Publish to Adapter activity publishes messages, which are received by Subscription Service.
Subscription Service is configured during adapter configuration, and the activity uses the information
in the adapter configuration to configure this activity.
The following figure illustrates a Publish to Adapter activity sending a message to a preconfigured
Subscription Service.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is PublishtoAdapter.
Adapter Service
No
The preconfigured Subscription Service. You must specify the
adapter service when configuring the adapter.
Click
RequestReply
No
to locate the appropriate service for this activity.
Select or clear the check box to specify whether the activity is
sending a request message and expecting a response message.
When this check box is selected, the Custom Schema check box
is selected automatically. The Publish to Adapter activity uses
the RequestReply schema specified by a user, rather than the
schema from the adapter service.
TIBCO ActiveMatrix® Adapter Framework Reference
18
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Input Editor tab and the Output
Editor tab are read-only.
●
Selected: The Input Editor tab and the Output Editor tab
are editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Advanced
The Advanced tab contains the Transport Type field. You can select a transport type in the Transport
Type list. For more information, see Transport Type.
Input Editor
The Input Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages
are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Input Editor tab becomes the body of the message in the Input tab.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Output Editor tab becomes the body of the message in the Output tab.
Input
The following table lists the input items for this activity:
Input Item
Data Type
Description
subject
String
The subject of the message.
requestTimeout
Integer
When publishing in request/reply mode, you can specify
the timeout (in milliseconds) to wait for the reply.
TIBCO ActiveMatrix® Adapter Framework Reference
19
Input Item
Data Type
Description
preRegisterListener
String
When using TIBCO Rendezvous Certified Messaging
(RVCM), you can specify the CM name(s) of the RVCM
subscriber(s). With preRegisterListener, the publisher can
preregister with any expected listeners.
If multiple CM names are specified, separate each CM
name with a comma.
Any listener preregistered on the Transport tab is also
preregistered with the listeners specified in this element.
See the TIBCO Rendezvous documentation for more
information about RVCM.
replySubject
String
The reply subject of the message.
businessKey
String
This string is appended to the AE tracking in the
trackingInfo field.
It is good practice to have all publishers in a
process use the same business key. Only the most
recent business key of the publisher is used in the
tracking info for the message.
OtherProperties
Complex
This element contains the message properties for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport
Type configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings
and Palette Reference.
body
Complex
A complex schema type specified for the adapter service or
a complex schema type designated by a user.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
replyDestination
String
A reply message can optionally have a reply destination, so
that the two applications can communicate with incoming
messages.
This element contains the reply subject (RV) or destination
(JMS) set on the reply message, if one is set. If no reply subject
or destination is set on the reply message, this element is not
populated.
TIBCO ActiveMatrix® Adapter Framework Reference
20
Output Item
Data Type
Description
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name + User_Part
(Business_Key).
MessageID
String
The ID of the message.
This element is available only when JMS Queue or JMS Topic
is the transport.
JMSHeaders
Complex
This element contains the message header fields for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport.
For more information about message header fields, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
OtherProperties
Complex
This element contains the message properties for the message.
Only properties applicable to this type of message are
displayed.
It is available only when JMS Queue or JMS Topic is the
transport and JMS Application Properties in the Transport
Type configuration are specified.
For more information about message properties, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
body
Complex
A complex schema type specified for the adapter service or a
complex schema type designated by a user.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be serialized.
TimeoutException
The specified timeout has been reached for the request/reply
operation.
TIBCO ActiveMatrix® Adapter Framework Reference
21
Respond to Adapter Request
The Respond to Adapter Request activity is used to send a response to an adapter for a received request
previously.
When the incoming adapter request requires a response from your process, the Respond to Adapter
Request activity is used to send that response.
The following figure illustrates how a Respond to Adapter Request activity sends a response to a
specified adapter for a request. The request is received from Request-Response Invocation Service.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is RespondtoAdapterRequest.
Reply For
No
Select an activity from the list. The Respond to Adapter Request
activity sends a response to the selected activity. The following
are available options:
●
AdapterRequest-ResponseServer
●
WaitforAdapterRequest
TIBCO ActiveMatrix® Adapter Framework Reference
22
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Input Editor tab is read-only.
●
Selected: The Input Editor tab is editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Description
In the Description tab, you can enter a short description for the activity.
Input Editor
The Input Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages
are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Input Editor tab becomes the body of the message in the Input tab.
Input
The following table lists the input items for this activity:
Input Item
Data Type
Description
businessKey
String
This string is appended to the AE tracking specified in the
trackingInfo field.
It is good practice that all publishers in a process use the
same business key. Only the most recent business key of
the publisher is used in the tracking info for the
message.
body
Complex
The schema definition for the response. The structure of this
element is retrieved from the adapter service of the activity.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be serialized.
TIBCO ActiveMatrix® Adapter Framework Reference
23
Fault
Thrown When...
ReplyException
The reply cannot be sent.
TIBCO ActiveMatrix® Adapter Framework Reference
24
Send Exception to Adapter Request
The Send Exception to Adapter Request activity is used to send an exception to an adapter for a
received request previously.
The Adapter Request-Response Server activity works as a process starter in a process. When you
perform the requested operation, an error might occur. With the Send Exception to Adapter Request
activity, you can return an exception to the adapter service with information about the exception.
The following figure illustrates a Send Exception to Adapter Request activity sending an exception to a
previously received request from an adapter.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is SendExceptiontoAdapterRequest.
Reply For
No
Select the activity for which this activity sends a response from
the list:
●
AdapterRequest-ResponseServer
●
WaitforAdapterRequest
TIBCO ActiveMatrix® Adapter Framework Reference
25
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Input Editor tab is read-only.
●
Selected: The Input Editor tab is editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Description
In the Description tab, you can enter a short description for the activity.
Input Editor
The Input Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map messages
are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Input Editor tab becomes the body of the message in the Input tab.
Input
The following table lists the input items for this activity:
Input Item
Data Type
Description
businessKey
String
This string is appended to the AE tracking specified in the
trackingInfo field.
It is good practice that all publishers in a process use the
same business key. Only the most recent business key of
the publisher is used in the tracking info for the message.
body
Complex
The schema definition for the response. The structure of this
element is retrieved from the adapter service of the activity.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be serialized.
TIBCO ActiveMatrix® Adapter Framework Reference
26
Fault
Thrown When...
ReplyException
The reply cannot be sent.
TIBCO ActiveMatrix® Adapter Framework Reference
27
Wait for Adapter Message
The Wait for Adapter Message activity waits for the receipt of a message from Publication Service of
the specified adapter.
The Wait for Adapter Message activity is used to listen to messages sent by publishers, and the
messages must conform to the custom schema specified by a user. The following figure illustrates when
Publication Service publishes a message and the Wait for Adapter Message activity receives the
message in a business process.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is WaitforAdapterMessage.
Adapter Service
No
The preconfigured Publication Service. You must specify the
adapter service when configuring the adapter.
Click
to locate the appropriate service for this activity.
TIBCO ActiveMatrix® Adapter Framework Reference
28
Field
Module
Property?
Custom Schema
No
Description
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Output Editor tab is read-only.
●
Selected: The Output Editor tab is editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Event
The Event tab has the following fields:
Field
Event Timeout
(seconds)
Module
Property?
Description
No
A timeout specified in seconds. The default value is 60.
If no value is specified in this field, the message waits
indefinitely.
If zero(0) is specified, the event is discarded immediately,
unless this activity has already been executed.
Activity Timeout
(msec)
No
The amount of time (in milliseconds) to wait if the message
arrives before this activity is executed in the process instance. If
the event times out, an error is logged and the event is
discarded.
This field contains an XPath expression that specifies the timeout
value for the activity.
To edit the XPath expression, click
.
Advanced
The Advanced tab contains the Transport Type field. You can select a transport type in the Transport
Type list. For more information, see Transport Type.
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
TIBCO ActiveMatrix® Adapter Framework Reference
29
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Output Editor tab becomes the body of the message in the Output tab.
Conversations
You can initiate the conversation. Click Add New Conversation
to initiate multiple conversations.
For details about conversations, see TIBCO ActiveMatrix BusinessWorks Application Development.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
subject
String
The subject of the message.
replySubject
String
The reply subject of the message.
certifiedSequence
String
This element contains the sequence number in which this
message was received.
Number
It is available only when Tibrv Certified is the transport.
certifiedSender
String
This element contains the CM name of the message sender.
It is available only when Tibrv Certified is the transport.
MessageID
String
The ID of the message.
This element is available only when JMS Queue or JMS
Topic is the transport.
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name + User_Part
(Business_Key).
body
Complex
A complex schema type specified for the adapter service or a
complex schema type designated by a user.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
DeserializationException
The outgoing message cannot be serialized.
ConfirmationException
The message cannot be confirmed.
TIBCO ActiveMatrix® Adapter Framework Reference
30
Fault
Thrown When...
ActivityTimeoutException
A timeout error occurs.
TIBCO ActiveMatrix® Adapter Framework Reference
31
Wait for Adapter Request
The Wait for Adapter Request activity waits for the receipt of a request from Request-Response
Invocation Service.
The adapter sends a request using a preconfigured service, and the process implements the request.
The process sends any required responses back to the adapter service by placing the Respond to
Adapter Request activity at a later point in the process.
Adapter Request-Response Invocation Service is configured during adapter configuration, and the
activity uses the information in the adapter configuration to configure this activity.
The following figure illustrates a Wait for Adapter Request activity waiting for a request from RequestResponse Invocation Service. In the business process, a Respond to Adapter Request activity sends the
response at a later point.
General
The General tab has the following fields:
Field
Module
Property?
Name
No
Description
The name displayed as the label for the activity in the process
definition.
The default value is WaitforAdapterRequest.
Adapter Service
No
The preconfigured Request-Response Invocation Service. You
must specify the adapter service when configuring the adapter.
Click
to locate the appropriate service for this activity.
TIBCO ActiveMatrix® Adapter Framework Reference
32
Field
Module
Property?
Operation
No
Description
Operations defined by the schema used in the selected adapter
service.
Select the operation that this process definition implements
from the list.
Custom Schema
No
Select or clear the check box to specify whether you want to
supply an output class for this activity.
●
Cleared (default): The Output Editor tab is read-only.
●
Selected: The Output Editor tab is editable.
The feature of Custom Schema in TIBCO
ActiveMatrix BusinessWorks 6 is the same as
CustomAESchema in TIBCO ActiveMatrix
BusinessWorks 5.
Transport
Configuration
Click the Transport Configuration link to configure a transport
in the Advanced tab.
Description
In the Description tab, you can enter a short description for the activity.
Event
The Event tab has the following fields:
Field
Event Timeout
(seconds)
Module
Property?
Description
No
A Timeout specified in seconds. The default value is 60.
If no value is specified in this field, the message waits
indefinitely.
If zero(0) is specified, the event is discarded immediately,
unless this activity has already been executed.
Activity Timeout
(msec)
No
The amount of time (in milliseconds) to wait if the message
arrives before this activity is executed in the process instance. If
the event times out, an error is logged and the event is
discarded.
This field contains an XPath expression that specifies the
timeout value for the activity.
To edit the XPath expression, click
.
Advanced
The Advanced tab contains the Transport Type field. You can select a transport type in the Transport
Type list. For more information, see Transport Type.
TIBCO ActiveMatrix® Adapter Framework Reference
33
Output Editor
The Output Editor tab defines the schema used for messages: Map, Stream, or XML Text. Map
messages are name or value pairs.
You can use the schema to define the structure of the outgoing request and the incoming reply. The
schema defined in the Output Editor tab becomes the body of the message in the Output tab.
Conversations
You can initiate the conversation here. Click Add New Conversation
conversations.
to initiate multiple
For details about conversations, see TIBCO ActiveMatrix BusinessWorks Application Development.
Output
The following table lists the output items for this activity:
Output Item
Data Type
Description
subject
String
The subject of the message.
replySubject
String
The reply subject of the message.
certifiedSequence
String
This element contains the sequence number in which this
message was received.
Number
It is available only when Tibrv Certified is the transport.
certifiedSender
String
This element contains the CM name of the message sender.
It is available only when Tibrv Certified is the transport.
MessageID
String
The ID of the message.
This element is available only when JMS Queue or JMS
Topic is the transport.
trackingInfo
Complex
The AE tracking information of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name + User_Part
(Business_Key).
JMSHeaders
Complex
This element contains the message header fields for the
message. Only properties applicable to this type of message
are displayed.
It is available only when JMS Queue or JMS Topic is the
transport.
For more information about message header fields, see "JMS
Properties" in TIBCO ActiveMatrix BusinessWorks Bindings and
Palette Reference.
body
Complex
A complex schema type specified for the adapter service or a
complex schema type designated by user.
TIBCO ActiveMatrix® Adapter Framework Reference
34
Fault
The Fault tab lists the possible exceptions thrown by this activity.
This tab plays the same role as the Error Output tab in TIBCO ActiveMatrix BusinessWorks 5.x.
Fault
Thrown When...
TransportException
The transport cannot be created.
DeserializationException
The outgoing message cannot be serialized.
ConfirmationException
The message cannot be confirmed.
ActivityTimeoutException
A timeout error occurs.
TIBCO ActiveMatrix® Adapter Framework Reference
35
Transport Type
The transport configuration in the Advanced tab of an activity specifies the underlying communication
characteristics for messages sent and received by the adapter services.
Normally, activities in the Adapter palette use the same transport configuration as the adapter service
that they are communicating with; however, you can override the transport configuration of the
adapter service by specifying different transport parameters.
You can select a transport type by which the incoming request is received. The transport is used by the
adapter service. The following options are available in the Transport Type list: Adapter Service
default, Tibrv Reliable, Tibrv Certified, Tibrv Certified Message Queue, JMS Queque and JMS
Topic. The default transport is based on the associated adapter service. You do not have to specify any
parameter.
The transport types are grouped into two categories:
●
TIBCO Rendevous Transport
The TIBCO Rendevous transport includes Tibrv Reliable, Tibrv Certified, and Tibrv Certified
Message Queue.
To use the TIBCO Rendezvous transport when configuring the adapter activities and running the
ActiveMatrix BusinessWorks process on a UNIX platform, you can set the LD_LIBRARY_PATH and
RV_HOME environment variables with the TIBCO Rendezvous library path in the Run Configuration
dialog.
For more information, see the TIBCO Rendezvous documentation.
●
JMS Transport
The JMS transport includes JMS Queue and JMS Topic.
For more information, see the TIBCO Enterprise Message Service documentation.
Tibrv Reliable
The Tibrv Reliable transport has the following fields:
Field
Module
Property?
Description
RV Connection
Yes
The TIBCO Rendezvous connection.
For more information, see "Rendezvous Transport" in TIBCO
ActiveMatrix BusinessWorks™ Bindings and Palette Reference.
Message Format
No
The format of the message. The format is AE_message_format
or AE_XML_format.
Subject
No
The subject of the incoming request.
Tibrv Certified
The Tibrv Certified transport has the following fields:
TIBCO ActiveMatrix® Adapter Framework Reference
36
Field
Module
Property?
Description
RV Connection
Yes
The TIBCO Rendezvous connection.
For more information, see "Rendezvous Transport" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference.
Message Format
No
The format of the message. The format is AE_message_format
or AE_XML_format.
Subject
No
The subject of the incoming request.
PreRegister
Listeners
No
The CM names of the certified subscribers. With
preRegisterListener, the publisher can preregister with any
expected listeners. If multiple CM names are specified,
separate each one with a comma.
Tibrv Certified Message Queue
The Tibrv Certified Message Queue transport has the following fields:
Field
Module
Property?
Description
RV Connection
Yes
The TIBCO Rendezvous connection.
For more information, see "Rendezvous Transport" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference.
Message Format
No
The format of the message. The format is AE_message_format
or AE_XML_format.
Subject
No
The subject of the incoming request.
JMS Queue
The JMS Queue transport has the following fields:
Field
Module
Property?
Description
JMS Connection
Yes
The JMS connection.
For more information, see "JMS Connection" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference.
Destination
No
The destination object from which an incoming request is
received.
Delivery Mode
No
The delivery mode of the published message. This can be
persistent or nonpersistent.
This field is only available for the Publish to Adapter and Invoke
an Adapter Request-Response Server activities.
TIBCO ActiveMatrix® Adapter Framework Reference
37
Field
Module
Property?
Time to Live
Yes
Description
The expiration time (in milliseconds) for the message. The value
zero (0) means that the message never expires.
This field is only available for the Publish to Adapter and Invoke
an Adapter Request-Response Server activities.
Override
Transaction
No
If this check box is selected, the JMS message does not participate
in the transaction.
Select this check box to exclude the JMS message from the
transaction. Clear this check box to include the JMS message in
the transaction
This check box is only available for the Publish to Adapter and
Invoke an Adapter Request-Response Server activities.
JMS Application
Properties
No
The message properties specific to the JMS application.
JMS Topic
The JMS Topic transport has the following fields:
Field
Module
Property?
Description
JMS Connection
Yes
The JMS connection.
For more information, see "JMS Connection" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference.
Destination
No
The destination object from which an incoming request is
received.
Durable
No
Select or clear this check box to specify whether the request is a
durable subscriber.
The check box is available only for the following activities:
Durable Name
No
●
Adapter Request-Response Server
●
Adapter Subscriber
●
Wait for Adapter Message
●
Wait for Adapter Request
The name of the durable subscription that is registered with the
JMS server in this field.
This field is only available when the Durable check box is
selected.
TIBCO ActiveMatrix® Adapter Framework Reference
38
Field
Module
Property?
Delivery Mode
No
Description
The delivery mode of the published message. This can be
persistent or nonpersistent.
This field is only available for the Publish to Adapter and Invoke
an Adapter Request-Response Server activities.
Time To Live
Yes
The expiration time (in milliseconds) for the message. The value
zero (0) means that the message never expires.
This field is only available for the Publish to Adapter and Invoke
an Adapter Request-Response Server activities.
Override
Transaction
No
If this check box is selected, the JMS message does not participate
in the transaction.
Select this check box to exclude the JMS message from the
transaction. Clear this check box to include the JMS message in
the transaction.
This check box is only available for the Publish to Adapter and
Invoke an Adapter Request-Response Server activities.
JMS
Application
Properties
No
Any application-specific message property that is part of the
message.
TIBCO ActiveMatrix® Adapter Framework Reference
39
Supported Adapters
Three native adapters and three non-native adapters are supported in the TIBCO Business Studio
environment.
The following lists the supported adapters:
●
●
Native adapters:
—
TIBCO ActiveMatrix® Adapter for Database
—
TIBCO ActiveMatrix® Adapter for Files for Unix/Win
—
TIBCO ActiveMatrix® Adapter for SAP
Non-native adapters:
—
TIBCO ActiveMatrix® Adapter for PeopleSoft
—
TIBCO ActiveMatrix® Adapter for Siebel
—
TIBCO ActiveMatrix® Adapter for Tuxedo
For details about the supported versions, see the Readme file.
For details about the products, see each product documentation set.
Regarding the non-native adapters, you can create an adapter project in TIBCO Designer, validate the
project and then migrate the project into TIBCO Business Studio. After migrating, the Eclipse GUI
provided by TIBCO Business Studio is available for those non-native adapters. You can modify the
process configuration, define new processes and add activities from the Adapter Palette panel.
However, you cannot modify adapter configurations for the migrated project, add new adapter
configurations or adapter services directly in TIBCO Business Studio.
If you want to modify an adapter configuration for the migrated project, you can modify the instance in
TIBCO Designer, save it and migrate the project into TIBCO Business Studio again.
The concept of adapter configuration in TIBCO ActiveMatrix Adapter Framework is the same as
adapter instance in the runtime adapters.
TIBCO ActiveMatrix® Adapter Framework Reference
Was this manual useful for you? yes no
Thank you for your participation!

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

Download PDF

advertisement