TIBCO ActiveMatrix?? Adapter Reference

TIBCO ActiveMatrix?? Adapter Reference
TIBCO ActiveMatrix® Adapter
Reference
Software Release 1.1
May 2014
Two-Second Advantage®
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-2014 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
TIBCO ActiveMatrix Adapter Framework Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x
TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio) Documentation . . . . . . . . . . . . . . . . . . . . . . . x
TIBCO ActiveMatrix Adapter for Database (TIBCO Business Studio) Documentation. . . . . . . . . . . . . . . . . . . x
TIBCO ActiveMatrix Adapter for Files for Unix/Win (TIBCO Business Studio) Documentation . . . . . . . . . . . xi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
xvii
xvii
xvii
Chapter 1 Adapter Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Common Features Across Adapter Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Transport Type Configuration Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Adapter Request-Response Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Conversations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Adapter Subscriber . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Conversations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Invoke an Adapter Request-Response Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
TIBCO ActiveMatrix® Adapter Reference
iv
| Contents
Input Editor/Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
16
16
17
18
Publish to Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor/Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19
19
20
21
21
21
22
23
Respond to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
24
24
25
25
25
26
Send Exception to Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
27
27
28
28
28
Wait for Adapter Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
30
31
31
31
32
32
32
33
33
Wait for Adapter Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Conversations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Fault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34
35
35
36
36
36
37
37
38
TIBCO ActiveMatrix® Adapter Reference
Contents v
|
Chapter 2 Migrating a Generic Adapter Configuration Project Created in TIBCO Designer . .39
List of Supported Adapter Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Prerequisites of Migrating a TIBCO Designer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Supported Runtime Adapter Version for Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Validating the Project in TIBCO Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Migrating a TIBCO Designer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Creating a PeopleSoft Adapter Project in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Creating a BusinessWorks Process in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Testing the Adapter Project with a BusinessWorks Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Migrating a TIBCO Designer Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Testing the Migrated Project in TIBCO Business Studio. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
TIBCO ActiveMatrix® Adapter Reference
vi
| Contents
TIBCO ActiveMatrix® Adapter Reference
Figures vii
|
Figures
Figure 1
An Adapter Request-Response Server Activity Receiving a Request and Starting a Process . . . . . 6
Figure 2
An Adapter Subscriber Activity Receiving a Message and Starting a Process . . . . . . . . . . . . . . . . 10
Figure 3
An Invoke an Adapter Request-Response Service Activity Sending a Request . . . . . . . . . . . . . . . 14
Figure 4
A Publish to Adapter Activity Sending a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 5
A Respond to Adapter Request Sending a Response . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Figure 6
A Send Exception to Adapter Request Sending an Exception . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Figure 7
A Wait for Adapter Message Activity Sending a Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Figure 8
A Wait for Adapter Request Activity Waiting for a Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 9
PeopleSoft Adapter Project - CI Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 10
CI Publication Service BusinessWorks Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Figure 11
Testing Adapter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 12
Testing BusinessWorks Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Figure 13
Modify Country Parameter in PeopleSoft Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Figure 14
Migrated Example Project in TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 15
Run Adapter in TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 16
Run BusinessWorks Process in TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 17
Testing Example Result . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
TIBCO ActiveMatrix® Adapter Reference
viii
| Figures
TIBCO ActiveMatrix® Adapter Reference
| ix
Preface
TIBCO ActiveMatrix Adapter Framework provides a visual, model-driven
development environment for configuring supported TIBCO adapters in TIBCO
Business Studio and integrating them with TIBCO ActiveMatrix BusinessWorks
applications and processes. The product also provides administration capabilities
for deploying the TIBCO adapters developed in TIBCO Business Studio to
runtime environments.
This document describes the Adapter palette and how to migrate a Generic
Adapter Configuration (GAC) project created in TIBCO Designer to TIBCO
Business Studio.
Topics
•
Related Documentation, page x
•
Typographical Conventions, page xiii
•
Connecting with TIBCO Resources, page xvii
TIBCO ActiveMatrix® Adapter Framework Reference
x
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO ActiveMatrix Adapter Framework Documentation
The following documents form the TIBCO ActiveMatrix Adapter Framework
documentation set:
•
TIBCO ActiveMatrix Adapter Administration Read this manual for instructions
on how to deploy and manage adapter projects.
•
TIBCO ActiveMatrix Adapter Reference Read this manual for reference
information of TIBCO ActiveMatrix Adapter activities.
•
TIBCO ActiveMatrix Adapter Framework Installation Read this manual for
instructions on site preparation and installation.
•
TIBCO ActiveMatrix Adapter Framework Release Notes Read the release notes
for a list of new and changed features. This document also contains lists of
known issues and closed issues for this release.
TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio) Documentation
The following documents form the TIBCO ActiveMatrix Adapter for SAP (TIBCO
Business Studio) documentation set:
•
TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio) User’s
Guide Read this manual for instructions on how to create, configure, and
deploy adapter projects.
•
TIBCO ActiveMatrix Adapter for SAP (TIBCO Business Studio) Examples Read
this manual to work through the examples provided with the adapter.
TIBCO ActiveMatrix Adapter for Database (TIBCO Business Studio)
Documentation
The following documents form the TIBCO ActiveMatrix Adapter for Database
(TIBCO Business Studio) documentation set:
•
TIBCO ActiveMatrix Adapter for Database (TIBCO Business Studio) User’s
Guide Read this manual for instructions on how to create, configure, and
deploy adapter projects.
TIBCO ActiveMatrix® Adapter Framework Reference
Preface xi
|
•
TIBCO ActiveMatrix Adapter for Database (TIBCO Business Studio)
Examples Read this manual to work through the examples provided with the
adapter.
TIBCO ActiveMatrix Adapter for Files for Unix/Win (TIBCO Business Studio)
Documentation
The following documents form the TIBCO ActiveMatrix Adapter for Files for
Unix/Win (TIBCO Business Studio) documentation set:
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win (TIBCO Business Studio)
User’s Guide Read this manual for instructions on how to create, configure,
and deploy adapter projects.
•
TIBCO ActiveMatrix Adapter for Files for Unix/Win (TIBCO Business Studio)
Examples Read this manual to work through the examples provided with the
adapter.
Other TIBCO Product Documentation
You may find it useful to read the documentation for the following TIBCO
products:
Table 1 TIBCO Products
TIBCO Product
ActiveMatrix®
TIBCO
Database
Description
Adapter for
This product is a bidirectional gateway between the database and
applications configured for the TIBCO environment. The adapter
supports Publication Services, Subscription Services, and
Request-Response Services. It is the runtime component for TIBCO
ActiveMatrix Adapter for Database (TIBCO Business Studio).
TIBCO ActiveMatrix® Adapter for Files
for Unix/Win
This product is a bidirectional gateway between files and
applications configured for the TIBCO environment. The adapter
supports Publication Services and Subscription Services. It is the
runtime component for TIBCO ActiveMatrix Adapter for Files for
Unix/Win (TIBCO Business Studio).
TIBCO ActiveMatrix® Adapter for SAP
This product is a bidirectional gateway between the SAP system
and applications configured for the TIBCO environment. The
adapter supports Publication Services, Subscription Services,
Request-Response Services, and Request-Response Invocation
Services. It is the runtime component for TIBCO ActiveMatrix
Adapter for SAP (TIBCO Business Studio).
TIBCO ActiveMatrix® Adapter Framework Reference
xii
| Related Documentation
Table 1 TIBCO Products (Cont’d)
TIBCO Product
Description
™
TIBCO ActiveMatrix BusinessWorks
This product provides an integration platform that enables
companies to rapidly integrate systems and automate business
processes.
TIBCO® Adapter SDK
This product provides a class library that helps developers to
implement an adapter with minimal effort.
TIBCO Business Studio™
This product provides capabilities that help business analysts to
document business processes, solution engineers implement
business processes, and help SOA developers to create composite
applications.
TIBCO Designer™
This product provides a graphical user interface to create TIBCO
ActiveMatrix BusinessWorks process definitions, or create or
modify TIBCO Adapter configurations.
TIBCO® Enterprise Administrator
This product provides capabilities for managing users, monitoring
machines, and deploying and managing applications created in
TIBCO Business Studio.
TIBCO Enterprise Message Service™
This product sends messages from your applications in a format
that conforms to the Java Messaging Service (JMS) specification.
TIBCO Hawk®
This product is for monitoring and managing distributed
applications and systems throughout the enterprise.
TIBCO Rendezvous®
This product uses messages to enable distributed application
programs to communicate across a wide variety of hardware
platforms and programming languages.
TIBCO Runtime Agent™
This product is a bundle of TIBCO software and third-party
software that is required to run many TIBCO applications such as
TIBCO ActiveMatrix BusinessWorks, TIBCO Adapters, and so on.
TIBCO ActiveMatrix® Adapter Framework Reference
Preface xiii
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 2 General Typographical Conventions
Convention
Use
ENV_NAME
TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in
other installation environments. Incompatible products and multiple
instances of the same product must be installed into different installation
environments.
TIBCO_HOME
An installation environment consists of the following properties:
•
Name Identifies the installation environment. This name is referenced in
documentation as ENV_NAME. The default value is TIBCO_HOME.
•
Directory The folder into which the product is installed. This folder is
referenced in documentation as TIBCO_HOME.
TIB_AFX_HOME
TIBCO ActiveMatrix Adapter Framework is installed into a directory within
a TIBCO_HOME directory. This directory is referenced in documentation as
TIB_AFX_HOME. The default value of TIB_AFX_HOME depends on the
operating system. For example, on Windows systems, the default value is
C:\tibco\afx\ReleaseNumber.
code font
Code font identifies commands, code examples, filenames, pathnames, and
output displayed in a command window. For example:
Use MyCommand to start the foo process.
bold code font
Bold code font is used in the following ways:
•
In procedures, to indicate what a user types. For example: Type admin.
•
In large code samples, to indicate the parts of the sample that are of
particular interest.
•
In command syntax, to indicate the default parameter for a command.
For example, if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
TIBCO ActiveMatrix® Adapter Framework Reference
xiv
| Typographical Conventions
Table 2 General Typographical Conventions (Cont’d)
Convention
Use
italic font
Italic font is used in the following ways:
Key combinations
•
To indicate a document title. For example: See TIBCO ActiveMatrix
Adapter Reference.
•
To introduce new terms. For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
•
To indicate a property in a command or code syntax that you must
replace. For example: MyCommand PathName
Key names separated by a plus sign indicate keys pressed simultaneously.
For example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after
the other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance,
for example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to
apply the information provided in the current section to achieve a specific
result.
The warning icon indicates the potential for a damaging situation, for
example, data loss or corruption, if certain steps are taken or not taken.
TIBCO ActiveMatrix® Adapter Framework Reference
Preface xv
|
Table 3 Syntax Typographical Conventions
Convention
Use
[ ]
An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
|
A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand param1 | param2 | param3
{ }
A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
Table 4 Syntax Typographical Conventions
Convention
Use
[ ]
An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
|
A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
TIBCO ActiveMatrix® Adapter Framework Reference
xvi
| Typographical Conventions
Table 4 Syntax Typographical Conventions
Convention
Use
{ }
A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
TIBCO ActiveMatrix® Adapter Framework Reference
Preface xvii
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO Documentation
You can access TIBCO documentation here:
http://docs.tibco.com
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, contact
TIBCO Support as follows:
•
For an overview of TIBCO Support, and information about getting started
with TIBCO Support, visit this site:
http://www.tibco.com/services/support
•
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user
name, you can request one.
TIBCO ActiveMatrix® Adapter Framework Reference
xviii Connecting with TIBCO Resources
|
TIBCO ActiveMatrix® Adapter Framework Reference
|1
Chapter 1
Adapter Palette
The Adapter palette contains activities for communicating with configured
TIBCO Adapters. For how to work with activities in TIBCO Business Studio, see
TIBCO ActiveMatrix BusinessWorks Application Development.
Topics
•
Common Features Across Adapter Activities, page 2
•
Adapter Request-Response Server, page 6
•
Adapter Subscriber, page 10
•
Invoke an Adapter Request-Response Server, page 14
•
Publish to Adapter, page 19
•
Respond to Adapter Request, page 24
•
Send Exception to Adapter Request, page 27
•
Wait for Adapter Message, page 30
•
Wait for Adapter Request, page 34
TIBCO ActiveMatrix® Adapter Reference
2
| Chapter 1
Adapter Palette
Common Features Across Adapter Activities
This section describes common features across all activities in this palette.
Transport Type Configuration Reference
The Transport Type configuration in the Advanced tab of each activity specifies
the underlying communication characteristics for messages sent and received by
the adapter services. Normally, the activities of the Adapter palette use the same
transport configuration as the adapter service they are communicating with.
However, you can override the transport configuration of the adapter service by
specifying different transport parameters in the Transport Type configuration of
the activity.
Table 5 Transport Type Configuration
Field
Literal Value/
Module
Property?
Transport Type
No
Description
The transport on which the incoming request will be received.
This is the transport used by the adapter service. However, you
can override this by specifying different transport parameters.
The possible values for this field are:
•
Tibrv Reliable
•
Tibrv Certified
•
Tibrv Certified Message Queue
•
JMS Topic
•
JMS Queue
Table 6 TIBCO Rendezvous Transport Configuration
Field
Literal Value/
Module
Property?
Description
Tibrv Reliable Transport
See the TIBCO Rendezvous documentation for more information about these fields.
RV Connection
None
TIBCO ActiveMatrix® Adapter Reference
The TIBCO Rendezvous connection.
Common Features Across Adapter Activities 3
|
Table 6 TIBCO Rendezvous Transport Configuration (Cont’d)
Field
Literal Value/
Module
Property?
Description
Message
Format
No
Specifies the message format of the message. This can be either
AE message format or AE XML format.
Subject
No
The subject of the incoming request.
Tibrv Certified Transport
See the TIBCO Rendezvous documentation for more information about these fields.
RV Connection
None
The TIBCO Rendezvous connection.
Message
Format
No
Specifies the message format of the message. This can be either
AE message format or AE XML format.
Subject
No
The subject of the incoming request.
PreRegister
Listeners
No
This field specifies the cmname(s) of the certified subscriber(s).
This allows the publisher to pre-register with any expected
listeners. If multiple cmnames are specified, separate each
cmname with a comma.
Tibrv Certified Message Queue Transport
See the TIBCO Rendezvous documentation for more information about these fields.
RV Connection
None
The TIBCO Rendezvous connection.
Message
Format
No
Specifies the message format of the message. This can be either
AE message format or AE XML format.
Subject
No
The subject of the incoming request.
When configuring the Adapter activities to use the TIBCO Rendezvous transport,
prior to running the BusinessWorks process on a UNIX platform, in the Run
Configuration dialog, set the LD_LIBRARY_PATH and RV_HOME environment
variables with the TIBCO Rendezvous library path.
TIBCO ActiveMatrix® Adapter Reference
4
| Chapter 1
Adapter Palette
Table 7 JMS Transport Configuration
Field
Literal Value/
Module
Property?
Description
JMS Queue Transport
See the TIBCO Enterprise Message Service documentation for more information about these fields.
JMS
Connection
None
The JMS connection. See "JMS Connection" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference for
more information.
Destination
No
The Destination object from which an incoming request should
be received.
Delivery Mode
No
This field is only available on the Transport tab of the Publish to
Adapter or Invoke an Adapter Request-Response Server
activities.
This field specifies the delivery mode of the published message.
This can be either persistent or non-persistent.
Time To Live
Yes
This field is only available on the Transport tab of the Publish to
Adapter or Invoke an Adapter Request-Response Server
activities.
This field specifies the expiration time (in milliseconds) for the
message. Specifying zero signifies the message should never
expire.
JMS
Application
Properties
No
Any application-specific message property that will be part of
the message.
JMS Topic Transport
See the TIBCO Enterprise Message Service documentation for more information about these fields.
JMS
Connection
None
The JMS connection. See "JMS Connection" in TIBCO
ActiveMatrix BusinessWorks Bindings and Palette Reference for
more information.
Destination
No
The Destination object from which an incoming request should
be received.
TIBCO ActiveMatrix® Adapter Reference
Common Features Across Adapter Activities 5
|
Table 7 JMS Transport Configuration (Cont’d)
Field
Literal Value/
Module
Property?
Durable
No
Description
Specifies whether the client making the request is a durable
subscriber. The durable subscription name is a concatenation of
the process definition name and the name of the activity.
This field is only available on the Transport tab of the following
activities:
•
Adapter Request-Response Server
•
Adapter Subscriber
•
Wait for Adapter Message
•
Wait for Adapter Request
Durable Name
No
When the Durable field is selected, you can specify the name of
the durable subscription that is registered with the JMS server
in this field. This field is only available when the Durable field
is selected.
Delivery Mode
No
This field is only available on the Transport tab of the Publish to
Adapter or Invoke an Adapter Request-Response Server
activities.
This field specifies the delivery mode of the published message.
This can be either persistent or non-persistent.
Time To Live
Yes
This field is only available on the Transport tab of the Publish to
Adapter or Invoke an Adapter Request-Response Server
activities.
This field specifies the expiration time (in milliseconds) for the
message. Specifying zero signifies the message should never
expire.
JMS
Application
Properties
No
Any application-specific message property that will be part of
the message.
TIBCO ActiveMatrix® Adapter Reference
6
| Chapter 1
Adapter Palette
Adapter Request-Response Server
This is a process starter. It starts a process based on the request received from an
adapter. The adapter sends a request using a preconfigured Request-Response
Invocation Service. The started process acts as an implementation of the request.
The process sends any required responses back to the adapter service using the
Respond to Adapter Request activity.
Adapter Request-Response Invocation 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
services.
Figure 1 illustrates an Adapter Request-Response Server activity starting a
business process to handle an incoming request from an adapter
Request-Response Invocation Service. At a later point in the business process, the
Respond to Adapter Request activity is used to perform the response.
Figure 1 An Adapter Request-Response Server Activity Receiving a Request and Starting
a Process
Application
Adapter
RequestResponse
Invocation
Service
Request
Business Process
Adapter
RequestResponse
Server
TIBCO ActiveMatrix® Adapter Reference
Adapter Request-Response Server 7
|
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
The name to appear as the label for the activity in the process
definition. The default value is
AdapterRequest-ResponseServer.
Adapter
Service
No
The preconfigured adapter Request-Response Invocation
Service. You must specify the adapter service when configuring
the adapter.
Description
Use the Search button to locate the appropriate service for this
activity.
Operation
No
This field contains a drop down list of any operations defined
by the schema used in the selected adapter service. Select the
operation that this process definition implements.
Custom
Schema
No
Specifies whether you wish to supply an output class for this
activity.
Transport
Configuration
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
TIBCO ActiveMatrix® Adapter Reference
8
| Chapter 1
Adapter Palette
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
See Transport Type Configuration Reference on page 2 for more
information.
Sequence Key
No
This field can contain an XPath expression (Edit XPath
Expression button) that specifies which processes should run in
order. Process instances with sequencing keys that evaluate to
the same value will be executed sequentially in the order the
process instance was created.
Description
See TIBCO ActiveMatrix BusinessWorks Application Development
for more information about controlling the execution order of
process instances and about XPath expressions.
Custom Job ID
No
This field can contain an XPath expression (Edit XPath
Expression button) that specifies a custom ID for the process
instance. This ID is also available in the $_processContext
process variable.
Output Editor
The Output Editor tab defines the schema used for messages of type Map, Stream,
or XML Text. Map messages are name or value pairs. You can use the schema to
define the structure of the retrieved queue message. The schema defined on the
Output Editor tab becomes the body of the message on the Output tab.
Conversations
You can initiate the Conversation here. Click Add New Conversation to initiate
multiple conversations.
For details about Conversations, See TIBCO ActiveMatrix BusinessWorks
Application Development.
Output
The following is the output for this activity.
TIBCO ActiveMatrix® Adapter Reference
Adapter Request-Response Server 9
|
Output Item
Data Type
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequence
Number
string
This element is only available when Tibrv Certified is the
transport. This element contains the sequence number in which
this message was received.
certifiedSender
string
This element is only available when Tibrv Certified is the
transport. This element contains the cmname of the message
sender.
MessageID
string
This element is only available when JMS Topic or JMS Queue is
the transport. This is the message ID of the message.
trackingInfo
complex
The AE tracking info 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 is only available when JMS Topic or JMS Queue is
the transport.
This element contains the message header fields for the
message. See "JMS Properties" in TIBCO ActiveMatrix
BusinessWorks Bindings and Palette Reference for more
information about message header fields. Only properties
applicable to this type of message are displayed.
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
body
complex
Body can be a complex schema type specified for the adapter
service or a complex schema type designated by user.
TIBCO ActiveMatrix® Adapter Reference
10
| Chapter 1
Adapter Palette
Adapter Subscriber
This is a process starter. It starts a process based on 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 2 illustrates an adapter Publication Service publishing a message and the
Adapter Subscriber process starter starting a business process.
Figure 2 An Adapter Subscriber Activity Receiving a Message and Starting a Process
Application
Adapter
Publishing
Service
Publish
Business Process
Adapter
Subscriber
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
TIBCO ActiveMatrix® Adapter Reference
Description
The name to appear as the label for the activity in the process
definition. The default value is AdapterSubscriber.
Adapter Subscriber 11
|
Field
Adapter
Service
Literal Value/
Module
Property?
No
Description
The preconfigured adapter Publication Service. You must
specify the adapter service when configuring the adapter.
Use the Search button to locate the appropriate service for this
activity.
Custom
Schema
No
Transport
Configuration
Specifies whether you wish to supply an output class for this
activity.
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
See Transport Type Configuration Reference on page 2 for more
information.
Sequence Key
No
This field can contain an XPath expression (Edit XPath
Expression button) that specifies which processes should run in
order. Process instances with sequencing keys that evaluate to
the same value will be executed sequentially in the order the
process instance was created.
Description
See TIBCO ActiveMatrix BusinessWorks Application Development
for more information about controlling the execution order of
process instances and about XPath expressions.
TIBCO ActiveMatrix® Adapter Reference
12
| Chapter 1
Adapter Palette
Field
Literal Value/
Module
Property?
Custom Job ID
No
Description
This field can contain an XPath expression (Edit XPath
Expression button) that specifies a custom ID for the process
instance. This ID is also available in the $_processContext
process variable.
Output Editor
The Output Editor tab defines the schema used for messages of type Map, Stream,
or XML Text. Map messages are name or value pairs. You can use the schema to
define the structure of the retrieved queue message. The schema defined on the
Output Editor tab becomes the body of the message on the Output tab.
Conversations
You can initiate the Conversation here. Click Add New Conversation to initiate
multiple conversations.
For details about Conversations, See TIBCO ActiveMatrix BusinessWorks
Application Development.
Output
The following is the output for this activity.
Output Item
Data Type
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequence
Number
string
This element is only available when Tibrv Certified is the
transport. This element contains the sequence number in which
this message was received.
certifiedSender
string
This element is only available when Tibrv Certified is the
transport. This element contains the cmname of the message
sender.
TIBCO ActiveMatrix® Adapter Reference
Adapter Subscriber 13
|
Output Item
Data Type
Description
MessageID
string
This element is only available when JMS Topic or JMS Queue is
the transport. This is the message ID of the message.
trackingInfo
complex
The AE tracking info 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 is only available when JMS Topic or JMS Queue is
the transport.
This element contains the message header fields for the
message. See "JMS Properties" in TIBCO ActiveMatrix
BusinessWorks Bindings and Palette Reference for more
information about message header fields. Only properties
applicable to this type of message are displayed.
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
body
complex
Body can be a complex schema type specified for the adapter
service or a complex schema type designated by user.
TIBCO ActiveMatrix® Adapter Reference
14
| Chapter 1
Adapter Palette
Invoke an Adapter Request-Response Server
The Invoke an Adapter Request-Response Server activity is used to communicate
with an adapter Request-Response Service. This service invokes an operation
with input and output by way of the adapter. Request-Response 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 Request-Response Services.
Figure 3 illustrates an Invoke an Adapter Request-Response Server activity
sending a request to an adapter Request-Response Service.
Figure 3 An Invoke an Adapter Request-Response Service Activity Sending a Request
Application
Adapter
RequestResponse
Service
Request
Business Process
Invoke an Adapter
Request-Response
Service
TIBCO ActiveMatrix® Adapter Reference
Invoke an Adapter Request-Response Server 15
|
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
The name to appear as the label for the activity in the process
definition. The default value is
InvokeanAdapterRequest-ResponseServer.
Adapter
Service
No
The preconfigured adapter Request-Response Service. You can
specify the adapter service when configuring the adapter.
Description
Use the Search button to locate the appropriate service for this
activity.
Operation
No
This field contains a drop down list of any operations defined
by the schema used in the selected adapter service. Select the
operation that this process definition implements.
One Way
No
This is a read-only field that displays whether the selected
operation is one-way.
Custom
Schema
No
Specifies whether you wish to supply an output class for this
activity.
Transport
Configuration
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
TIBCO ActiveMatrix® Adapter Reference
16
| Chapter 1
Adapter Palette
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
Description
See Transport Type Configuration Reference on page 2 for more
information.
Input Editor/Output Editor
The Input Editor/Output Editor tabs define the schema to use for messages of
type Map, Stream, or XML Text. Map messages are name/value pairs, and the
schema allows you to define the structure of the outgoing request and the
incoming reply. The schema defined on the Input Editor tab becomes the body of
the message on the Input tab. The schema defined on the Output Editor tab
becomes the body of the message on the Output tab.
Input
The following is the input for this activity.
Input Item
Data Type
Description
subject
string
The subject to send the request on.
requestTimeout
integer
The time to wait (in milliseconds) for the synchronous
request-reply operation to complete. An error is returned if the
operation does not complete in this time limit.
replySubject
string
The Subject/Destination that is used to send the response when
using the RV/JMS transport.
businessKey
string
This string is appended to the AE tracking info trackingInfo
field.
Note: It is a good idea to have all publishers in a process use the
same business key. Only the most recent publisher’s business
key is used in the tracking info for the message.
TIBCO ActiveMatrix® Adapter Reference
Invoke an Adapter Request-Response Server 17
|
Input Item
Data Type
Description
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
Output
The following is the output for this activity.
Output Item
Data Type
Description
replyDestination
string
A reply message can optionally have a reply destination,
presumably so that the two applications can communicate with
further 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 info 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 is only available when JMS Topic or JMS Queue is
the transport.
This element contains the message header fields for the
message. See "JMS Properties" in TIBCO ActiveMatrix
BusinessWorks Bindings and Palette Reference for more
information about message header fields. Only properties
applicable to this type of message are displayed.
TIBCO ActiveMatrix® Adapter Reference
18
| Chapter 1
Adapter Palette
Output Item
Data Type
Description
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
body
complex
Body can be a complex schema type specified for the adapter
service or a complex schema type designated by user.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault 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 occurred.
operationException
The adapter service returned an exception encountered while
performing the operation. Any exception class defined on the
operation schema can be returned.
The potential exceptions are displayed as a choice element for
activities after an error transition.
TIBCO ActiveMatrix® Adapter Reference
Publish to Adapter 19
|
Publish to Adapter
The Publish to Adapter activity publishes a message that can be received by the
Subscription Service of an adapter. Subscription 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 Subscription Services.
Figure 4 illustrates a Publish to Adapter activity sending a message to a
preconfigured adapter Subscription Service.
Figure 4 A Publish to Adapter Activity Sending a Message
Application
Adapter
Subscription
Service
Publish
Business Process
Publish to
Adapter
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
Description
The name to appear as the label for the activity in the process
definition. The default value is PublishtoAdapter.
TIBCO ActiveMatrix® Adapter Reference
20
| Chapter 1
Adapter Palette
Field
Adapter
Service
Literal Value/
Module
Property?
No
Description
The preconfigured adapter Subscription Service. You must
specify the adapter service when configuring the adapter.
Use the Search button to locate the appropriate service for this
activity.
RequestReply
No
Specifies that this publish activity is sending a request message
and expecting a response message. This is similar to using the
Invoke an Adapter Request-Response Server activity, except
this activity uses an adapter Subscription Service instead of a
Request-Response Service.
When this check box is selected, the Custom Schema check box
turns to selected. The Publish to Adapter activity will use the
RequestReply schema specified by a user, not the schema from
the adapter service.
Custom
Schema
No
Transport
Configuration
Specifies whether you wish to supply an output class for this
activity.
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
TIBCO ActiveMatrix® Adapter Reference
Publish to Adapter 21
|
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
Description
See Transport Type Configuration Reference on page 2 for more
information.
Input Editor/Output Editor
The Input Editor/Output Editor tabs define the schema to use for messages of
type Map, Stream, or XML Text. Map messages are name/value pairs, and the
schema allows you to define the structure of the outgoing request and the
incoming reply. The schema defined on the Input Editor tab becomes the body of
the message on the Input tab. The schema defined on the Output Editor tab
becomes the body of the message on the Output tab.
Input
The following is the input for this activity.
Input Item
Data Type
Description
subject
string
The subject to send the request on.
requestTimeout
integer
When publishing in request/reply mode, this element specifies
the timeout (in milliseconds) to wait for the reply.
preRegister
Listener
string
When using TIBCO Rendezvous Certified Messaging (RVCM),
this field specifies the cmname(s) of the RVCM subscriber(s).
This allows the publisher to pre-register with any expected
listeners. If multiple cmnames are specified, separate each
cmname with a comma. Any listeners preregistered on the
Transport tab are also preregistered with the listeners specified
in this element.
See the TIBCO Rendezvous documentation for more
information about RVCM.
replySubject
string
The subject that replies to this message should be sent to.
TIBCO ActiveMatrix® Adapter Reference
22
| Chapter 1
Adapter Palette
Input Item
Data Type
Description
businessKey
string
This string is appended to the AE tracking info trackingInfo
field.
Note: It is a good idea to have all publishers in a process use the
same business key. Only the most recent publisher’s business
key is used in the tracking info for the message.
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
body
complex
Body can be a complex schema type specified for the adapter
service or a complex schema type designated by user.
Output
The following is the output for this activity. This activity only produces output
when the RequestReply field on the Configuration tab is selected.
Output Item
Data Type
Description
replyDestination
string
A reply message can optionally have a reply destination,
presumably so that the two applications can communicate with
further 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 info of the sender.
This element is a concatenation of "BW."
+ Application_Name +
Module_Name + Process_Name + Activity_Name +
User_Part(Business_Key).
MessageID
string
TIBCO ActiveMatrix® Adapter Reference
This element is only available when JMS Topic or JMS Queue is
the transport. This is the message ID of the message.
Publish to Adapter 23
|
Output Item
Data Type
Description
JMSHeaders
complex
This element is only available when JMS Topic or JMS Queue is
the transport.
This element contains the message header fields for the
message. See "JMS Properties" in TIBCO ActiveMatrix
BusinessWorks Bindings and Palette Reference for more
information about message header fields. Only properties
applicable to this type of message are displayed.
OtherProperties
complex
This element is only available when JMS Topic or JMS Queue is
the transport and JMS Application Properties in the Transport
Type section are specified.
This element contains the message properties for the message.
See "JMS Properties" in TIBCO ActiveMatrix BusinessWorks
Bindings and Palette Reference for more information about
message properties. Only properties applicable to this type of
message are displayed.
body
complex
Body can be a complex schema type specified for the adapter
service or a complex schema type designated by user.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault 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 Reference
24
| Chapter 1
Adapter Palette
Respond to Adapter Request
The Respond to Adapter Request activity is used to send a response to an adapter
for a previously received request. For example, you may have a Wait for Adapter
Request activity in a process definition. The incoming adapter request may
require a response from your process. The Respond to Adapter Request is used to
send that response.
Figure 5 illustrates a Respond to Adapter Request activity sending a response to a
previously received request from an adapter.
Figure 5 A Respond to Adapter Request Sending a Response
Application
Adapter
RequestResponse
Invocation
Service
Reply
Business Process
Respond to Adapter
Request
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
TIBCO ActiveMatrix® Adapter Reference
Description
The name to appear as the label for the activity in the process
definition. The default value is RespondtoAdapterRequest.
Respond to Adapter Request 25
|
Field
Literal Value/
Module
Property?
Reply For
No
Select from the drop down list the activity for which this
activity sends a response.
Custom
Schema
No
Specifies whether you wish to supply an output class for this
activity.
Description
•
Cleared (default) The Input Editor tab is read only.
•
Selected The Input Editor tab is writable.
Description
Provide a short description for the activity here.
Input Editor
The Input Editor tab defines the schema used for messages of type Map, Stream,
or XML Text. Map messages are name or value pairs. You can use the schema to
define the structure of the retrieved queue message. The schema defined on the
Input Editor tab becomes the body of the message on the Input tab.
Input
The following is the input for this activity.
Output Item
Data Type
Description
businessKey
string
This string is appended to the AE tracking info trackingInfo
field.
Note: It is a good idea to have all publishers in a process use the
same business key. Only the most recent publisher’s business
key 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 that
this activity is publishing a response for.
TIBCO ActiveMatrix® Adapter Reference
26
| Chapter 1
Adapter Palette
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault 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.
ReplyException
The reply cannot be sent.
TIBCO ActiveMatrix® Adapter Reference
Send Exception to Adapter Request 27
|
Send Exception to Adapter Request
The Send Exception to Adapter Request activity is used to send an exception to an
adapter for a previously received request. For example, you may have a Adapter
Request-Response Server process starter in a process definition. An error may
occur while attempting to perform the requested operation. The Send Exception
to Adapter Request activity allows you to return an exception to the adapter
service with information about the exception.
Figure 6 illustrates a Send Exception to Adapter Request activity sending an
exception to a previously received request from an adapter.
Figure 6 A Send Exception to Adapter Request Sending an Exception
Application
Adapter
RequestResponse
Invocation
Service
Reply
Business Process
Send Exception to
Adapter Request
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
Description
The name to appear as the label for the activity in the process
definition. The default value is
SendExceptiontoAdapterRequest.
TIBCO ActiveMatrix® Adapter Reference
28
| Chapter 1
Adapter Palette
Field
Literal Value/
Module
Property?
Reply For
No
Select from the drop down list the activity for which this
activity sends a response.
Custom
Schema
No
Specifies whether you wish to supply an output class for this
activity.
Description
•
Cleared (default) The Input Editor tab is read only.
•
Selected The Input Editor tab is writable.
Description
Provide a short description for the activity here.
Input
The following is the input for this activity.
Output Item
Data Type
Description
businessKey
string
This string is appended to the AE tracking info trackingInfo
field.
Note: It is a good idea to have all publishers in a process use the
same business key. Only the most recent publisher’s business
key is used in the tracking info for the message.
body
complex
The schema definition for the exception. The schema used by
the adapter service must define exception schemas that can be
sent.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault tab plays the same role as the Error Output tab in TIBCO ActiveMatrix
BusinessWorks 5.x.
TIBCO ActiveMatrix® Adapter Reference
Send Exception to Adapter Request 29
|
Fault
Thrown When..
TransportException
The transport cannot be created.
SerializationException
The outgoing message cannot be serialized.
ReplyException
The exception cannot be sent.
TIBCO ActiveMatrix® Adapter Reference
30
| Chapter 1
Adapter Palette
Wait for Adapter Message
A Wait for Adapter Message activity 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 7 illustrates an adapter publishing service publishing a message and the
Wait for Adapter Message activity receiving the message in a business process.
Figure 7 A Wait for Adapter Message Activity Sending a Message
Application
Adapter
Publishing
Service
Publish
Business Process
Wait for
Adapter
Message
When using the Wait for Adapter Message activity, you need to set the Scalable
option of the process to false. To do this, clear the Scalable check box in the
process General tab.
TIBCO ActiveMatrix® Adapter Reference
Wait for Adapter Message 31
|
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
The name to appear as the label for the activity in the process
definition. The default value is WaitforAdapterMessage.
Adapter
Service
No
The preconfigured adapter Publication Service. You must
specify the adapter service when configuring the adapter.
Description
Use the Search button to locate the appropriate service for this
activity.
Custom
Schema
No
Transport
Configuration
Specifies whether you wish to supply an output class for this
activity.
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
Event
This section has the following fields:
Field
Event Timeout
(seconds)
Literal Value/
Module
Property?
No
Description
This field specifies the amount in seconds. If no value is
specified in this field, the message waits indefinitely. If zero is
specified, the event is discarded immediately, unless this
activity has already been executed.
TIBCO ActiveMatrix® Adapter Reference
32
| Chapter 1
Adapter Palette
Field
Activity
Timeout
(msec)
Literal Value/
Module
Property?
No
Description
This field specifies the amount of time (in milliseconds) to wait
if the message arrives before this activity is executed in the
process instance. If the event timeout expires, an error is logged
and the event is discarded.
This field can contain an XPath expression (Edit XPath
Expression button) that specifies the timeout value for the
activity.
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
Description
See Transport Type Configuration Reference on page 2 for more
information.
Output Editor
The Output Editor tab defines the schema to use for messages of type Map,
Stream, or XML Text. Map messages are name/value pairs, and the schema
allows you to define the structure of the outgoing request and the incoming reply.
The schema defined on the Output Editor tab becomes the body of the message
on the Output tab.
Conversations
You can initiate the Conversation here. Click Add New Conversation to initiate
multiple conversations.
For details about Conversations, See TIBCO ActiveMatrix BusinessWorks
Application Development.
TIBCO ActiveMatrix® Adapter Reference
Wait for Adapter Message 33
|
Output
The following is the output for this activity.
Output Item
Data Type
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequence
Number
string
This element is only available when Tibrv Certified is the
transport. This element contains the sequence number in which
this message was received.
certifiedSender
string
This element is only available when Tibrv Certified is the
transport. This element contains the cmname of the message
sender.
trackingInfo
complex
The AE tracking info of the sender.
This element is a concatenation of "BW." + Application_Name +
Module_Name + Process_Name + Activity_Name +
User_Part(Business_Key).
body
complex
The class specified for the Publication Service of the specified
adapter configuration.
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault 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 reply cannot be serialized.
ConfirmationException
The message cannot be confirmed.
ActivityTimeoutException
A timeout occurred.
TIBCO ActiveMatrix® Adapter Reference
34
| Chapter 1
Adapter Palette
Wait for Adapter Request
A Wait for Adapter Request activity waits for the receipt of a request from an
adapter Request-Response Invocation Service. The adapter sends a request using
a preconfigured service, and the process definition acts as the implementation of
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
definition.
Adapter Request-Response Invocation 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
services.
Figure 8 illustrates a Wait for Adapter Request activity waiting for a request from
an adapter Request-Response Invocation Service. At a later point in the business
process, a Respond to Adapter Request activity sends the response.
Figure 8 A Wait for Adapter Request Activity Waiting for a Request
Application
Adapter
RequestResponse
Invocation
Service
Request
Business Process
Wait for
Adapter
Request
When using the Wait for Adapter Request activity, you need to set the Scalable
option of the process to false. To do this, clear the Scalable check box in the
process General tab.
TIBCO ActiveMatrix® Adapter Reference
Wait for Adapter Request 35
|
General
This section has the following fields:
Field
Literal Value/
Module
Property?
Name
No
The name to appear as the label for the activity in the process
definition. The default value is WaitforAdapterRequest.
Adapter
Service
No
The preconfigured adapter Request-Response Invocation
Service. You must specify the adapter service when configuring
the adapter.
Description
Use the Search button to locate the appropriate service for this
activity.
Operation
No
This field contains a list of any operations defined by the
schema used in the selected adapter service. Select the
operation that this process definition implements.
Custom
Schema
No
Specifies whether you wish to supply an output class for this
activity.
Transport
Configuration
•
Cleared (default) The Output Editor tab is read only.
•
Selected The Output Editor tab is writable.
Opens the Advanced tab for transport configuration.
Description
Provide a short description for the activity here.
TIBCO ActiveMatrix® Adapter Reference
36
| Chapter 1
Adapter Palette
Event
This section has the following fields:
Field
Literal Value/
Module
Property?
Description
Event Timeout
(seconds)
No
This field specifies the amount in seconds. If no value is
specified in this field, the message waits indefinitely. If zero is
specified, the event is discarded immediately, unless this
activity has already been executed.
Activity
Timeout
(msec)
No
This field specifies the amount of time (in milliseconds) to wait
if the message arrives before this activity is executed in the
process instance. If the event timeout expires, an error is logged
and the event is discarded.
This field can contain an XPath expression (Edit XPath
Expression button) that specifies the timeout value for the
activity.
Advanced
This section has the following fields:
Field
Literal Value/
Module
Property?
Transport Type
No
Description
See Transport Type Configuration Reference on page 2 for more
information.
Output Editor
The Output Editor tab defines the schema to use for messages of type Map,
Stream, or XML Text. Map messages are name/value pairs, and the schema
allows you to define the structure of the outgoing request and the incoming reply.
The schema defined on the Output Editor tab becomes the body of the message
on the Output tab.
TIBCO ActiveMatrix® Adapter Reference
Wait for Adapter Request 37
|
Conversations
You can initiate the Conversation here. Click Add New Conversation to initiate
multiple conversations.
For details about Conversations, See TIBCO ActiveMatrix BusinessWorks
Application Development.
Output
The following is the output for this activity.
Output Item
Data Type
Description
subject
string
The subject of the message.
replySubject
string
The reply subject of the message.
certifiedSequence
Number
string
This element is only available when Tibrv Certified is the
transport. This element contains the sequence number in which
this message was received.
certifiedSender
string
This element is only available when Tibrv Certified is the
transport. This element contains the cmname of the message
sender.
MessageID
string
This element is only available when JMS Topic or JMS Queue is
the transport. This is the message ID of the message.
trackingInfo
complex
The AE tracking info 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 is only available when JMS Topic or JMS Queue is
the transport.
This element contains the message header fields for the
message. See "JMS Properties" in TIBCO ActiveMatrix
BusinessWorks Bindings and Palette Reference for more
information about message header fields. Only properties
applicable to this type of message are displayed.
body
complex
The class specified for the Publication Service of the specified
adapter configuration.
TIBCO ActiveMatrix® Adapter Reference
38
| Chapter 1
Adapter Palette
Fault
The Fault tab lists the possible exceptions thrown by this activity.
The Fault 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 reply cannot be serialized.
ConfirmationException
The message cannot be confirmed.
ActivityTimeoutException
A timeout occurred.
TIBCO ActiveMatrix® Adapter Reference
| 39
Chapter 2
Migrating a Generic Adapter Configuration
Project Created in TIBCO Designer
You can migrate a supported adapter configuration project created in TIBCO
Designer with TIBCO ActiveMatrix BusinessWorks 5.x to TIBCO ActiveMatrix
BusinessWorks 6 by using the migration tool in TIBCO Business Studio.
See also:
•
The TIBCO ActiveMatrix BusinessWorks documentation.
•
List of Supported Adapter Configurations, page 40
•
Prerequisites of Migrating a TIBCO Designer Project, page 41
•
Migrating a TIBCO Designer Project, page 42
Topics
TIBCO ActiveMatrix® Adapter Reference
40
| List of Supported Adapter Configurations
List of Supported Adapter Configurations
The following are two lists of native and non-native adapter configurations that
are supported in the TIBCO Business Studio environment:
•
Native supported adapter configuration list:
— TIBCO ActiveMatrix® Adapter for Database
— TIBCO ActiveMatrix® Adapter for Files for Unix/Win
— TIBCO ActiveMatrix® Adapter for SAP
•
Non-Native supported adapter configuration list:
— TIBCO ActiveMatrix® Adapter for LDAP
— TIBCO ActiveMatrix® Adapter for PeopleSoft
— TIBCO ActiveMatrix® Adapter for IBM i
— TIBCO ActiveMatrix® Adapter for Siebel
For detailed product information, see each product documentation set.
You can only create non-native supported adapter configuration project in TIBCO
Designer and then migrate the validated project into TIBCO Business Studio.
TIBCO ActiveMatrix® Adapter Reference
| 41
Prerequisites of Migrating a TIBCO Designer Project
Before migrating a TIBCO Designer project, you need to first check the runtime
adapter version for migration and then, you need to validate the project in TIBCO
Designer.
•
Supported Runtime Adapter Version for Migration, page 41
•
Validating the Project in TIBCO Designer, page 41
Supported Runtime Adapter Version for Migration
The following are list of native and non-native runtime adapter version that are
supported to migrate into the TIBCO Business Studio environment:
•
Native adapter configuration version (onward) list:
— TIBCO ActiveMatrix® Adapter for Database 7.0.0
— TIBCO ActiveMatrix® Adapter for Files for Unix/Win 6.2.0
— TIBCO ActiveMatrix® Adapter for SAP 7.0.0
•
Non-Native supported adapter configuration version (onward) list:
— TIBCO ActiveMatrix® Adapter for LDAP 6.1.1
— TIBCO ActiveMatrix® Adapter for PeopleSoft 6.1.0
— TIBCO ActiveMatrix® Adapter for IBM i 6.1.0
— TIBCO ActiveMatrix® Adapter for Siebel 6.1.0
Validating the Project in TIBCO Designer
Before you prepare a project for migration, it is critical that you validate it. TIBCO
Designer includes reference-checking and other validation facilities that allow
you to make sure a project is internally consistent.
See “Validating Projects” in TIBCO Designer User’s Guide for details.
After you migrated a non-native adapter configuration project into the TIBCO
Business Studio, you cannot modify the project.
If you want to modify this project, you need to modify the project in the TIBCO
Designer and save it and then migrate this project into TIBCO Business Studio
again.
TIBCO ActiveMatrix® Adapter Reference
42
| Migrating a TIBCO Designer Project
Migrating a TIBCO Designer Project
Workflows for migrating non-native adapter configuration projects created in
TIBCO Designer are identical. This example describes how to migrate a TIBCO
ActiveMatrix Adapter for PeopleSoft project with a Publication BusinessWorks
process created in the TIBCO Designer into TIBCO Business Studio.
After completion of this example, you learn how a non-native GAC project and
TIBCO ActiveMatrix BusinessWorks process operate in TIBCO Designer.
Finish the following tasks to complete this example:
•
Creating a PeopleSoft Adapter Project in TIBCO Designer, page 42
•
Creating a BusinessWorks Process in TIBCO Designer, page 43
•
Testing the Adapter Project with a BusinessWorks Process, page 44
•
Migrating a TIBCO Designer Project, page 45
•
Testing the Migrated Project in TIBCO Business Studio, page 46
Creating a PeopleSoft Adapter Project in TIBCO Designer
The first step is to create an adapter project in TIBCO Designer.
Complete the following steps to create a PeopleSoft adapter project:
1. Launch TIBCO Designer.
2. Click New empty project in the TIBCO Designer wizard.
3. Select a project directory for this example, click OK.
4. Right-click the project name in Project panel.
5. Click Add Resource > PeopleSoft Adapter > PeopleSoft Adapter
Configuration to create a PeopleSoft adapter configuration.
6. Right-click Project_Name > PeopleSoftAdapterConfiguration > Adapter
Services.
7. Click Add Resource > PeopleSoft Adapter > CI Publication Service.
8. Modify global variables in the Global Variables panel.
Now you have created a CI Publication Service.
The following figure shows an example of the created PeopleSoft project in
TIBCO Designer:
TIBCO ActiveMatrix® Adapter Reference
| 43
Figure 9 PeopleSoft Adapter Project - CI Publication Service
Creating a BusinessWorks Process in TIBCO Designer
Complete the following steps to create a BusinessWorks process for the
Publication Service.
1. Right-click Project_Name > Add Resource > Process > Process Definition to
add process definition to the project.
2. Right-click Process_Name > Add Resource > ActiveEnterprise Adapter >
Adapter Subscriber to add an adapter subscriber to the process.
3. Click Save to save your project.
The following figure shows an example of the process:
Figure 10 CI Publication Service BusinessWorks Process
TIBCO ActiveMatrix® Adapter Reference
44
| Migrating a TIBCO Designer Project
Testing the Adapter Project with a BusinessWorks Process
You can complete the following steps to test the adapter project with a
BusinessWorks process:
1. You can use the Adapter Tester to test your adapter configuration. The
following figure shows an example of the testing result:
Figure 11 Testing Adapter Configuration
2. After successfully initialized the adapter process, now you can test the
BusinessWorks process as the following figure shows:
Figure 12 Testing BusinessWorks Process
TIBCO ActiveMatrix® Adapter Reference
| 45
3. You need to modify a Country parameter value in PeopleSoft server PIA, and
click Save. The following figure shows an example:
Figure 13 Modify Country Parameter in PeopleSoft Server
4. Click Save after successfully testing.
Now you can stop the adapter and the BusinessWorks process and then save your
project.
Migrating a TIBCO Designer Project
To migrate a TIBCO Designer project to TIBCO ActiveMatrix BusinessWorks 6,
follow these steps:
1. In TIBCO Business Studio, open the migration tool using one of the follow
ways:
— Click File > Import. In the opened dialog, expand the Migrate BW Projects
node, and select Migrate BW Projects.... Click Next.
— Click Project > Migrate BW Projects.
2. In the BusinessWorks Migration Tool dialog, specify the following fields:
— BusinessWorks 5 Projects Folder: the source location of the projects to
migrate.
— Migrated Project Folder: the target location of the migrated projects.
3. After you specify the BusinessWorks 5 project folder, in the displayed project
tree, select the adapter projects you want to migrate.
4. Click Migrate.
5. When the migration completes, click Close.
The migrated projects are displayed in the Project Explorer as shown in the
following figure:
TIBCO ActiveMatrix® Adapter Reference
46
| Migrating a TIBCO Designer Project
Figure 14 Migrated Example Project in TIBCO Business Studio
Testing the Migrated Project in TIBCO Business Studio
You can complete the following steps to test the migrated project in TIBCO
Business Studio:
1. Click Run > Run Configuration to launch the Run Configuration wizard.
2. Click New Launch Configuration to create a launch configuration for your
adapter instance.
3. Click Run to initiate the adapter as shown in the following figure:
TIBCO ActiveMatrix® Adapter Reference
| 47
Figure 15 Run Adapter in TIBCO Business Studio
4. Create a BusinessWorks Application and click Run to initiate the process as
the following figure shows:
Figure 16 Run BusinessWorks Process in TIBCO Business Studio
5. Modify a Country parameter value in PeopleSoft server PIA as shown in
Modify Country Parameter in PeopleSoft Server on page 45.
TIBCO ActiveMatrix® Adapter Reference
48
| Migrating a TIBCO Designer Project
Now you successfully tested the example in TIBCO Business Studio as following
figure shows:
Figure 17 Testing Example Result
TIBCO ActiveMatrix® Adapter 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