Configuration and Deployment

Configuration and Deployment
TIBCO ActiveMatrix® Adapter
Service Engine for Tuxedo
Configuration and Deployment
Software Release 6.0
March 2010
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 LICENSE.PDF) 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.
TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix
BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Designer, TIBCO Runtime Agent, TIBCO
Hawk, TIBCO Enterprise Message Service, TIBCO Designer Add-in for TIBCO Business Studio, TIBCO
ActiveMatrix Service Grid, TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix BusinessWorks Service
Engine, TIBCO ActiveMatrix Administrator, and TIBCO Business Studio are either registered trademarks or
trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun
Microsystems, Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their
respective owners and are mentioned for identification purposes only.
THIS 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.TXT 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 © 2008-2010 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Third-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
How to Contact TIBCO Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 2 Working with TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Starting TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Creating Adapter Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Importing TIBCO Designer Adapter Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Differences in Imported TIBCO Designer Adapter Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Importing Projects into Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Working with TIBCO ActiveMatrix BusinessWorks Service Engine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Creating an Adapter Project and Configuring an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Creating an ActiveMatrix SOA Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Creating a TIBCO Designer Project in TIBCO Business Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Generating a WSDL File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Adding and Configuring Composite Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Configuring the BusinessWorks process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Creating the Service Assembly. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Chapter 3 Preparing Tuxedo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
Preparing Tuxedo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
iv
| Contents
Chapter 4 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Before Starting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Preparing Tuxedo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Configuring an Adapter Service Engine Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Working with an ActiveMatrix SOA Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Deploying a Service Assembly Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Chapter 5 Configuring an Adapter Service Engine Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Tuxedo Connection Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Creating a Tuxedo Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Configuring a Tuxedo Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Tuxedo Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Importing Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Converting Tuxedo BOs to AESchemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Tuxedo Adapter Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Log Sinks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Timers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MultiThreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
55
55
60
69
71
73
Chapter 6 Working with ActiveMatrix SOA Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Creating an ActiveMatrix SOA Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Generating an Adapter WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Creating a TIBCO Shared Resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Configuring a TIBCO Shared Resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuring Composites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Creating a Service Assembly and a Service Assembly Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Chapter 7 Deploying the Service Assembly Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Creating a Service Assembly Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
For Adapter Projects Running in the Wired Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
For Adapter Projects Running in the Unwired Mode (Using the EAR2SA Tool) . . . . . . . . . . . . . . . . . . . . . . 96
Deploying a Service Assembly Archive. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Uploading a Service Assembly Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Configuring the Service Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Deploying the Service Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Starting the Service Assembly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Contents v
|
Chapter 8 Configuring Advanced Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Using Substitution Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Variable Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Predefined Substitution Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Using Distributed Queues to Process Outbound Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Appendix A Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Appendix B Message Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Subscriber Additional Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
RPC Server Additional Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Appendix C Adapter Agent API References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .121
TIBCO Rendezvous Adapter Agent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
TIBCO EMS Adapter Agent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
vi
| Contents
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Figures vii
|
Figures
Figure 1
TIBCO ActiveMatrix Product Family. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Figure 2
Workspace Launcher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Figure 3
The Workbench Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Figure 4
Create a Project - Select a Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Figure 5
Create a Project - Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Figure 6
Create a Project - Adapter Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Figure 7
The Project Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Figure 8
Import a Project - Import TIBCO Designer Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 9
Create a Project - Asset Type Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 10
Importing Existing Projects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 11
Tuxedo BO Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 12
Tuxedo BO Browser Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Figure 13
Tuxedo Connection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Figure 14
Selecting Tuxedo BO Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Figure 15
Adding the Publisher Endpoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Figure 16
Adding the JMS Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Figure 17
Selecting the JMS Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Figure 18
Creating a Tuxedo Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Figure 19
Tuxedo Connection Shared Resource Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Figure 20
Import a Tuxedo Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Figure 21
Tuxedo BOs Configuration Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Figure 22
Tuxedo Business Objects Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Figure 23
Tuxedo Adapter Business Object Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 24
The Schema Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Figure 25
Select Child Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Figure 26
Create an ActiveMatrix SOA project - Select a Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Figure 27
Create an ActiveMatrix SOA Project - New SOA Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Figure 28
Create an ActiveMatrix SOA Project - Asset Type Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
viii
| Figures
Figure 29
Target Project Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Figure 30
Generated Adapter WSDL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Figure 31
TIBCO Resource Wizard - Select a Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Figure 32
Component Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Figure 33
Resource Picker Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Figure 34
Service Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Figure 35
Endpoint Configuration for the JMS Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Figure 36
Transport Configuration for the SOAP Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Figure 37
Select an EAR File to Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Figure 38
Substitution Variables in TIBCO ActiveMatrix Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Figure 39
Defining an RVCMQ Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tables ix
|
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Table 2
Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Table 3
Tuxedo Server Environment Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 4
Tuxedo Client Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Table 5
Tuxedo Connection Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 6
Initialization Flags Values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Table 7
Adapter Instance Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 8
Publisher Configuration parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 9
Subscriber Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 10
RPC Server Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Table 11
RPC Client Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 12
Log Sink Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 13
Timer Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Table 14
Predefined Properties for Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 15
JMS Shared Resource Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 16
HTTP Server Shared Resource Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 17
Component Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Table 18
Service Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Table 19
Properties for Common Logging Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Table 20
Predefined Substitution Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Table 21
Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Table 22
Predefined Properties for TIBCO ActiveMatrix. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Table 23
Subscriber Additional Fields for the Request Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Table 24
Subscriber Additional Fields for the Reply Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Table 25
RPC server Additional Fields for the Request Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Table 26
RPC Server Additional Fields for the Reply Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
x
| Tables
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| xi
Preface
This document describes how to create, configure, and deploy projects using
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo.
Topics
•
Related Documentation, page xii
•
Typographical Conventions, page xiv
•
How to Contact TIBCO Support, page xvii
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
xii
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo Documentation
The following documents form the TIBCO AdtiveMatrix Adapter Servcie Engine
for Tuxedo documentation set:
•
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo Installation Read this
manual to learn how to install TIBCO AdtiveMatrix Adapter Servcie Engine
for Tuxedo.
•
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo Configuration and
Deployment Read this manual for instructions on creating, configuring, and
deploying adapter projects.
•
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo Examples Read this
manual to work through the examples provided with the adapter.
•
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo 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.
Other TIBCO Product Documentation
You may find it useful to read the documentation for the following TIBCO
products. Each of the books is available from the doc directory in the product’s
installation area.
•
TIBCO Designer™
•
TIBCO Administrator™
•
TIBCO ActiveMatrix® Administrator
•
TIBCO ActiveMatrix BusinessWorks™
•
TIBCO ActiveMatrix BusinessWorks™ Service Engine
•
TIBCO Rendezvous®
•
TIBCO Enterprise Message Service™
•
TIBCO Hawk®
•
TIBCO Adapter™ SDK
•
TIBCO Runtime Agent™
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preface xiii
|
•
TIBCO Business Studio™
•
TIBCO ActiveMatrix® Service Grid
•
TIBCO ActiveMatrix® Service Bus
Third-Party Documentation
You may also find it useful to read the Oracle Tuxedo User documentation.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
xiv
| Typographical Conventions
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention
Use
TIBCO_HOME
Many TIBCO products must be installed within the same home directory. This
directory is referenced in documentation as TIBCO_HOME. The value of
TIBCO_HOME depends on the operating system. For example, on Windows
systems, the default value is C:\tibco.
ENV_HOME
AMX_HOME
Other TIBCO products are installed into an installation environment.
Incompatible products and multiple instances of the same product are installed
into different installation environments. The directory into which such products
are installed is referenced in documentation as ENV_HOME. The value of
ENV_HOME depends on the operating system. For example, on Windows
systems the default value is C:\tibco.
TIBCO ActiveMatrix installs into a directory inside ENV_HOME. This directory is
referenced in documentation as AMX_HOME. The value of AMX_HOME depends
on the operating system. For example, on Windows systems the default value is
C:\tibco\amx\.
TIBCO AdtiveMatrix Adapter Servcie Engine for Tuxedo is installed in a
directory inside AMX_HOME.
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 Service Engine for Tuxedo Configuration and Deployment
Preface xv
|
Table 1 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
BusinessWorks Concepts.
•
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 variable in a command or code syntax that you must replace.
For example: MyCommand PathName
Key name 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.
Table 2 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 Service Engine for Tuxedo Configuration and Deployment
xvi
| Typographical Conventions
Table 2 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 Service Engine for Tuxedo Configuration and Deployment
Preface xvii
|
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, please
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 Service Engine for Tuxedo Configuration and Deployment
xviii How to Contact TIBCO Support
|
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
|1
Chapter 1
Introduction
This chapter provides an introduction to TIBCO ActiveMatrix Adapter Service
Engine for Tuxedo.
Topics
•
Overview, page 2
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| Chapter 1
Introduction
Overview
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo is a gateway for TIBCO
ActiveMatrix Adapter for Tuxedo to the Service Oriented Architecture (SOA)
world. The TIBCO ActiveMatrix Adapter Service Engine for Tuxedo provides an
ActiveMatrix container to deploy adapter projects using the TIBCO ActiveMatrix
Administrator.
This manual describes the process of creating and configuring an adapter
instance, packaging it into a service assembly and then deploying the services.
The design-time tool used is TIBCO Business Studio and the services are
deployed using TIBCO ActiveMatrix Administrator.
Before proceeding you should familiarize yourself with the concepts and the
terminology used by TIBCO ActiveMatrix Adapter Service Engine for Tuxedo
and TIBCO ActiveMatrix platform.
Figure 1 shows the TIBCO ActiveMatrix product family.
Figure 1 TIBCO ActiveMatrix Product Family
TIBCO ActiveMatrix Service Grid
TIBCO ActiveMatrix
Policy Manager
Java
TIBCO ActiveMatrix
Registry
2
.NET
Java
C++
TIBCO
ActiveMatrix
Adapter Service
Engine
TIBCO
ActiveMatrix
BusinessWorks
TIBCO ActiveMatrix Service Bus
Mediation
SOAP
TIBCO Enterprise Message Service
TIBCO
Adapter
TIBCO Business Studio
Adapter
Service
Engine
JMS
CompositeMediation
TIBCO ActiveMatrix
TIBCO
TIBCO ActiveMatrix
Editor Flow Editor
Administrator Management Daemon Policy Agent
Legend
Implementation
Type
Binding
Type
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
|3
Chapter 2
Working with TIBCO Business Studio
Topics
•
Overview, page 4
•
Starting TIBCO Business Studio, page 5
•
Creating Adapter Projects, page 8
•
Importing TIBCO Designer Adapter Projects, page 11
•
Importing Projects into Workspace, page 15
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
4
| Chapter 2
Working with TIBCO Business Studio
Overview
The TIBCO ActiveMatrix development tools consist of TIBCO Business Studio
Workbench and a set of TIBCO ActiveMatrix plug-ins. This chapter describes how
to start TIBCO Business Studio, create a new adapter project, and import projects
and files into the project.
For information on TIBCO Business Studio, refer to the Workbench User Guide in
the Workbench online help. To view the online help, select Help > Help Contents.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Starting TIBCO Business Studio 5
|
Starting TIBCO Business Studio
To start TIBCO Business Studio, follow these steps:
1. Execute one of the following platform-specific commands to open the
Workspace Launcher window.
— On Microsoft Windows
From the Start menu, select All Programs > TIBCO > TIBCO Business
Studio 2.2 > TIBCO Business Studio.
or
From the command line, run
AMX_HOME\BusinessStudio\TIBCOBusinessStudio.exe.
— On UNIX
Run AMX_HOME/BusinessStudio/TIBCOBusinessStudio.
2. The Workspace Launcher dialog appears, as shown in Figure 2. Accept the
default workspace or browse to create a new workspace. Click OK.
Figure 2 Workspace Launcher
3. The Workbench window appears, as shown in Figure 3. For the first time a
new workspace is selected, a Welcome screen is displayed in the window.
The Layout of the Workbench Window
The Workbench window contains the following areas: Menu, Toolbar, Project
Explorer Panel, Outline Panel, Editor Panel, and Views Panel. For detailed
information, refer to Help > Help Content > Workbench User Guide.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
6
| Chapter 2
Working with TIBCO Business Studio
Figure 3 The Workbench Window
Menu
Toolbar
Project
Explorer
Panel
Editor
Panel
View
Panel
Outline
Panel
•
Menu
Contains menu items such us File, Edit, Navigate, Project, Run, Window, and
Help.
•
Toolbar
Contains buttons for the most frequently used commands.
•
Project Explorer Panel
Displays a tree containing all the project resources such as project folders,
shared resource definition files, WSDL files, composite files, service assembly
files, and so on.
•
Editor Panel
Displays editors for the objects currently being edited. You can switch
between editors by clicking tabs at the top of the Editor area. The Composite
Editor contains a canvas on which you can drop elements and a palette that
organizes the elements that you have added to the composite. Other editors
allow you to configure shared resources and service assemblies.
•
Outline Panel
Provides an overview of the Composite Editor canvas. You can easily navigate
from one part of a composite to another.
The Outline view also displays a content tree structure that contains the
composite elements inside the composite. In this view you can delete the
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Starting TIBCO Business Studio 7
|
contents of the composite. When you select a composite element in the
Outline tree, the corresponding artifact in the composite becomes selected.
•
Views Panel
Displays under the Editor Area and contains the following views by default:
— Properties
Displays property sheets for editing composites and composite elements.
When you select a composite or composite element in the Composite Editor
canvas, this view shows the properties of the selected object in a vertical
tabbed notebook.
— Problems
Displays validation and other errors.
— Registries
Lists UDDI registries and the WSDL files returned from searching a
registry.
You open a view by selecting Window > Show View.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
8
| Chapter 2
Working with TIBCO Business Studio
Creating Adapter Projects
Adapter projects contain adapter service engine configurations, related shared
resources and business functionality which must be enabled for the adapter
service engine to function. Adapter projects are created using TIBCO Business
Studio.
To create an Adapter project, follow these steps:
1. Start TIBCO Business Studio.
2. Select File > New > Project from the Menu to open the New Project window.
3. Select TIBCO ActiveMatrix Adapters > Adapter Project in the Select a wizard
page, as shown in Figure 4, and then click Next.
Figure 4 Create a Project - Select a Wizard
4. Type the adapter project name (For example, TIB_Adapter) in the Project name
field, as shown in Figure 5, and then click Next.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating Adapter Projects 9
|
Figure 5 Create a Project - Project
5. Select the asset types to configure for the project in the Asset Type Select page,
and click Next.
6. Type a name for the Shared Resources folder in the Folder field and then click
Next.
7. Type a name for the Adapter Configurations folder in the Folder field, as
shown in Figure 6, and then click Finish.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
10
| Chapter 2
Working with TIBCO Business Studio
Figure 6 Create a Project - Adapter Configurations
The newly created project is shown in the Project Explorer, as shown in Figure 7.
It contains the following folders:
•
Adapter Configurations
•
AESchemas
•
defaultVars
•
Shared Resources
Figure 7 The Project Structure
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Importing TIBCO Designer Adapter Projects 11
|
Importing TIBCO Designer Adapter Projects
For the standalone component of the adapter, TIBCO ActiveMatrix Adapter for
Tuxedo, the adapter projects created using TIBCO Designer can also be imported
and used in the TIBCO Business Studio environment.
For detailed information about directly creating a TIBCO Designer project in
TIBCO Business Studio, refer to Working with TIBCO ActiveMatrix
BusinessWorks Service Engine.
To import a TIBCO Designer adapter project, follow these steps:
1. Start TIBCO Business Studio.
2. Select File > Import... from the Menu to open the Import window.
3. Expand the TIBCO ActiveMatrix Adapters folder and select Import TIBCO
Designer Projects in the Select page.
4. Select a directory or an archive file to search for the existing TIBCO Designer
projects, as shown in Figure 8, and then click Next.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
12
| Chapter 2
Working with TIBCO Business Studio
Figure 8 Import a Project - Import TIBCO Designer Projects
a. Choose between Select root directory and Select archive file and click the
Browse... button to navigate to the folder where the Designer adapter
project is located or select the archive containing the Designer adapter
projects. Click OK.
b. In the Projects pane, check the checkbox for the project you want to import
as well as the services contained in the project.
c. The Copy projects into workspace checkbox is checked by default and the
projects are copied into the current workspace.
5. Select the import options from the Project Import Options page, as shown in
Figure 9, and then click Finish.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Importing TIBCO Designer Adapter Projects 13
|
Figure 9 Create a Project - Asset Type Selection
Differences in Imported TIBCO Designer Adapter Projects
When you import a TIBCO Designer adapter project, the following differences in
the project and configuration should be noted:
•
The names of the adapter configuration, the folders for the connection
references, and the shared resources are as follows:
— TuxedoAdapterConfiguration.adtuxedomodel
— TuxedoAdapterConfiguration_genresources
•
The value of the Standard MicroAgentName field (located in the
TuxedoAdapterConfiguration->Monitoring tab in TIBCO Designer) has been
changed from
COM.TIBCO.ADAPTER.adtuxedo.%%Deployment%%.%%InstanceId%% to
COM.TIBCO.ADAPTER.adtuxedo.%%Deployment%%.TuxedoAdapterConfiguration
•
The value of the Class MicroAgentName field (located in the
TuxedoAdapterConfiguration > Monitoring tab in TIBCO Designer) has been
changed from COM.TIBCO.adtuxedo.%%Deployment%%.%%InstanceId%% to
COM.TIBCO.adtuxedo.%%Deployment%%.TuxedoAdapterConfiguration.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
14
| Chapter 2
Working with TIBCO Business Studio
•
The following fields are not imported:
— Transport Configuration
— Advanced Logging
— Termination Subject or Topic
— The Fields in the Multithread Tab
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Importing Projects into Workspace 15
|
Importing Projects into Workspace
Follow these steps to import projects created in another workspace to the current
workspace:
1. Start TIBCO Business Studio.
2. Select File > Import... from the Menu to open the Import dialog.
3. Select General > Existing Projects into Workspace in the Select page and then
click Next. The Import dialog appears as shown in Figure 10.
4. Select a directory or an archive file to search for the existing projects in another
workspace, and then click Next.
— Choose between Select root directory and Select archive file and click the
Browse... button to navigate to the folder where the existing project is
located or select the archive containing the projects. Click OK.
— In the Projects pane, check the checkbox for the project you want to import
as well as the services contained in the project.
— Check the Copy projects into workspace checkbox if you want to copy the
projects into the current workspace.
5. Click Finish.
Figure 10 Importing Existing Projects
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
16
| Chapter 2
Working with TIBCO Business Studio
Working with TIBCO ActiveMatrix BusinessWorks Service Engine
This section introduces procedures that have to be carried out to integrate the
adapter with TIBCO ActiveMatrix BusinessWorks Service Engine.
Before installing TIBCO ActiveMatrix BusinessWorks Service Engine, you need to
install TIBCO Designer Add-in for TIBCO Business Studio.
To configure a TIBCO ActiveMatrix BusinessWorks Service Engine example,
complete the following configuration:
•
Creating an Adapter Project and Configuring an Adapter Instance
•
Creating an ActiveMatrix SOA Project
•
Creating a TIBCO Designer Project in TIBCO Business Studio
•
Generating a WSDL File
•
Adding and Configuring Composite Elements
•
Configuring the BusinessWorks process
•
Creating the Service Assembly
Creating an Adapter Project and Configuring an Adapter Instance
To create an adapter project and configure an adapter instance, refer to Creating
Adapter Projects and Chapter 5, Configuring an Adapter Service Engine Instance.
Creating an ActiveMatrix SOA Project
To create a SOA project, refer to Creating an ActiveMatrix SOA Project.
Creating a TIBCO Designer Project in TIBCO Business Studio
To create a TIBCO Designer Project, follow these steps:
1. Select File > New > Project from the Menu to open the New Project window.
2. Select TIBCO Designer > TIBCO Designer Project in the Select a wizard
page, and then click Next.
3. Type the designer project name (For example, ADTUXEDO_DEMO_DESIGNER)
in the Project name field and select the Create new project in the workspace
radio button.
4. Click Finish.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Working with TIBCO ActiveMatrix BusinessWorks Service Engine 17
|
Generating a WSDL File
After creating the ActiveMatrix SOA project, generate a WSDL file from the
adapter instance that you have configured in Creating an Adapter Project and
Configuring an Adapter Instance and save the WSDL file into the SOA project.
For detailed information about how to generate a WSDL file, refer to Generating
an Adapter WSDL.
Adding and Configuring Composite Elements
To add and configure composite elements, follow these steps:
1. Click the ActiveMatrix SOA project in the Project Explorer Panel, and then
double click SOA_Project_Name.composite under the Composites folder to
launch the Composite Editor on the right.
2. Drag and drop the TuxedoAdapter icon from the Components Palette into the
Components canvas. Configure the Tuxedo Adapter Component and add a
service to it.
For detailed information about configuring a Tuxedo Adapter Component,
refer to Configuring Composites.
3. Drag and drop the BusinessWorks icon from the Components Palette into the
Components canvas and configure the BusinessWorks component.
a. Specify the name for the created BusinessWorks component.
b. In the Properties view, click the Implementation tab and click the Browse
button to select the TIBCO Designer project created in Creating a TIBCO
Designer Project in TIBCO Business Studio.
4. Import the folder where the WSDL file, generated in Generating a WSDL File,
and the corresponding schema folder into the TIBCO Designer project created
in Creating a TIBCO Designer Project in TIBCO Business Studio.
5. Go back to the Composite Editor and select the BusinessWorks component. In
the Properties view, click the Reference tab, and then click the Add button to
add the service reference that you have imported in step 4. A TIBCO
ActiveMatrix BusinessWorks process is generated in the TIBCO Designer
project.
Configuring the BusinessWorks process
To configure a BusinessWorks process, follow these steps:
1. Double click the BusinessWorks process generated in Adding and
Configuring Composite Elements.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
18
| Chapter 2
Working with TIBCO Business Studio
2. Drag the related activities into the Process and configure the activities.
For example, drag and drop the Invoke Partner activity when configuring the
process for a subscriber or RPC server. Drag and drop the Receive Partner
Notification activity when configuring a publisher.
Creating the Service Assembly
All the services and components that were created in the previous tasks need to
be packaged in a service assembly before being deployed using TIBCO
ActiveMatrix Administrator.
For detailed information about how to create a service assembly and service
assembly archive, refer to Creating a Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 19
Chapter 3
Preparing Tuxedo
This chapter explains how to prepare Tuxedo services to interact with the adapter
services. It lists the environment variables that need to be set and the steps
required to create a Tuxedo configuration file and boot Tuxedo services.
Topics
•
Preparing Tuxedo, page 20
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
20
| Chapter 3
Preparing Tuxedo
Preparing Tuxedo
Before configuring the adapter, you must complete the tasks in this section to
allow the adapter to access Tuxedo services. Set the required environment
variables, boot the Tuxedo services and ensure that they are running successfully.
This section explains how to prepare Tuxedo services to interact with the adapter.
You need to perform the following tasks to prepare Tuxedo:
•
Task A, Set Environment Variables
•
Task B, Edit the ubbconfig File
•
Task C, Create Tuxedo Configuration Files
•
Task D, Modify the Server Program to Invoke the Agent Method
•
Task E, Create Executable Files
•
Task F, Boot Tuxedo Services
Task D is necessary only when you are using an RPC client or agent based
publisher.
Task A Set Environment Variables
Set the following environment variables:
•
Tuxedo Server Settings
Set the following environment variables on the machine where Tuxedo is
installed and where the services are to be booted.
Table 3 Tuxedo Server Environment Variables
Name
Description
TUXDIR
Tuxedo installation directory. For example, TUXDIR=C:\bea\tuxedo8.1
WSNADDR
The IP address of the WSL (Workstation Listener) that the client will contact, along
with any free port number. This value must be reflected in the ubbconfig file. This
variable need not be set for the adapter in the native client mode. For example,
WSNADDR=//192.168.213.63:4020 (//IP address: Port number)
TIBCO_RV_HOME
TIBCO Rendezvous installation directory. For example,
TIBCO_RV_HOME=TIBCO_HOME\tibrv\8.1
APPDIR
Directory where the Tuxedo service executable files are located.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preparing Tuxedo 21
|
Table 3 Tuxedo Server Environment Variables
Name
Description
PATH
The environment variable is used to find executables. For example,
%TUXDIR%\bin;%APPDIR%;%PATH%;%TUX_ADAPTER_HOME%\hotfix\lib;%TUX
_ADAPTER_HOME%\lib;%TIBCO_RV_HOME%\bin
TUXCONFIG
The name of the Tuxedo configuration file to be generated along with the location. The
value specified cannot exceed 64 characters for versions of Tuxedo 8.0 or lower whereas
it can be up to 256 characters for Tuxedo 8.1 or higher. Please ensure these limits are not
exceeded depending on the version of Tuxedo that is being used. For example,
TUXCONFIG: %APPDIR%\tuxconfig.
ULOGPFX
The location of Application Log File. For example, %APPDIR%/ulog
When using Tuxedo’s queue-based communication, set the following variables:
The queue device. The name and location where the ’que’ configuration file
will be generated. The ’que ’file will contain queue related details like queue
manager, list of queues and other parameters like maximum size. Set to
QMCONFIG
%APPDIR%\QUE.
The IPC key for the queue is the unique identifier associated with a particular queue.
QIPCKEY
Note that the value set for the QIPCKEY variable must be different from that specified
in the ubbconfig file *RESOURCES IPCKEY parameter.
To run the adapter as a native client, the environment variable WSNADDR need
not be set.
If the Field ID is to be loaded dynamically at runtime, set the following variables
FLDTBLDIR32
It contains a list of directories (separated by commas) where field tables can be
found.
FIELDTBLS32
It contains a list of the files in the table directories (separated by commas) that are to be
used.
•
Adapter machine (Tuxedo client) settings:
Set the following environment variables on the machine where the adapter is
installed.
Table 4 Tuxedo Client Environment Variables
Name
Description
TUXDIR
The Tuxedo installation directory. For example, TUXDIR=C:\bea\tuxedo8.1
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
22
| Chapter 3
Preparing Tuxedo
Table 4 Tuxedo Client Environment Variables
Name
Description
APPDIR
The directory where the adapter executable file is located. For example,
APPDIR=TIBCO_HOME\adapter\adtuxedo\veriosn_number\bin.
PATH
The environment variable used to find executables. For example,
%TUXDIR%\bin;%APPDIR%;%PATH%.
WSNADDR
The IP address of the WSL (Workstation Listener), along with the port number. This value
must correspond to that set in the server machine. For example,
WSNADDR=//192.168.213.63:4020 (//IP address: Port number).
WSNADDR
ULOGPFX
need not be set for a Native client. TUXCONFIG needs to be set instead.
The location of the application log file. For example, %APPDIR%/ULOG.
If the Field ID is to be loaded dynamically at runtime, set the following variables
FLDTBLDIR32
It contains a list of directories (separated by commas) where field tables can be
found.
FIELDTBLS32
It contains a list of the files in the table directories (separated by commas) that are to be
used.
Task B Edit the ubbconfig File
Edit the ubbconfig file to reflect the same values for the environment variables
set on the machine with the Tuxedo client and server installation. The ubbconfig
file contains default values as bracketed items. Change the default values as per
your requirements.
Ensure that the values specified for the environment variables are reflected in the
ubbconfig file. The settings to be modified are as follows:
•
MACHINES Section
— Change the machine name to the machine name on which the adapter is
installed.
—
TUXDIR—Tuxedo
—
APPDIR—Directory
—
TUXCONFIG—The name of the Tuxedo configuration file to be generated
along with the location. The value specified cannot exceed 64 characters, so
installation directory.
where the Tuxedo service executable files are located.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preparing Tuxedo 23
|
ensure that your directory structure is such that the path and file name
together are 64 characters or less.
—
ULOGPFX
—
MAXWSCLIENTS—The
- The location of Application Log File.
maximum number of clients that can connect to
Tuxedo. The default is set to 0 (zero). You must set this to 1 or higher in
order to boot the Tuxedo services successfully. The maximum number of
clients that can be specified is 32767. This need not be set if it is a native
client.
Ensure that MAXWSCLIENTS is set to 1 or higher.
•
Servers Section
— CLOPT (modify the IP address to reflect the value specified for the WSNADDR
environment variable). If the client that will connect to this server is to be
used as a native client, this is not required to be set.
For a publisher and subscriber configuration, you also need to set the
following:
—
SRVGRP
(modify the directory to point to APPDIR)
— For Event-based communication supported by the adapter publisher and
subscriber, the location of the EventBroker Repository has to be mentioned
along with the -f option in CLOPT.
Refer to Tuxedo documentation for details on editing the ubbconfig file.
Task C Create Tuxedo Configuration Files
Convert the ubbconfig file into a Tuxedo configuration file. Once the Tuxedo
configuration file has been generated, it will be placed in the path specified for the
TUXCONFIG environment variable.
1. Type either of the following at a command prompt:
tmloadcf -y
ubbconfig file name
or
tmloadcf
ubbconfig file name
(Answer "y" if it prompts you on whether it should proceed)
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
24
| Chapter 3
Preparing Tuxedo
2. At the command prompt, change the directory to APPDIR (where the Tuxedo
service executable files are located) and run the tmadmin command. For
example,
AMX_HOME
\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\Tuxedo
Service Codes\Employee>tmadmin
A ">" prompt is displayed as shown in the sample below:
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\T
uxedo Service Codes\Employee>tmadmin
tmadmin - Copyright (c) 1996-1999 BEA Systems, Inc
Portions * Copyright 1986-1997 RSA Data Security,
All Rights Reserved.
Distributed under license by BEA Systems, Inc.
>
Tuxedo is a registered trademark.
3. Create a transaction log (TLOG device), by going to the > prompt and typing
echo, then type crdl -b 200 -z
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\T
uxedo Service Codes\Employee\TLOG and
press Enter as shown in the
sample below:
>echo
Echo now on.
> crdl -b 200 -z
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\T
uxedo Service Codes\Employee\TLOG
device created on
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\T
uxedo Service Codes\Employee\TLOG
step 2 and step 3 need to be followed if a database is being used. They can be
ignored for the examples provided with the adapter.
If the adapter has to establish multiple connections with the Tuxedo server, you
need to modify the default server settings.
The following settings control access to your applications:
•
MAXACCESSORS
•
MAXSERVERS
•
MAXWSCLIENTS
•
The WSL configuration settings
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preparing Tuxedo 25
|
You need to adjust these settings to ensure that the number of allowable client
connections is properly configured.
The WSL settings are:
WSL SRVGRP=Group SRVID=ID
CLOPT="-A -- -n //IP
address:Port number
-m <minimum WSHs that will be booted >
-M <maximum WSHs that will be booted>
-x < maximum number of clients connected at any one time>"
The -m and -M determine how many WSH processes will be started. If you want to
allow more connections, you should increase the -M value. Depending on the
number of connections to be increased, you have to accordingly increase the
MAXWSCLIENTS value. The -x value is the multiplexing factor. This determines
how many connections can be handed by one WSH process.
Task D Modify the Server Program to Invoke the Agent Method
Complete this task only if you are configuring an adapter with an RPC client or a
publisher that uses the adapter agent.
1. Modify the Tuxedo service to invoke the method of the Adapter Agent. Refer
to Appendix C, Adapter Agent API References for detail.
2. Make a copy of the adapteragent.h file present in the
TIBCO_HOME\adapter\adtuxedo\veriosn_number\include
directory.
3. Paste this file into the directory where the Tuxedo service .c file is present.
4. Add the following statement in the Tuxedo service.c file,
#include adapteragent.h,if
the service is based on TIBCO Rendezvous.
#include adapteragentJms.h,if
the service is based on TIBCO EMS.
When the buffer type is FML32, the Adapter Agent wraps the FML32 buffer in a
CArray buffer and sends it to the adapter. You should allocate sufficient memory
for the reply FML32 buffer in the calling Tuxedo service before calling any of the
adapter agent methods that are mentioned above.
Refer to the EAR to SA and RPC Client Binding with JMS examples from TIBCO
ActiveMatrix Adapter Service Engine for Tuxedo Examples.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
26
| Chapter 3
Preparing Tuxedo
Task E Create Executable Files
To create executables for Tuxedo client and server programs using the
buildclient and buildserver utilities:
1. Type the following at the command prompt in order to generate the binary file
for the client program.
buildclient -o
client executable file name -f client .c file name
2. Type the following at the command prompt to create the executable in order
to generate the binary file for the server program— subscribers, RPC servers and Event-based Publishers
buildserver -o
server executable file name -f server .c file name -s service name
— RPC clients and Agent-based Publishers. The service should be built with
the agent.lib, libagent.so or libagent.sl file depending on the
platform.
buildserver -o
server executable file name -f server .c file name -s service name
TIBCO_HOME\adapter\adtuxedo\veriosn_number\lib\agent library file
name
-l
(where the Rendezvous Adapter Agent library file name is agent.lib on
Microsoft Windows, libagent.so on Solaris, AIX, HP-UX IA, or
libagent.sl on HP-UX PA_RISC)
Task F Boot Tuxedo Services
Use the following steps to start Tuxedo services and verify that they are active.
1. Type the following command to boot the server:
tmboot -y
If the above steps are applied to the EMPLOYEE example, the following message
displays on the screen indicating that the Tuxedo services are being
successfully booted:
Booting all admin and server processes in
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples\BWSE\T
uxedo Service Codes\Employee\tuxconfig
INFO: BEA Tuxedo, Version 8.1, 32-bit, Patch Level 314
INFO: Serial #: 454493271161-2664947729544, Expiration NONE,
Maxusers 1000000
INFO: Licensed to: Customer
Booting admin processes ...
exec BBL -A :
process id=476 ... Started.
Booting server processes ...
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preparing Tuxedo 27
|
exec WSL -A -- -n //127.0.0.1:8100 -m 10 -M 20 -x 5 :
process id=8484 ... Started.
exec server -A :
process id=8940 ... Started.
3 processes started.
2. Type the following command to verify that all server and services are active:
tmadmin
A ’>’ prompt displays if the configuration is active as shown in the sample
below.
tmadmin - Copyright (c) 1996-1999 BEA Systems, Inc.
Portions * Copyright 1986-1997 RSA Data Security, Inc.
All Rights Reserved.
Distributed under license by BEA Systems, Inc.
Tuxedo is a registered trademark.
If the configuration is not active, the following message displays:
No bulletin board exists Entering boot mode
>
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
28
| Chapter 3
Preparing Tuxedo
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 29
Chapter 4
Getting Started
This chapter describes the basic steps to configure and deploy TIBCO
ActiveMatrix Adapter Service Engine for Tuxedo.
Topics
•
Overview, page 30
•
Preparing Tuxedo, page 31
•
Configuring an Adapter Service Engine Instance, page 32
•
Working with an ActiveMatrix SOA Project, page 37
•
Deploying a Service Assembly Archive, page 43
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
30
| Chapter 4
Getting Started
Overview
This chapter provides a short exercise on how to configure TIBCO ActiveMatrix
Adapter Service Engine for Tuxedo with a publisher, how to work with an
ActiveMatrix SOA project, and how to deploy a service assembly archive using
TIBCO ActiveMatrix Administrator.
Before Starting
Before starting the configuration exercise, ensure that all the required software
has been installed and is operating correctly. For a list of required software, see
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Installation.
The design time tool used is TIBCO Business Studio and the services are deployed
using TIBCO ActiveMatrix Administrator.
Before proceeding, you should familiarize yourself with the concepts and the
terminology used by TIBCO ActiveMatrix.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Preparing Tuxedo 31
|
Preparing Tuxedo
This section describes how to prepare Tuxedo for this exercise.
This exercise uses the Tuxedo files provided in the agent-based publisher example
packaged with the adapter. The pre-configured examples are located in the
AMX_HOME\amx\extensions\adtuxedose\veriosn_number\samples directory.
You can decompress the Tuxedo_Adapter_Service_Engine_Samples.zip file to
a directory. For example, decompress the
Tuxedo_Adapter_Service_Engine_Samples.zip file to D:\demo. The Tuxedo
service executable and header files to be used are located in the
D:\demo\Ear2Sa\Tuxedo Service Codes\PurchaseOrder directory.
Follow these steps to prepare your Tuxedo environment for this example:
1. Go to the D:demo\Ear2Sa\Tuxedo
Service Codes\PurchaseOrder
folder.
2. Open the make.bat file to modify the following variables. For example, set the
following values to the variables:
set TUXDIR=c:\bea\tuxedo8.1
set WSNADDR=//192.168.66.44:8100
set TUX_ADAPTER_HOME=TIBCO_HOME\adapter\adtuxedo\veriosn_number
set TIBCO_RV_HOME=TIBCO_HOME\tibrv\veriosn_number
set APPDIR=D:\demo\Ear2Sa\Tuxedo Service Codes\PurchaseOrder
3. Open the ubbagent file to modify the following variables. For example, set the
following values to the variables:
*MACHINES
MYMACHINE LMID=SITE3
TUXDIR="c:\bea\tuxedo8.1"
APPDIR="D:\demo\Ear2Sa\Tuxedo Service Codes\PurchaseOrder"
TUXCONFIG="D:\demo\Ear2Sa\Tuxedo Service
Codes\PurchaseOrder\tuxconfig"
ULOGPFX="D:\demo\Ear2Sa\Tuxedo Service
Codes\PurchaseOrder\ulog"
MAXWSCLIENTS=10
WSL SRVGRP=GROUP1 SRVID=3
CLOPT="-A -- -n //192.168.66.44:8100 -m 1 -M 10 -x 1"
4. Navigate to the APPDIR directory from a command line and run the
make.bat file as follows. This sets the environment variables, creates the
Tuxedo configuration files, creates the executables, and boots the Tuxedo
services.
D:\demo\Ear2Sa\Tuxedo Service Codes\PurchaseOrder make
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
32
| Chapter 4
Getting Started
Configuring an Adapter Service Engine Instance
The next sections lead you through a quick configuration exercise. This exercise
covers the following tasks:
•
Task A, Create an Adapter Project
•
Task B, Create and Configure a Tuxedo Connection
•
Task C, Import Tuxedo Business Objects
•
Task D, Create and Configure a Tuxedo Adapter Configuration
•
Task E, Create and Configure a Publisher
Task A Create an Adapter Project
TIBCO Business Studio is used to create and configure adapter instances and
services. Before creating an adapter instance, you must create or select an adapter
project. The project contains configuration options used by a runtime adapter.
1. Start TIBCO Business Studio, select New >Adapter Resources... from the File
menu. The Create New Adapters Resource dialog appears.
2. Select Adapter Project and click Next.
3. Type the project name in the New Adapter Project dialog. For example, type
tuxedo_demo.
4. Click Finish. An adapter project is created.
For detailed information about creating a new adapter project, refer to Creating
Adapter Projects.
Task B Create and Configure a Tuxedo Connection
1. Create a Tuxedo Connection shared resource.
a. Click the tuxedo_demo project in the Project Explorer Panel, and then
select File > New > Adapter Resources... from the Menu. The Create New
Adapters Resource dialog appears.
b. Expand the Shared Resources folder and select Tuxedo Connection.
c. Click Next to open the Tuxedo Connection Shared Resource dialog, and
then select the parent folder. For example, select tuxedo_demo as the
parent folder.
d. Click Finish. The Tuxedo Connection Shared Resource editor is open.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Configuring an Adapter Service Engine Instance 33
|
2. Configure the Tuxedo connection by specifying the following parameters in
the Tuxedo Connection Shared Resource editor.
— User Name
— User Password
— Client Name
— Group Name
— Application Password
— Initialization Flags
For detailed information about creating and configuring a Tuxedo Connection,
refer to Tuxedo Connection Shared Resource.
Task C Import Tuxedo Business Objects
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo introduces the concept
of a Business Object (BO). In the simplest sense, a BO is the representation of the
data model of the business entities like invoice, orders, customers or vendors.
To import Tuxedo Business Objects (BOs), follow these steps:
1. Select the tuxedo_demo project in the Project Explorer panel, and then select
File > Import from the Menu.
2. Expand the TIBCO ActiveMatrix Adapters folder and select Metadata >
Tuxedo Objects.
3. Click Next to open the Tuxedo Business Object Configuration dialog.
4. In the Tuxedo Business Object Configuration dialog, enter the name and the
location of the schema to save. For example, enter tuxedo_demo_bo in the
Name field and browse to the tuxedo_demo project in the Download Location
field as show in Figure 11.
5. Specify the header file to be used in the Tuxedo Header File Path field. The
header file contains the information about the Tuxedo fields. The fields will be
included in the schema used for publishing.
In this example, navigate to D:\workspace\Ear2Sa\Tuxedo Service
Codes\PurchaseOrder and select the PODetails.h header file as show in
Figure 11.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
34
| Chapter 4
Getting Started
Figure 11 Tuxedo BO Configuration Dialog
6. Click Next.
7. In the Tuxedo Business Object Browser dialog, select Tuxedo > TuxedoGroup
in the Applications panel and then click the Select All button. All the fields
are selected as shown in Figure 12.
Figure 12 Tuxedo BO Browser Dialog
8. Click Finish. The Tuxedo BO to be used by this example is imported.
For detailed information about importing Tuxedo Business Objects, refer to
Tuxedo Business Object.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Configuring an Adapter Service Engine Instance 35
|
Task D Create and Configure a Tuxedo Adapter Configuration
1. Click the tuxedo_demo project in the Project Explorer Panel, and then select
File > New > Adapter Resources... from the Menu. The Create New Adapters
Resource dialog appears.
2. Expand the Configurations folder and select Tuxedo Adapter. Click Next to
open the Tuxedo Adapter Configuration dialog.
3. Select tuxedo_demo as the parent folder.
4. Click Finish to close the dialog. The configuration file
TuxedoAdapterConfiguration.adtuxedomodel appears under the
tuxedo_demo project in the Project Explorer Panel.
5. Double-click TuxedoAdapterConfiguration.adtuxedomodel to open the
configuration tabs on the right Editor Panel.
6. In the Run-time Connection area, select Browse from the Connection
Configuration drop-down list to specify the Tuxedo connection as show in
Figure 13. Click OK.
Figure 13 Tuxedo Connection Configuration
For detailed information about creating a Tuxedo Adapter Configuration, refer to
Configuration.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
36
| Chapter 4
Getting Started
Task E Create and Configure a Publisher
1. Click the Adapter Services tab.
2. Click the Add Publication Service button in the All Adapter Services pane.
The parameter configuration panes appear in the tab.
3. In the Schema area, select Browse from the Request Class Reference From BO
drop-down list to specify the Tuxedo BO imported in Task C as shown in
Figure 14, and then click Apply.
Figure 14 Selecting Tuxedo BO Dialog
4. Leave the other default values unchanged.
5. Save the project.
For detailed information about configuring the Adapter Services, refer to Adapter
Services.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Working with an ActiveMatrix SOA Project 37
|
Working with an ActiveMatrix SOA Project
Before the Adapter Service Engine instance can be deployed, it must be packaged
in a service assembly.
To package an Adapter Service Engine instance in a service assembly, complete
the following tasks:
•
Task A, Create an ActiveMatrix SOA Project
•
Task B, Generate an Adapter WSDL
•
Task C, Create a JMS or HTTP Server Shared Resource
•
Task D, Configure a Composite
•
Task E, Add and Configure a JMS Composite Service
•
Task F, Create a Service Assembly and a Service Assembly Archive
Task A Create an ActiveMatrix SOA Project
1. Start TIBCO Business Studio.
2. Select File > New > Project from the Menu to open the New Project window.
3. Expand the TIBCO ActiveMatrix folder and select ActiveMatrix SOA Project
in the Select a wizard page, and then click Next.
4. Enter the project name. For example, enter tuxedo_demo_soa in the Project
name field.
5. Select Basic SOA Project from the Available Templates list.
6. Click Next and accept all default names for the selected assets.
7. Click Finish. The tuxedo_demo_soa project is created.
Refer to Creating an ActiveMatrix SOA Project for more information about how to
create an ActiveMatrix SOA project.
Task B Generate an Adapter WSDL
1. Right-click TuxedoAdapterConfiguration.adtuxedomodel under the
tuxedo_demo project in the Project Explorer Panel, and then select Generate
Adapter WSDL from the pop-up menu. The Target Project dialog appears.
2. Select tuxedo_demo_soa as the matching resource, and then click OK.
Refer to Generating an Adapter WSDL for more information about generating an
Adapter WSDL.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
38
| Chapter 4
Getting Started
Task C Create a JMS or HTTP Server Shared Resource
After creating an ActiveMatrix SOA project, a composite file for this project is
automatically generated. You need to add a service into it. In order for the
composite service to be accessible from an external client, add a TIBCO Shared
Resource.
To add a TIBCO Shared Resource, follow these steps:
1. Select the tuxedo_demo_soa project in the Project Explorer Panel, and then
select File > New > TIBCO Shared Resources... from the Menu. The TIBCO
Resource Wizard dialog appears.
2. Select a shared resource according to the composite service type, and click
Next.
— For JMS service, select JMS.
— For SOAP service, select HTTP Server.
If HTTP Server is selected as the shared resource, each SOA service must be
assigned to a separate HTTP Port.
Select JMS as the example in the following steps.
3. Select tuxedo_demo_soa as the parent folder for the newly created TIBCO
Shared Resource file and accept the default file name. The default shared
resource file name is JMS Shared Resource.
4. Click Finish to close the dialog. The shared resource file JMS Shared
Resource.sharedjmscon appears in the Project Explorer panel.
Refer to Creating a TIBCO Shared Resource for more information about how to
create a JMS or HTTP shared resource.
Task D Configure a Composite
1. Launch the Composite Editor.
a. Expand tuxedo_demo_soa > Composites in the Project Explorer panel.
b. Double-click tuxedo_demo_soa.composite under the Composites folder
to launch the Composite Editor on the right panel.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Working with an ActiveMatrix SOA Project 39
|
2. Create and configure a Tuxedo adapter component.
a. Drag the TuxedoAdapter component from the Palette to the Components
column and enter adtuxedo_Component as the component name.
b. Click the adtuxedo_Component component, the configuration parameters
are displayed under the Properties Views panel.
c. In the General tab, enter the TRA file name in the TRA file name field. For
this example, enter adtuxedo_wrkstn.tra. If the adapter works as a
Tuxedo Native client, enter adtuxedo_native.tra.
d. In the service tab, click the Add button to add the publisher endpoint to
the component as show in Figure 15.
e. Click OK and save the configuration.
Figure 15 Adding the Publisher Endpoint
3. Add the JMS Shared Resource to Composite.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
40
| Chapter 4
Getting Started
In Task C, you have created the JMS Shared Resource for your composite
service. Now you need to add the JMS shared resource to the composite.
a. Click the canvas in the Composite Editor to open the Composite
Properties Views panel under the Composite Editor.
b. Click the Shared Resource Profiles tab, add the JMS shared resource by
clicking
.
c. Select JMS in the Type drop-down list.
Figure 16 Adding the JMS Shared Resource
d. Click the Target column and click
appears.
. The Select Shared Resources dialog
e. Select the JMS shared resources in Task C.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Working with an ActiveMatrix SOA Project 41
|
Figure 17 Selecting the JMS Shared Resource
Task E Add and Configure a JMS Composite Service
1. Drag a JMS service from the Palette to the Services column and enter
tuxedo_jms as the service name.
2. Click the tuxedo_jms service, the configuration parameters are displayed
under the Properties Views panel.
— Click the Target tab and click the radio button next to the target component
service. A wire is drawn between the tuxedo_jms service and the
adtuxedo_component component.
— Click the Binding tab to add the shared resource profile to the Endpoint
pane.
3. Save the project.
Refer to Configuring Composites for more information about how to configure a
composite.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
42
| Chapter 4
Getting Started
Task F Create a Service Assembly and a Service Assembly Archive
The adapter services that have been created in the design phase have to be
packaged into a service assembly before they can be deployed.
To create a service assembly and a service assembly archive, follow these steps:
1. Select the adtuxedo_demo_soa project in the Project Explorer panel and
expand the Composites folder.
2. Right-click adtuxedo_demo_soa.composite under the Composites folder
and select Service Assembly from the pop-up menu.
3. Save the composite if prompted. adtuxedo_demo_soa.saf is created in the
Deployment Packages folder.
4. Expand the Deployment Packages folder under the adtuxedo_demo_soa
project in the Project Explorer. Right-click adtuxedo_demo_soa.saf. and select
Build Archive from the pop-up menu.
5. Save the service assembly file if prompted.
After completing the process, a ZIP file, adtuxedo_demo_soa.zip, is created in the
Deployment Packages folder. This service assembly archive can now be
deployed and started using TIBCO ActiveMatrix Administrator.
For detailed information about creating a service assembly and a service assembly
archive, refer to Creating a Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Deploying a Service Assembly Archive 43
|
Deploying a Service Assembly Archive
This section describes how to deploy the runtime adapter inTIBCO ActiveMatrix
Administrator. To do it, perform the following tasks:
Task A Configure a TIBCO Runtime Agent file
The TIBCO Runtime Agent file is a runtime configuration file with the tra suffix.
Before deploying the adapter, you need to edit the default TIBCO Runtime Agent
file.
The TIBCO Runtime Agent files are located in the
TIBCO_HOME\adapter\adtuxedo\veriosn_number\bin directory. You need to use
the adtuxedo_wrkstn.tra file if the adapter works as a Tuxedo Workstation
client and use the adtuxedo_native.tra file if the adapter works as a Tuxedo
Native client.
This example uses the adtuxedo_wrkstn.tra file. At a minimum, the following
variables must be updated:
•
tibco.env.useNewEclipseUI—
•
tibco.env.TUXConnNumber—
•
tibco.env.RVAgentThreadNumber— the number of threads to be used by the
Rendezvous agent-based publisher. The default value is 4.
•
tibco.env.WSNADDR—The IP address of the WSL (Workstation Listener) that
the client will contact, along with a port number that is already decided by the
Tuxedo server. This value must be reflected in the ubbconfig file.
set it to ON.
the number of connections with the Tuxedo
application. The default value is 10.
If the Field ID is to be loaded dynamically at runtime, set the following
environment variables:
•
FLDTBLDIR32
•
FIELDTBLS32
— contains a list of directories (separated by commas) where
field tables can be found
— contains a list of the files in the table directories (separated by
commas) that are to be used
For this example, update the variables as follows:
tibco.env.useNewEclipseUI ON
tibco.env.TUXConnNumber 4
tibco.env.RVAgentThreadNumber 4
tibco.configurl TuxedoAdapterConfiguration
tibco.env.WSNADDR //192.168.66.44:8100
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
44
| Chapter 4
Getting Started
application.args -system:propFile
%TIB_ADTUXEDO_HOME%/bin/test.tra
Refer to MultiThreading and Appendix A, Adapter Properties File for more
information.
Task B Deploy the Service Assembly Archive
When you are ready to deploy your service assembly archive, you can upload the
archive to TIBCO ActiveMatrix Administrator to deploy the associated
application.
The basic steps are listed below:
1. Start and log in to TIBCO ActiveMatrix Administrator.
2. Upload the service assembly archive. Refer to Uploading a Service Assembly
Archive
3. Configure the service unit and install the shared resource. Refer to
Configuring the Service Assembly
4. Deploy the service assembly. Refer to Deploying the Service Assembly.
5. Start the service assembly. Refer to Starting the Service Assembly.
For detailed information, refer to Deploying a Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 45
Chapter 5
Configuring an Adapter Service Engine
Instance
This chapter explains how to configure an Adapter Service Engine instance. All
configuration tasks are performed in TIBCO Business Studio.
Topics
•
Tuxedo Connection Shared Resource, page 46
•
Tuxedo Business Object, page 50
•
Tuxedo Adapter Configuration, page 55
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
46
| Chapter 5
Configuring an Adapter Service Engine Instance
Tuxedo Connection Shared Resource
For a newly created adapter project, you need to create a Tuxedo Connection and
configure it to access the Tuxedo application server.
Creating a Tuxedo Connection
To create a Tuxedo Connection, follow these steps:
1. Select a project in the Project Explorer Panel, and then select File > New >
Adapter Resources... from the Menu. The Create New Adapters Resource
dialog appears, as shown in Figure 18.
Figure 18 Creating a Tuxedo Connection
2. Expand the Shared Resources folder and select Tuxedo Connection. Click
Next to open the Tuxedo Connection Shared Resource dialog.
3. Enter or select the parent folder for the newly created connection
configuration file and enter the connection configuration file name in the File
name field. The default connection configuration file name is
Tuxedo_Connection_Configuration.
4. Click Finish to close the dialog.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Connection Shared Resource 47
|
Configuring a Tuxedo Connection
The parameters that need to be specified for a Tuxedo Connection depend on the
authorization level set on the Tuxedo server (ubbconfig file). The authorization
levels and the fields to be specified for each are as follows:
TPNOAUTH: User Name
TPSYSAUTH: User Name
and Application
Password
TPAPPAUTH: User Name, Application Password, User Password, Client
Name, Group Name
client)
(should be null if the adapter is to be used as a workstation
and Initialization flags.
The adtuxedo.authinfo property in the adapter properties file indicates the
authorization level set on the Tuxedo server.
There are three possible values:
No authorization check. This is the default value.
TPNOAUTH:
TPSYSAUTH:
System authorization.
TPAPPAUTH:
Application authorization.
If the parameter is not specified, the adapter will attempt to connect to each of
these levels sequentially.
To configure a Tuxedo Connection, follow these steps:
1. Double-click the connection configuration file under the adapter project folder
in the Project Explorer Panel. The Tuxedo Connection Shared Resource Editor
panel appears on the right, as shown in Figure 19.
Figure 19 Tuxedo Connection Shared Resource Editor
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
48
| Chapter 5
Configuring an Adapter Service Engine Instance
2. Specify the value for each parameter listed in Table 5
Table 5 Tuxedo Connection Configuration Parameters
Field
Description
User Name
The name of a valid client user to log into the Tuxedo application. The user name should
less than 30 characters.
User Password
The password associated with the Tuxedo user specified in the User Name field. This field
cannot be edited. If a value has to be specified, use the substitution variables. This is the
variable length data that is forwarded to the application defined authentication service.
You can toggle between substitution variables and plain text values. This value is visible in
non-readable form in the project. Plain text values are stored in the project in encrypted
form.
Group Name
When the adapter is used as a workstation client, the value in this field should be set to
null, which is the default. When the adapter is used as a native client, specify a valid
Tuxedo group name in this field.
Application
Password
The password associated with a particular application domain. All users in a domain will
use this password to access the application, depending on the level of authorization set on
Tuxedo. The password should be less than 30 characters. This field cannot be edited. If a
value has to be specified, use substitution variables.
You can toggle between substitution variables and plain text values. This value is visible in
non-readable form in the project. Plain text values are stored in the project in encrypted
form.
Initialization
Flags
The flags that indicate the client-specific notification mechanism and mode of system
access. See Initialization Flags Values for more information.
The parameters can use Substitution Variables. Binding Editor allows you to set
values on fields from Substitution Variables. Open the binding editor by clicking
. Refer to Using Substitution Variables for more information about how to
use Substitution Variables.
Initialization Flags Values
The valid values in the Initialization Flags field are given in Table 6. These values
are used while initiating connections to Tuxedo. The values are set in the TPINIT
structure. Refer to the Oracle Tuxedo documentation for more information.
Table 6 Initialization Flags Values
Flag
Value
TPU_SIG
1
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Connection Shared Resource 49
|
Table 6 Initialization Flags Values
Flag
Value
TPU_DIP (default)
2
TPU_IGN
4
TPSA_FASTPATH
8
TPSA_PROTECTED
10
TPMULTICONTEXTS
20
TPU_THREAD
40
TPU_MASK
47
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
50
| Chapter 5
Configuring an Adapter Service Engine Instance
Tuxedo Business Object
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo introduces the concept
of a Business Object (BO). In the simplest sense, a BO is the representation of the
data model for the business entities such as invoice, orders, customers, or
vendors.
The BO also encapsulates the data, its attributes, types, and functions as well as
the operations and relationships between other BOs. The schema that is
downloaded can be used by adapter services in an adapter project.
Importing Business Objects
To import Tuxedo BOs, follow these steps:
1. Select an adapter project in the Project Explorer Panel, and then select File >
Import from the Menu. The Import dialog appears, as shown in Figure 20.
Figure 20 Import a Tuxedo Business Object
2. Expand the TIBCO ActiveMatrix Adapters folder and select Metadata >
Tuxedo Objects.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Business Object 51
|
3. Click Next. The Tuxedo Business Objects Configuration dialog, as shown in
Figure 21.
Figure 21 Tuxedo BOs Configuration Dialog
4. Specify the value of each parameter in the dialog, and then click Next.
— Name: Enter a name to be saved for the schema.
— Download Location: Click the Browse button to select a location to save
the schema.
— Tuxedo Header File Path: Browse and select the header file containing
information about the fields to be included in the request or reply
AESchema.
5. Select the Tuxedo BOs to be retrieved from the Tuxedo server, as shown in
Figure 22.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
52
| Chapter 5
Configuring an Adapter Service Engine Instance
Figure 22 Tuxedo Business Objects Browser
6. Configure the schema for the fields that occur multiple times. The schema is
used to differ for each adapter service and is also dependent on the Tuxedo
communication paradigm(s) that are used.
— Name This column lists the names of the field or record. The values in this
column come from the header file selected in step 4.
— Sequence Name Enter the sequence name. This name groups fields that
occur the same number of times. The sequence names can use ASCII
alphanumeric characters. Additionally, the _, , %, @, ‘ ‘, |, /, ~, {’, ‘}, #,
-, $ non-alphanumeric characters are the acceptable.
7. Click Finish. After successfully importing Tuxedo BOs, a business object file
(.bo) will be automatically generated in the adapter project.
8. Double-click the business object file under the adapter project folder in the
Project Explorer Panel to view the imported Tuxedo BOs. The Tuxedo Adapter
Business Object Editor panel appears on the right, as shown in Figure 23.
The Tuxedo BO attribute properties are read only.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Business Object 53
|
Figure 23 Tuxedo Adapter Business Object Editor
Converting Tuxedo BOs to AESchemas
If the FML32 buffer type is used, you must specify the request class reference from
the imported BOs for a publisher or specify the request and reply class references
from the imported BOs for a subscriber, RPC server, or RPC client.
To do this, follow these steps:
1. In the Schema area of an adapter service, Click Browse in the drop-down list as
shown in Figure 24. The Select Child dialog appears as shown in Figure 25.
Figure 24 The Schema Area
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
54
| Chapter 5
Configuring an Adapter Service Engine Instance
Figure 25 Select Child Dialog
2. Select a business object from any of the previously imported BOs in the Select
Child dialog.
If you select an imported Tuxedo BO configured with sequence, you must select
the first BO in the Available Nodes pane as shown in Figure 25.
3. After specifying the request and reply class references, click Apply and then
the AESchema is created based on the FML32 header files selected when
importing Tuxedo BOs and is used for the adapter services.
The AESchema fields are created with names suffixed _field ID. Irrespective
of the type of the FML32 fields, the schema is always the string type.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 55
|
Tuxedo Adapter Configuration
To create and configure a Tuxedo Adapter configuration, follow these steps:
1. Click an adapter project in the Project Explorer Panel, and then select File >
New > Adapter Resources... from the Menu.
2. Expand the Configurations folder and select Tuxedo Adapter.
3. Click Next. The Tuxedo Adapter Configuration dialog appears
4. Enter or select the parent folder for the configuration file and enter the
configuration file name in the File name field. The default configuration file
name is TuxedoAdapterConfiguration.adtuxedomodel.
5. Click Finish.
6. Double-click the configuration file under the adapter project folder in the
Project Explorer Panel. The Editor Panel appears on the right with the
configuration tabs.
7. Specify the value for each parameter in the following configuration tabs:
— Configuration
— Adapter Services
— Log Sinks
— Timers
8. Specify the multithreading properties in the TIBCO Runtime Agent file. Refer
to MultiThreading for detail.
Configuration
The Configuration tab provides options to modify basic configuration
information. Many of the following parameters can use Substitution Variables.
Binding Editor allows you to set values on fields from Substitution Variables.
Open the binding editor by clicking
. Refer to Using Substitution Variables
for more information about how to use Substitution Variables.
The configuration parameters are listed in Table 7.
Table 7 Adapter Instance Configuration Parameters
Field
Description
Tuxedo Adapter Configuration
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
56
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 7 Adapter Instance Configuration Parameters
Field
Description
Instance Name
The name of the Adapter Service Engine instance.
Use the default name or replace it with a name of your choice.
See Guidelines for Choosing an Instance Name for more information.
Description
(Optional) A short description of the adapter configuration.
Startup
Show Startup
Banner
The startup banner displays the runtime adapter version, the infrastructure version on
which the adapter is built, and copyright information in the console window when the
adapter is started. Check this checkbox to display the startup banner.
Run-time Connection
Retry Interval
Specify the time interval (in milliseconds) to elapse between each reconnection attempt.
This field can be set as a substitution variable.
Retry Attempts
The total number of reconnection attempts to make after the service has been suspended.
When this number is reached, the runtime adapter or adapter service will be stopped. This
field can be set as a substitution variable.
A value of -1 means reconnection attempts will continue indefinitely.
Reconnect
Attempts
Specify the number of reconnection attempts to make before suspending the service. This
field can be set as a substitution variable.
Note that reconnection with the application does not depend on this parameter.
Reconnection depends on the value specified in the Retry Attempts field.
Choose Tuxedo
Client Type
Installed
Select adtuxedo_wrkstn if the adapter works as a Tuxedo Workstation client. Select
adtuxedo_native if the adapter works as a Tuxedo Native client.
Connection
Configuration
Associate the adapter instance with a predefined connection configuration. See
Tuxedo Connection Shared Resource for how to define a connection configuration. The
options for a connection configuration are listed in Table 5
Agent Subject
Publisher RV
Agent Subject
This field appears if Rendezvous is selected in the Agent Transport Type drop-down list in
the area for a publisher. The subject name is used to publish and subscribe messages
between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 57
|
Table 7 Adapter Instance Configuration Parameters
Field
Description
Publisher
JMSQueue
Agent Subject
This field appears if JMS QUEUE is selected in the Agent Transport Type drop-down list
in the area for a publisher. The subject name is used to publish and subscribe messages
between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
Publisher
JMSTopic Agent
Subject
This field appears if JMS TOPIC is selected in the Agent Transport Type drop-down list in
the area for a publisher. The subject name is the JMS topic used to publish and subscribe
messages between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
Publisher
RVCMQ Agent
Subject
This field appears if Distributed Queue is selected in the Agent Transport Type
drop-down list in the area for a publisher. The subject name is used to publish and
subscribe messages between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
RPCC RV Agent
Subject
This field appears if Rendezvous is selected in the Agent Transport Type drop-down list in
the area for a RPC client. The subject name is used to publish and subscribe messages
between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
RPCC RVCMQ
Agent Subject
This field appears if Distributed Queue is selected in the Agent Transport Type
drop-down list in the area for a RPC client. The subject name is used to publish and
subscribe messages between the Tuxedo server and the adapter.
This field can be set as a substitution variable.
Monitoring
(TIBCO HAWK functionality is not supported in this release.)
Enable Standard
Microagent
Allows you to turn on or off the standard TIBCO Hawk Microagent. Clicking the globe
icon changes the checkbox to a text field, allowing you to specify a global variable. When
this is a text field, turn the microagent on and off by entering true or false.
This field can be set as a substitution variable.
Standard
Microagent
Name
This is the name for the standard microagent that will be registered with the TIBCO Hawk
system. In most cases the default value is used,
COM.TIBCO.ADAPTER.adtuxedo.%%Deployment%%.
TuxedoAdapterConfiguration
This field can be set as a substitution variable.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
58
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 7 Adapter Instance Configuration Parameters
Field
Description
Standard
Microagent
Timeout(ms)
Specifies the amount of time the Hawk Agent should wait for the HMA method
invocations to complete before timing them out. The default is 10000 milliseconds.
Normally there is no need to change this value, however, on machines under extreme
stress where method invocations are timing out, this new option allows the timeout value
to be increased.
This field can be set as a substitution variable.
Enable Class
Microagent
Allows you to turn on or off the instance-specific or class-specific standard TIBCO Hawk
Microagent. You can configure how the class microagent is turned on and off in this field.
This field can be set as a substitution variable.
Class
Microagent
Name
This is the name for the class microagent that will be registered with the TIBCO Hawk
system. In most cases the default value is used,
COM.TIBCO.adtuxedo.%%Deployment%%.TuxedoAdapterConfiguration
This field can be set as a substitution variable.
Class
Microagent
Timeout(ms)
Specifies the amount of time the Hawk Agent should wait for HMA method invocations to
complete before timing them out. The default is 10000 milliseconds. Normally there is no
need to change this value, however, on machines under extreme stress where method
invocations are timing out, this new option allows the timeout value to be increased.
This field can be set as a substitution variable.
Default
Microagent
Session
This is the name of the TIBCO Rendezvous session that is predefined and cannot be
changed. The session is automatically generated by TIBCO Business Studio and will be
used by the standard, class, and custom microagents.
General
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 59
|
Table 7 Adapter Instance Configuration Parameters
Field
Description
Adapter
Encoding
Select the encoding from the drop-down list. The default encoding is ASCII. If you do not
set a value in this field, the default value (ASCII) is used.
Here are the encodings available in the drop-down list:
•
ASCII 7-bit ASCII
•
UTF8 Unicode Transformation Format-8
•
Shift_JIS (CP943) Japanese Shift-JIS, CP943
•
Shift_JIS (TIBCO) Variant of IBM-943, flavoring some MS-932 conversions
•
Big5 Traditional Chinese Big5 (with Euro Sign)
•
ISO8859-1
The Adapter Encoding field is editable. See TIBCO ActiveMatrix Adapter for Tuxedo
Concepts for a list of additional encodings that can be typed into this field.
The palette does not validate encoding values that you type into the field. The runtime
adapter will throw an error if the encoding value you type is not supported.
Adapter Services
All Publication Services
Polling Interval
(milliseconds)
This parameter determines how often the adapter publisher polls the Tuxedo EventBroker.
The default value is 3000 milliseconds.
All Request-Response Services
Polling Interval
for Replies
(milliseconds)
This parameter determines how often the RPC server polls for a reply from Tuxedo in an
asynchronous mode. The default value is 1000 milliseconds. This field can be set as a
substitution variable or it can be set in the TRA properties file.
Polling Interval
for Outstanding
Invocations
(milliseconds)
This parameter determines how often the RPC server polls Tuxedo in an asynchronous
mode for the outstanding invocations. The default setting is 2000 milliseconds.
Maximum
Number of
Pending
Invocations
Specify the maximum number of pending invocations. Once maximum number of pending
invocations is reached, the value specified in the polling interval for outstanding
invocations field is used to poll for replies. The default setting is 50. Tuxedo allows a
maximum of 50 pending invocations and any subsequent additional invocation will yield
a TPELIMIT error. This field can be set as a substitution variable or it can be set in the TRA
properties file.
Example: If you have not changed default settings, the RPC server in asynchronous mode
polls for replies every 1000 milliseconds till the maximum number of pending invocations
configured is reached after which polling is done every 2000 milliseconds. This field can be
set as a substitution variable or it can be set in the TRA properties file.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
60
| Chapter 5
Configuring an Adapter Service Engine Instance
Guidelines for Choosing an Instance Name
Use the default name or replace it with a name of your choice.
•
An instance name must use alphanumeric characters. An underscore (_)
character can be used. The entire instance name must be less than 80
characters. The space character cannot be used in an instance name.
•
An instance name cannot use global variables.
•
An instance name must be unique with respect to other adapter instances for
the same adapter in the project.
•
Each instance name must be unique per adapter within a project even if each
instance is defined in a different folder. That is, configuring same-named
adapter instances in different folders will not make their names unique.
When you create an adapter instance, the palette automatically creates several
resources for it. The names of these resources derive from the name of the instance
they belong to. Changing the adapter instance name results in an automatic
regeneration of the resources names. If you manually modify any resource name,
that particular name will not be automatically regenerated the next time you
rename the adapter instance.
Adapter Services
The Adapter Service tab provides options for adding and configuring the
following adapter services:
•
Publisher
•
Subscriber
•
RPC Server
•
RPC Client
To add a service, follow these steps:
1. Click the Add Service Name button to add a desired service into the All
Adapter Services pane. The parameter configuration panes appear in the tab.
2. Specify the value of each parameter for the added service.
For more information on each service, refer to TIBCO ActiveMatrix Adapter for
Tuxedo Concepts.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 61
|
Publisher
The configuration parameters for a publisher are listed in Table 8.
Table 8 Publisher Configuration parameters
Field
Description
Configuration
Name
You can use the default name or replace it with a name of your choice.
A service name must use alphanumeric characters. An underscore (_) character can be
used. The entire instance name must be less than 80 characters. The space character cannot
be used in an instance name.
Description
(Optional) Provide information about the publisher.
Schema
Request Class
Reference From
BO
Convert Request Tuxedo Business Objects into AESchemas. Click Browse in the
drop-down list to select a business object from any of the previously imported BOs. Click
Apply after selecting the BO.
Refer to Tuxedo Business Object for details.
Class Reference
For the FML32 buffer type, the AESchema is generated from the selected Tuxedo Business
Object. For the String and CArray buffer type, the AESchema is generated automatically.
Publisher Option
Buffer Type
Three options are available:
•
FML32
If the buffer type is FML32, you need to import Tuxedo BOs and convert the
BOs into AESchemas in the Schema area. The BOs to be used are created based
on Tuxedo header files.
•
String
A class by name service name
would be created under
name/service name. The class has an
attribute in of String data type. Refer to Appendix B, Message Formats for
more information.
Request
Schemas/classes/Tuxedo/adapter instance
•
CArray
A class by name service name
binary data type.
Request would
be created with an attribute in of
Note that the automatically created classes for CArray and String buffer types should not
be manually edited.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
62
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 8 Publisher Configuration parameters
Field
Description
Agent Transport
Type
Choose one of the following:
•
Rendezvous
Rendezvous indicates that TIBCO Rendezvous will be used to transport
messages.
•
JMS QUEUE
JMS QUEUE indicates that the Point-to-point (queues) messaging model of
JMS will be used.
•
JMS TOPIC
JMS TOPIC indicates that the Publish and subscribe (topics) messaging model
of JMS will be used.
•
Distributed Queue
Distributed Queue indicates that load balancing will be used for Rendezvous
Adapter Agent-based publisher. Multiple publishers will run in the RVCMQ
mode to process messages passed by the Rendezvous Adapter Agent.
See TIBCO Rendezvous Concepts for details about RVCMQ.
Load Field Id
Dynamically
This checkbox appears only if you select FML32 in the Buffer Type drop-down list. It
specifies whether the Field IDs for the FML32 fields should be loaded dynamically at
runtime. If unchecked, the Field ID values loaded from the header files are used.
Event Name
This field appears only if you select FML32 in the Buffer Type drop-down list. It is
the target name of the Tuxedo event for which the adapter is listening, in order to trigger a
publish.
This field is mandatory for the Event-based publisher. It is not required for Rendezvous
Adapter Agent-based publisher or JMS Adapter Agent-based publisher.
Event-broker publisher only supports the FML32 buffer type. The Adapter Agent supports
all buffer types (FML32, String, CArray).
For an Event-based publisher, the EVENT_NAME field is a reserved FML32 field for the
name of the event that is being posted on the Event Broker, set by the Tuxedo service or
client.
Queue Space
It is the name of a queue space. The Oracle Tuxedo administrator creates the queue space,
which contains a collection of queues. Each queue space is a resource manager(RM)
instance.
Queue Name
It is the name of a queue. The queue name is a NULL-terminated string of up to 15
characters.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 63
|
Subscriber
The configuration parameters for a subscriber are listed in Table 9.
Table 9 Subscriber Configuration Parameters
Field
Description
Configuration
Name
You can use the default name or replace it with a name of your choice.
A service name must use alphanumeric characters. An underscore (_) character can be
used. The entire instance name must be less than 80 characters. The space character cannot
be used in an instance name.
Description
(Optional) Provide information about the subscriber.
Schema
Request Class
Reference From
BO
Convert Request Tuxedo Business Objects into AESchemas. Click Browse in the
drop-down list to select a business object from any of the previously imported BOs. Click
Apply after selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Reply Class
Reference From
BO
Convert Reply Tuxedo Business Objects into AESchemas. Click Browse in the drop-down
list to select a business object from any of the previously imported BOs. Click Apply after
selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Class Reference
For the FML32 buffer type, the AESchema is generated from the selected Tuxedo Business
Object. For the String and CArray buffer type, the AESchema is generated automatically.
Subscriber Option
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
64
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 9 Subscriber Configuration Parameters
Field
Description
Buffer Type
Three options are available:
•
FML32
If the buffer type is FML32, you need to import Tuxedo BOs and convert the
BOs into AESchemas in the Schema area. The BOs to be used are created based
on Tuxedo header files.
•
String
A class named service name
Request
is created under
name/service name. The class has a
data type attribute named in. Refer to Appendix B, Message Formats
for more information.
Schemas/classes/Tuxedo/adapter instance
String
a class named service name
Tuxedo/adapter
Reply
is created under Schemas/classes/
instance name/service name. The class has a String data type
attribute named out, which is provided by the subscriber, RPC server, or RPC
client.
•
CArray
A class named service name Request is created with a binary data type
attribute named in. This attribute has an extended property named length.
Refer to Appendix B, Message Formats for more information.
A class named service name Reply is created with a binary data type attribute
named out, which is provided by the subscriber, RPC server, and RPC client
(in addition to the default field ErrorCode which appears for the subscriber
and RPC server). This attribute has an extended property named length
Note that the automatically created classes for CArray and String buffer types should not
be manually edited.
Load Field Id
Dynamically
This checkbox appears only if you select FML32 in the Buffer Type drop-down list. It
specifies whether the Field IDs for the FML32 fields should be loaded dynamically at
runtime. If unchecked, the Field ID values loaded from the header files are used.
CArray Request
Length
This field appears only if you select CArray in the Buffer Type drop-down list. It is the
length of the request CArray buffer type.
CArray Reply
Length
This field appears only if you select CArray in the Buffer Type drop-down list. It is the
length of the reply CArray buffer type.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 65
|
RPC Server
The configuration parameters for a RPC server are listed in Table 10.
Table 10 RPC Server Configuration Parameters
Field
Description
Configuration
Name
You can use the default name or replace it with a name of your choice.
A service name must use alphanumeric characters. An underscore (_) character can be
used. The entire instance name must be less than 80 characters. The space character cannot
be used in an instance name.
Description
(Optional) Provide information about the RPC server.
Schema
Request Class
Reference From
BO
Convert Request Tuxedo Business Objects into AESchemas. Click Browse in the
drop-down list to select a business object from any of the previously imported BOs. Click
Apply after selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Reply Class
Reference From
BO
Convert Reply Tuxedo Business Objects into AESchemas. Click Browse in the drop-down
list to select a business object from any of the previously imported BOs. Click Apply after
selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Class Reference
For the FML32 buffer type, the AESchema is generated from the selected Tuxedo Business
Object. For the String and CArray buffer type, the AESchema is generated automatically.
RPC Server Option
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
66
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 10 RPC Server Configuration Parameters
Field
Description
Buffer Type
Three options are available:
•
FML32
If the buffer type is FML32, you need to import Tuxedo BOs and convert the
BOs into AESchemas in the Schema area. The BOs to be used are created based
on Tuxedo header files.
•
String
A class named service name
Request
is created under
name/service name. The class has a
data type attribute named in. Refer to Appendix B, Message Formats
for more information.
Schemas/classes/Tuxedo/adapter instance
String
a class named service name
Tuxedo/adapter
Reply
is created under Schemas/classes/
instance name/service name. The class has a String data type
attribute named out, which is provided by the subscriber, RPC server, or RPC
client.
•
CArray
A class named service name Request is created with a binary data type
attribute named in. This attribute has an extended property named length.
Refer to Appendix B, Message Formats for more information.
A class named service name Reply is created with a binary data type attribute
named out, which is provided by the subscriber, RPC server, and RPC client
(in addition to the default field ErrorCode which appears for the subscriber
and RPC server). This attribute has an extended property named length
Note that the automatically created classes for CArray and String buffer types should not
be manually edited.
Use
Asynchronous
Invocation
Check this checkbox to use the asynchronous communication paradigm. The adapter
accesses the Tuxedo service asynchronously when this checkbox is checked.
Note that when using the asynchronous communication paradigm with the RPC
server, the adapter does not support multithreading.
Load Field Id
Dynamically
This checkbox appears only if you select FML32 in the Buffer Type drop-down list. It
specifies whether the Field IDs for the FML32 fields should be loaded dynamically at
runtime. If unchecked, the Field ID values loaded from the header files are used.
CArray Request
Length
This field appears only if you select CArray in the Buffer Type drop-down list. It is the
length of the request CArray buffer type.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 67
|
Table 10 RPC Server Configuration Parameters
Field
Description
CArray Reply
Length
This field appears only if you select CArray in the Buffer Type drop-down list. It is the
length of the reply CArray buffer type.
RPC Client
The configuration parameters for a RPC client are listed in Table 11.
Table 11 RPC Client Configuration Parameters
Field
Description
Configuration
Name
You can use the default name or replace it with a name of your choice.
A service name must use alphanumeric characters. An underscore (_) character can be
used. The entire instance name must be less than 80 characters. The space character cannot
be used in an instance name.
Description
(Optional) Provide information about the RPC client.
Schema
Request Class
Reference From
BO
Convert Request Tuxedo Business Objects into AESchemas. Click Browse in the
drop-down list to select a business object from any of the previously imported BOs. Click
Apply after selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Reply Class
Reference From
BO
Convert Reply Tuxedo Business Objects into AESchemas. Click Browse in the drop-down
list to select a business object from any of the previously imported BOs. Click Apply after
selecting both the request and reply BOs.
Refer to Tuxedo Business Object for details.
Class Reference
For the FML32 buffer type, the AESchema is generated from the selected Tuxedo Business
Object. For the String and CArray buffer type, the AESchema is generated automatically.
RPC Client Option
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
68
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 11 RPC Client Configuration Parameters
Field
Description
Buffer Type
Three options are available:
•
FML32
If the buffer type is FML32, you need to import Tuxedo BOs and convert the
BOs into AESchemas in the Schema area. The BOs to be used are created based
on Tuxedo header files.
•
String
A class named service name
Request
is created under
name/service name. The class has a
data type attribute named in. Refer to Appendix B, Message Formats
for more information.
Schemas/classes/Tuxedo/adapter instance
String
a class named service name
Tuxedo/adapter
Reply
is created under Schemas/classes/
instance name/service name. The class has a String data type
attribute named out, which is provided by the subscriber, RPC server, or RPC
client.
•
CArray
A class named service name Request is created with a binary data type
attribute named in. This attribute has an extended property named length.
Refer to Appendix B, Message Formats for more information.
A class named service name Reply is created with a binary data type attribute
named out, which is provided by the subscriber, RPC server, and RPC client
(in addition to the default field ErrorCode which appears for the subscriber
and RPC server). This attribute has an extended property named length
Note that the automatically created classes for CArray and String buffer types should not
be manually edited.
Agent Transport
Type
Choose one of the following:
•
Rendezvous
Rendezvous indicates that TIBCO Rendezvous will be used to transport
messages.
•
Distributed Queue
Distributed Queue indicates that load balancing will be used for Rendezvous
Adapter Agent-based publisher. Multiple publishers will run in the RVCMQ
mode to process messages passed by the Rendezvous Adapter Agent.
See TIBCO Rendezvous Concepts for details about RVCMQ.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 69
|
Table 11 RPC Client Configuration Parameters
Field
Description
Load Field Id
Dynamically
This checkbox appears only if you select FML32 in the Buffer Type drop-down list. It
specifies whether the Field IDs for the FML32 fields should be loaded dynamically at
runtime. If unchecked, the Field ID values loaded from the header files are used.
Log Sinks
The Log Sinks tab specify the output destination (sinks) for the trace messages
and set the tracing level for the roles selected.
The following operations are introduced in this section:
•
Adding a Sink
•
Removing a Sink
•
Adding Roles to a Sink
•
Removing Roles from a Sink
Adding a Sink
To add a sink, follow these steps:
1. Click the Add Sink Type button to add a desired sink into the All Log Sinks
pane. The parameter configuration panes appear in the tab.
2. Specify the value of each parameter for the added sink, as shown in Table 12.
Table 12 Log Sink Configuration Parameters
Field
Description
General Options
Trace messages from the selected level(s) will be collected in the configured log sinks. You can
configure what levels of trace messages you want logged.
Log Info
Messages
Check this checkbox to log Informational messages.
Log Debug
Messages
Check this checkbox to log Debug messages.
This trace level is reserved and should not be enabled unless requested by the TIBCO
Support. This trace level writes a lot of information to the log file and significantly reduces
the speed of the Adapter Service Engine.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
70
| Chapter 5
Configuring an Adapter Service Engine Instance
Table 12 Log Sink Configuration Parameters
Field
Description
Log Warning
Messages
Check this checkbox to log Warning messages.
Log Error
Messages
Check this checkbox to log Error messages.
File Sink
Name
The name and description for the File sink.
Description
File Name
The path and name of the trace file.
File Limit (bytes)
Maximum size of the file, in bytes. The default value is 30000.
File Count
The number of rollover files. The default value is 3.
Append Mode
If checked, traces are added to the existing file at startup. If unchecked, the existing file is
overwritten at startup if one of the same name exists. Only true and false are legal values.
STDIO Sink
Name
The name and description for the STDIO sink.
Description
Output Stream
Choose between out and error.
Hawk Sink
The Hawk sink uses the Hawk session, created and used by the Adapter Service Engine for
monitoring purposes, to send tracing messages to the TIBCO Hawk monitor or Display.
(TIBCO HAWK functionality is not supported in the current release.)
Name
The name and description for the Hawk sink.
Description
Microagent
Name
The name of the microagent for traces from this Hawk sink.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 71
|
Table 12 Log Sink Configuration Parameters
Field
Description
Network Sink
The Network sink is used to publish tracing message.
Name
The name and description for the Network sink.
Description
Subject
Subject of TIBCO Rendezvous messages to be sent.
Session
Reference
Click Browse from the drop-down list to select one of the previously defined sessions.
Removing a Sink
To remove a log sink, follow these steps:
1. Select the log sink you want to remove in the All Log Sinks pane.
2. Click the Remove Sink button to remove the sink.
Adding Roles to a Sink
To add roles to a sink, follow these steps:
1. Select the log sink you want to add roles into in the All Log Sinks pane.
2. Click the Add Log Sink Role button to add additional roles. You can add
debug, error, warning, or informational roles to sinks by selecting the
corresponding roles from the Role drop-down list.
Removing Roles from a Sink
To remove roles from a sink, follow these steps:
1. Select the role you want to remove from a sink in the All Log Sinks pane.
2. Click the Remove Log Sink Role button to remove the role.
Timers
TIBCO Business Studio allows you to add a timer to your adapter configuration.
The timer can be used to the adapter program.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
72
| Chapter 5
Configuring an Adapter Service Engine Instance
Adding and Removing a Timer
To add a timer, follow these steps:
1. Click the Timers tab.
2. Click the Add button to add a new timer.
3. Specify the following parameters for a timer.
Table 13 Timer Configuration Parameters
Field
Description
Name
Name of this timer.
Start Active
If checked, this timer is active.
Interval
(milliseconds)
Trigger interval in milliseconds (for repeating timers). The default value is 3000
milliseconds.
Repeating
If checked, this is a repeating timer. If not checked, this is a once-only timer.
Session
Reference
Click the Browse icon to associate a session with this timer.
To remove a timer, click the Remove button.
PubPollingTimer Timer
After adding a publisher to a Tuxedo adapter configuration, a PubPollingTimer
timer is created automatically. The PubPollingTimer timer is used to check the
connection between the adapter and Tuxedo server. You can specify the trigger
interval in the Interval field. The adapter checks the connection to the Tuxedo server
with a fixed time specified in the Interval field.
Q_Queue_Space_Queue_name_Timer Timer
If a Queue-based publisher is used, a Q_Queue_Space_Queue_name_Timer timer is
created automatically. The adapter retrieves the messages from the Tuxedo queue
with a fixed time specified in the Interval field.
For the PubPollingTimer and Q_Queue_Space_Queue_name_Timer timers,
DefaultRVSession is used. Do not change the session.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Tuxedo Adapter Configuration 73
|
MultiThreading
Multithreading allows the adapter to process multiple messages concurrently to
ensure better performance. TIBCO ActiveMatrix Adapter Service Engine for
Tuxedo supports multithreading for the publisher, subscriber, RPC client, and
synchronous RPC server. Multithreading is not supported for the asynchronous
RPC server.
The number of threads for a publisher or RPC client can be configured in the
adapter TIBCO Runtime Agent file. The TIBCO Runtime Agent files are installed
with TIBCO ActiveMatrix Adapter for Tuxedo and located in the
TIBCO_HOME\adapter\adtuxedo\veriosn_number\bin directory.
Before deploying the adapter in the TIBCO ActiveMatrix environment, you must
configure the multithreading properties listed in Table 14. For high volume
messaging environments, you can improve the performance by spawning the
threads for individual services.
Table 14 Predefined Properties for Multithreading
Property
Description
tibco.env.RVAgentTh
readNumber
The number of threads to be used for a Rendezvous agent-based, queued-based,
or event-based publisher or a Rendezvous agent-based RPC client. The value
must be larger than 0.
tibco.env.RVCMQAgen
tThreadNumber
The number of threads to be used for a distributed queue agent-based publisher
or RPC client. The value must be larger than 0.
tibco.env.JMSQueueA
gentThreadNumber
The number of threads to be used for a JMS queue agent-based publisher. The
value must be larger than 0.
tibco.env.JMSTopicA
gentThreadNumber
The number of threads to be used for a JMS topic agent-based publisher. The
value must be larger than 0.
The number of threads being used for a subscriber or RPC server cannot be
configured
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
74
| Chapter 5
Configuring an Adapter Service Engine Instance
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 75
Chapter 6
Working with ActiveMatrix SOA Projects
This chapter describes the process of working with ActiveMatrix SOA projects.
Topics
•
Creating an ActiveMatrix SOA Project, page 76
•
Generating an Adapter WSDL, page 79
•
Configuring Composites, page 86
•
Creating a Service Assembly and a Service Assembly Archive, page 91
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
76
| Chapter 6
Working with ActiveMatrix SOA Projects
Creating an ActiveMatrix SOA Project
ActiveMatrix SOA projects contain assets that you can develop with TIBCO
Business Studio. Before creating any type of asset you must first create an
ActiveMatrix SOA project using TIBCO Business Studio.
To create an ActiveMatrix SOA project, follow these steps:
1. Start TIBCO Business Studio.
2. Select File > New > Project from the Menu to open the New Project window.
3. Select TIBCO ActiveMatrix > ActiveMatrix SOA Project in the Select a
wizard page, as shown in Figure 26, and then click Next.
Figure 26 Create an ActiveMatrix SOA project - Select a Wizard
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating an ActiveMatrix SOA Project 77
|
4. Do the following operations in the New SOA Project page, as shown in
Figure 27, and then click Next.
— Type the SOA project name (For example, tuxedo_demo_soa) in the Project
name field.
— Check the Use default location checkbox if you want to save the SOA
project into your default workspace.
— Select Basic SOA Project from the Available Templates list. The Basic SOA
Project template creates a project with an empty composite.
Figure 27 Create an ActiveMatrix SOA Project - New SOA Project
5. Select the asset types to configure for the project in the Asset Type Select page,
as shown in Figure 28.
Do not check the Adapters checkbox in the Asset Type Select page.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
78
| Chapter 6
Working with ActiveMatrix SOA Projects
Figure 28 Create an ActiveMatrix SOA Project - Asset Type Selection
6. Specify the names for the selected assets.
— Click Next to enter the desired name for each asset in the corresponding
Folder field.
— Click Finish to accept all default names for the selected assets.
The newly created ActiveMatrix SOA project is shown in the Project Explorer
panel.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Generating an Adapter WSDL 79
|
Generating an Adapter WSDL
TIBCO ActiveMatrix services are described using WSDL files.
To generate the WSDL file, follow these steps:
1. Right-click the Tuxedo Adapter Configuration file (.adtuxedomodel) for the
Adapter project you want to deploy in the Project Explorer panel and select
Generate Adapter WSDL from the pop-up menu. The Target Project dialog
appears, as shown in Figure 29.
Figure 29 Target Project Dialog
2. Select the ActiveMatrix SOA project you want to use, and then click OK.
After the generating process is completed, the following two folders are created
automatically, as shown in Figure 30.
•
schema:
this folder contains the adapter XSD schema.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
80
| Chapter 6
Working with ActiveMatrix SOA Projects
•
TuxedoAdapterConfigurationFilename_genresources: this folder contains the
following supporting resources:
— TuxedoAdapterConfigurationFilename_number.dat: contains information used by
the Adapter container.
— TuxedoAdapterConfigurationFilename.adendpoints: the adapter service
endpoints file which contains information about the service endpoints
supported by the adapter. The file is used later to select service types.
— TuxedoAdapterConfigurationFilename.substvar: contains substitution variables
that are imported from the adapter configuration file.
— TuxedoAdapterConfigurationFilename.wsdl: the generated WSDL file which
references the schema and .dat files contains the service definition
endpoints.
Figure 30 Generated Adapter WSDL
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a TIBCO Shared Resource 81
|
Creating a TIBCO Shared Resource
After creating an ActiveMatrix SOA project, a composite file for this project is
automatically generated. For detailed information about configuring the
composite, refer to Configuring Composites.
Composites must have a service added to them. For detailed information about
how to add a composite service, refer to Create a Composite Service. In order for
the composite service to be accessible from the external client, you need to add a
TIBCO Shared Resource.
To add a TIBCO Shared Resource, follow these steps:
1. Select your ActiveMatrix SOA project in the Project Explorer Panel, and then
select File > New > TIBCO Shared Resources... from the Menu. The TIBCO
Resource Wizard dialog appears, as shown in Figure 31.
Figure 31 TIBCO Resource Wizard - Select a Wizard
2. Select a shared resource according to the composite service type, and click
Next.
— For JMS service, select JMS.
— For SOAP service, select HTTP Server.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
82
| Chapter 6
Working with ActiveMatrix SOA Projects
3. Enter or select the parent folder for the newly created TIBCO Shared Resource
file and enter the name for the shared resource file in the File name field. The
default shared resource file name is HTTP Server Shared Resource or JMS
Shared Resource.
4. Click Finish to close the dialog. The newly created TIBCO Shared Resource is
displayed in the Project Explorer panel.
Configuring a TIBCO Shared Resource
To configure a TIBCO Shared Resource, follow these steps:
1. Double-click the shared resource file under the ActiveMatrix SOA project
folder in the Project Explorer Panel to open the Shared Resource Editor panel
on the right.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a TIBCO Shared Resource 83
|
2. Specify the values for the configuration parameters.
— For JMS Shared Resource, the configuration parameters are listed in
Table 15.
Table 15 JMS Shared Resource Configuration Parameters
Field
Description
Configuration
Name
The name and description for the Shared Resource. The name is case
sensitive.
Description
The default name is JMS Shared Resource.
Connection Type
Direct
Provider URL
The server URL used to create the connection factory. This field is
required only for connections to a TIBCO Enterprise Message Service
server. See documentation for TibjmsConnectionFactory in
TIBCO Enterprise Message Service product documentation (Javadoc)
for more information.
The default value is tcp://localhost:7222.
Connection Factory
The factory for creating connections to the JMS server. Set to
com.tibco.tibjms.TibjmsConnectionFactory for Enterprise
Message Service or
progress.message.jclient.ConnectionFactory for
SonicMQ.
The default value is
com.tibco.tibjms.TibjmsConnectionFactory.
JNDI
JNDI Configuration Name
A JNDI shared resource definition that specifies the JNDI connection
information. Click Browse from the drop-down list to select a JNDI
configuration resource.
Connection Factory
The ConnectionFactory object stored in JNDI. This object is
used to create a topic or queue connection with a JMS application.
See your JNDI provider documentation for more information about
creating and storing ConnectionFactory objects. The default value
is GenericConnectionFactory.
To create an SSL connection to the JMS server, specify
SSLGenericConnectionFactory or any other connection factory with
SSL configuration provisioned on the JNDI server.
Client Certificate Password
The password of the client certificate used to verify the identity of SSL
clients.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
84
| Chapter 6
Working with ActiveMatrix SOA Projects
Table 15 JMS Shared Resource Configuration Parameters
Field
Description
More Options
User Identity
User identity of type Username/Password.
If the JMS provider does not require access control, this field can be
empty.
Not all JMS servers require user names and passwords. Refer to your
JMS provider documentation and consult your system administrator
to determine if your JMS server requires a user name and password.
Client ID
Client ID for the connection. Typically JMS providers have a
provider-specific format for client IDs. See your JMS provider’s
documentation for more information about client IDs. If specified, the
client ID must be unique within the scope of connections within the
server.
— For HTTP Server Shared Resource, the configuration parameters are listed
inTable 16.
Table 16 HTTP Server Shared Resource Configuration Parameters
Field
Description
Configuration
Name
Description
The name and description for the Shared Resource. The name is case sensitive.
The default name is HTTP Server Shared Resource.
Host
Specify the name of the host that accepts the incoming requests.
Port
The port number on which to listen for incoming HTTP requests.
The default value is 80.
More Options
SSL
Configuration
The SSL server shared resource used for the connection. The field label is a link to the
resource. Click Browse from the drop-down list to select a SSL configuration resource.
Minimum
Threads
The minimum number of threads available for incoming HTTP requests. The HTTP server
creates the number of threads specified by this parameter when it starts up.
The default value is 10.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a TIBCO Shared Resource 85
|
Table 16 HTTP Server Shared Resource Configuration Parameters
Field
Description
Maximum
Threads
The maximum number of threads available for incoming HTTP requests. The HTTP server
will not create more than the number of threads specified by this parameter.
When a client sends a request that cannot be processed because no threads are available,
the ActiveMatrix node returns the ConnectionRefused exception to the client.
The default value is 75.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
86
| Chapter 6
Working with ActiveMatrix SOA Projects
Configuring Composites
In the ActiveMatrix platform, a composite exports a cohesive set of business
functions as services. A composite consists of one or more components. A
component contains a configured implementation, where the implementation
provides the business functions.
The component configures the implementation using specific values for custom
properties and by connecting component references to component services or
composite references. The connections between references and services are
represented by wires.
To configure a composite, complete the following tasks:
•
Task A, Launch the Composite Editor
•
Task B, Create and Configure a Tuxedo Adapter Component
•
Task C, Add a Shared Resource to a Composite
•
Task D, Create a Composite Service
For more information, refer to the TIBCO ActiveMatrix Service Grid
documentation.
Task A Launch the Composite Editor
The Composite Editor is a graphical editor for developing composites.
To launch the Composite Editor, follow these steps:
1. Expand SOAProject > Composites in the Project Explorer panel. For example,
if the name of the ActiveMarix SOA project you created is tuxedo_demo_soa,
expand tuxedo_demo_soa > Composites in the Project Explorer panel.
2. Double-click the SOAProject.composite file under the Composites folder to
launch the Composite Editor.
Task B Create and Configure a Tuxedo Adapter Component
A component contains a configured implementation, where the implementation
provides the business functions.
To create a Tuxedo Adapter Component for an ActiveMatrix SOA project
composite, follow these steps in the Composite Editor.
1. Drag the TuxedoAdapter componet from the Palette to the Components
column and enter a name for the component (for example,
Tuxedo_Component).
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Configuring Composites 87
|
2. Click the component, the configuration parameters for the component are
displayed under the Properties Views panel, as shown in Figure 32.
Figure 32 Component Properties Tab
3. Click the General tab, the configuration parameters are listed in Table 17.
Table 17 Component Configuration Parameters
Field
Description
Name
The name of the adapter component.
Description
(Optional) A short description of the adapter component.
Version
The version number of the adapter component.
Type
(Read-only) The adapter type.
SDK
Application
Name
(Read-only) The instance name of your adapter configuration. Gets populated after adding
services to the component.
Configuration
URI
(Read-only) The adapter configuration that the service uses. Gets populated after adding
services to the component.
Repository URI
(Read-only) This file contains information used by the container to communicate with the
adapter service engine. Gets populated after adding services to the component.
TRA File Name
Enter the name of the TRA file to be used. If the adapter works as a Tuxedo
Workstation client enter adtuxedo_wrkstn.tra. If the adapter works as a Tuxedo
Native client, enter adtuxedo_native.tra.
4. Click the Services tab, and then Click the Add button to open the Resource
Picker dialog, as shown in Figure 33. Expand the tree in the left pane and
select an adapter endpoint, and then click the Add button to add it into the
Selected Adapter Endpoint pane on the right.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
88
| Chapter 6
Working with ActiveMatrix SOA Projects
Figure 33 Resource Picker Dialog
5. Click OK. The added service appears under the Services tab.
6. Save your configuration.
Task C Add a Shared Resource to a Composite
In the Creating a TIBCO Shared Resource section, you have created the HTTP
Server Shared Resource or JMS Shared Resource for your composite service. Now
you need to add the shared resources to the composite.
To add the HTTP Server Shared Resource or JMS Shared Resource to the
composite, follow these steps:
1. Click the canvas in the Composite Editor. The Composite Properties Views
panel appears under the Composite Editor.
2. Click the Shared Resource Profiles tab to add the shared resource.
— Click the Add button
to add a shared resource.
To change the name of the shared resource, click on its name in the Name
column.
Select HTTP or JMS in the Type collum according to the type of the shared
resource you created.
Click the Browse button
in the Target column to select a shared
resource in the Select Shared Resource dialog.
— Select an added shared resource and click the Delete button
it from the list.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
to delete
Configuring Composites 89
|
3. Save your configuration.
Task D Create a Composite Service
A composite service represents a port type and it enables consumers outside the
ActiveMatrix environment to access port types implemented within
ActiveMatrix.
To create a composite service in the Composite Editor, follow these steps:
1. Drag a service from the Palette to the Services column and enter a name for
the service (for example, Tuxedo_SOAP or Tuxedo_JMS).
2. Click the service, the configuration parameters of the service are displayed
under the Properties Views panel, as shown in Figure 34.
Figure 34 Service Properties Tab
3. Click the General tab to configure the service. The configuration parameters
are listed in Table 18.
Table 18 Service Configuration Parameters
Field
Description
Name
The name of the composite service.
Description
(Optional) A short description of the composite service.
Type
(Read-only) The composite service type.
Port Type
(Read-only) The port type defined in the WSDL file.
WSDL Location
(Read-only) The location of the WSDL file existed in the ActiveMatrix SOA project.
4. Click the Target tab and click the radio button next to the target component
service. A wire is drawn between the service and the component service.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
90
| Chapter 6
Working with ActiveMatrix SOA Projects
For JMS service, specify the shared resource profile in the Endpoint pane, as
shown in Figure 35.
Figure 35 Endpoint Configuration for the JMS Service
For SOAP service, specify the transport type and shared resource profile in the
Transport Configuration pane, as shown in Figure 36. Click the Generate
WSDL button to generate another WSDL file in the Composites folder of the
ActiveMatrix SOA project. This WSDL file will later be used by an external
client to access the service within ActiveMatrix.
Figure 36 Transport Configuration for the SOAP Service
5. Save your configuration.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a Service Assembly and a Service Assembly Archive 91
|
Creating a Service Assembly and a Service Assembly Archive
The adapter services that have been created in the design phase have to be
packaged into a service assembly before they can be deployed.
A service assembly contains service units and a descriptor that indicates the
container into which each service unit is to be deployed. Then it is used to create a
deployable archive called the service assembly archive.
For detailed information about how to create a service assembly and a service
assembly archive, refer to Creating a Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
92
| Chapter 6
Working with ActiveMatrix SOA Projects
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 93
Chapter 7
Deploying the Service Assembly Archive
This chapter describes how to deploy a service assembly archive using TIBCO
ActiveMatrix Administrator.
Topics
•
Overview, page 94
•
Creating a Service Assembly Archive, page 95
•
Deploying a Service Assembly Archive, page 98
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
94
| Chapter 7
Deploying the Service Assembly Archive
Overview
The adapter Service Engine enables the adapter to run in the ActiveMatrix
environment as a container and to provide services.
Adapter projects created using TIBCO Designer can also be packaged for
deployment in the ActiveMatrix environment.
Adapter projects can be designed to run in the following modes:
•
Wired Mode
The adapter component is wired with other composite elements in the
ActiveMatrix SOA project. Projects running in this mode interact with other
components in the ActiveMatrix environment.
Projects created using TIBCO Business Studio always run in the wired mode.
For more information about creating the service assembly archive in TIBCO
Business Studio, refer to Creating a Service Assembly and a Service Assembly
Archive.
•
Unwired Mode
The adapter component in the ActiveMatrix SOA project is not wired with
other composite elements and does not participate in the ActiveMatrix
environment. Projects running in the unwired mode do not provide services
to or consume services from other ActiveMatrix components. The adapter
configurations merely run in the ActiveMatrix node but the deployments can
be life-cycled using TIBCO ActiveMatrix Administrator.
Projects imported using the EAR file always run in the unwired mode.
For more information about creating a service assembly archive from a EAR
file, refer to Creating a Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a Service Assembly Archive 95
|
Creating a Service Assembly Archive
This section introduces how to create a service assembly archive for different
adapter projects.
•
For Adapter Projects Running in the Wired Mode
•
For Adapter Projects Running in the Unwired Mode (Using the EAR2SA Tool)
For Adapter Projects Running in the Wired Mode
Adapter projects created using TIBCO Business Studio always run in the Wired
Mode. For detailed information about how to create an adapter project in TIBCO
Business Studio, refer to Chapter 5, Configuring an Adapter Service Engine
Instance.
Creating a Service Assembly
To create a service assembly, follow these steps:
1. Select an ActiveMatrix SOA project in the Project Explorer panel and expand
the Composites folder.
2. Right-click the SOAProject.composite file under the Composites folder and
select Service Assembly from the pop-up menu.
3. Save the composite if prompted.
After completing the process, the deployment package, SOAProject.saf, is created
in the Deployment Packages folder.
Refreshing a Created Service Assembly
To refresh a service assembly already created, follow these steps:
1. Select an ActiveMatrix SOA project in the Project Explorer panel and expand
the Deployment Packages folder.
2. Right-click the service assembly file, SOAProject.saf, under the Deployment
Packages folder, and select Refresh Service Assembly from the pop-up
menu.
Creating a Service Assembly Archive
To create a service assembly archive, follow these steps:
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
96
| Chapter 7
Deploying the Service Assembly Archive
1. Select an ActiveMatrix SOA project in the Project Explorer panel and expand
the Deployment Packages folder.
2. Right-click the service assembly file, SOAProject.saf, under the Deployment
Packages folder, and select Build Archive from the pop-up menu.
3. Save the service assembly file if prompted.
After completing the process, a ZIP file, SOAProject.zip, is created in the
Deployment Packages folder.
This service assembly archive can now be deployed and started using TIBCO
ActiveMatrix Administrator. For detailed information, refer to Deploying a
Service Assembly Archive.
For Adapter Projects Running in the Unwired Mode (Using the EAR2SA Tool)
Adapter projects created using TIBCO Designer always run in the Unwired
Mode. For detailed information about how to create an adapter project in TIBCO
Designer, refer to TIBCO ActiveMatrix Adapter for Tuxedo Configuration and
Deployment.
Importing an EAR File
An adapter EAR file created using TIBCO Designer for the adapter project must
be imported into TIBCO Business Studio.
To import an EAR file, follow these steps:
1. Create an ActiveMatrix SOA project. Refer to Creating an ActiveMatrix SOA
Project.
2. Select the ActiveMatrix SOA project in the Project Explorer panel and select
Import... from the pop-up menu to open the Import dialog.
3. Select General > File System and click Next. The File System page appears in
the Import dialog, as shown in Figure 37.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Creating a Service Assembly Archive 97
|
Figure 37 Select an EAR File to Import
4. Click the Browse button next to the From directory field to navigate to the
directory where the EAR file is located. Click the Browse button next to the
Into folder field to select a folder where the EAR file is imported into.
5. Click Finish to close the dialog.
After completing the process, the EAR file is imported in the ActiveMatrix SOA
project.
Creating a Service Assembly Archive
To create a service assembly archive, follow these steps:
1. Right-click the EAR file under the ActiveMatrix SOA project, and select Build
Archive from the pop-up menu.
2. Save the EAR file if prompted.
After completing the process, a ZIP file, EAR_File.zip, is created in the
folder.
Deployment Packages
This service assembly archive can now be deployed and started using TIBCO
ActiveMatrix Administrator. For detailed information, refer to Deploying a
Service Assembly Archive.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
98
| Chapter 7
Deploying the Service Assembly Archive
Deploying a Service Assembly Archive
This section describes the steps necessary to configure and deploy a service
assembly. These tasks are performed using TIBCO ActiveMatrix Administrator.
Deploying a service assembly archive involves the following activities:
•
Uploading a Service Assembly Archive
•
Configuring the Service Assembly
•
Deploying the Service Assembly
•
Starting the Service Assembly
Before proceeding, ensure that the environment for TIBCO ActiveMatrix has been
configured correctly. Refer to TIBCO Activematrix documentation for more
information about how to configure the environment.
Uploading a Service Assembly Archive
The following steps describe how to upload the service assembly archive:
1. Start and log in to TIBCO ActiveMatrix Administrator.
2. Select Deploy to an Environment from the Perspective drop-down list and
development from the Environment drop-down list.
3. Click Upload Service Assembly.
4. Complete the following operations to upload your service assembly archive:
a. Enter a name for your service assembly in the Name field,
b. Click Browse... to select an archived ZIP file (the SA project) which was
generated in TIBCO Business Studio.
c. Select the Import Shared Resource Definitions check box to create the
shared resources definitions from the definitions in the service assembly
archive.
d. Click OK.
The service assembly will appear in the Service Assemblies table with a status of
Not Deployed.
Configuring the Service Assembly
To configure a service assembly, complete the following tasks:
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Deploying a Service Assembly Archive 99
|
•
Task A, Configure the Service Unit
•
Task B, Start Node and Install Shared Resources
Task A Configure the Service Unit
Specify the nodes on which the service units in the service assembly will be
deployed.
1. In the Service Assemblies table, select the service assembly.
2. Click the Service Units button to view the service units in the selected service
assembly.
3. For each service unit in the service assembly, complete the following
operations:
a. Select a service unit in the Service Units table.
b. In the Node Mapping tab, click the Edit button, select the nodes that you
want to deploy the service unit to in the Available Nodes list, and then
click the right arrow button. The nodes will appear in the Mapped Nodes
list.
c. Click Save.
The service unit properties are displayed in the following tabs:
•
Node Mapping — you can map the nodes to service units. See TIBCO
ActiveMatrix Administration for details.
•
Substitution Variables — you can specify the value of the service unit’s
substitution variables. See TIBCO ActiveMatrix Administration for details.
Task B Start Node and Install Shared Resources
If an ActiveMatrix Service (JMS or SOAP) is included in the SA project, you need
to install the corresponding Shared Resource for the appropriate node.
1. Select Configure an Environment from the Perspective drop-down list and
development from the Environment drop-down list.
2. Select the appropriate node in the Nodes table, and then click the Start button.
3. In the Node Detail panel, select Shared Resources.
4. Select the corresponding shared resource, and then click the Edit button.
5. In the Enabled at Startup? column, select the Yes radio button, and then click
the Save button.
6. On the top of the Shared Resources table, click the Install button. The status of
the resource is Installed.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
100
| Chapter 7
Deploying the Service Assembly Archive
Deploying the Service Assembly
A service assembly is ready to be deployed once the service assembly is uploaded
and configured. Before proceeding with deploying the service assembly, verify
the following:
•
All nodes required for deployment are running.
•
All containers required for deployment are activated.
•
All shared resources are installed.
To deploy a service assembly:
1. In the Service Assemblies table, select the service assembly.
2. Click the Deploy button.
Once the service assembly is deployed, the status changes to Deployed.
Starting the Service Assembly
After a service assembly has been successfully deployed, you can start it, and if
required, stop it.
1. In the Service Assemblies table, select one or more service assemblies.
2. To start the selected service assemblies, click the Start button. The status
changes to Running.
3. To stop the selected service assemblies, click the Stop button. The status
changes to Deployed.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 101
Chapter 8
Configuring Advanced Features
Topics
•
Managing Logs, page 102
•
Using Substitution Variables, page 103
•
Using Distributed Queues to Process Outbound Messages, page 108
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
102
| Chapter 8
Configuring Advanced Features
Managing Logs
Trace messages are used to trace and troubleshoot an exception condition when
an exception occurs at runtime.
You can configure the logging of trace messages using the TIBCO Common
Logging framework by taking advantage of the availability of Common Logging
libraries in the ActiveMatrix environment. The Common Logging framework
provides common messages and error codes that can be used across all TIBCO
products to log messages in a uniform manner.
To enable the common logging feature, the following properties are used:
•
application.ase.consoleoutput
•
tibco.env.ADAPTER_ENABLE_CL
The following table describes the usage of these properties.
Table 19 Properties for Common Logging Feature
Property Values
Behavior
application.ase.consoleoutput = false
The common logging feature is disabled and the trace
messages are written to the adapter log files.
tibco.env.ADAPTER_ENABLE_CL = false
application.ase.consoleoutput = true
tibco.env.ADAPTER_ENABLE_CL = false
The common logging feature is disabled and the trace
messages are displayed on the console.
When the application.ase.consoleoutput
property is set to true, any value assigned to the
tibco.env.ADAPTER_ENABLE_CL property is
ignored.
application.ase.consoleoutput = false
The common logging feature is enabled.
tibco.env.ADAPTER_ENABLE_CL = true
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Using Substitution Variables 103
|
Using Substitution Variables
The variable substitution mechanism can override substitution variables
predefined in the project in a controlled manner. Predefined variables can be
viewed and set in TIBCO Business Studio. Variables are specified as %%VARNAME%%
and cannot contain any blank space.
Variable substitution allows you to accomplish the following.
•
Substitute string variables specified in the project at startup time.
•
Locally define the value for a variable for a specific project. The local value
takes precedence over any global value.
•
Specify the value for a variable in a properties file. This overrides the project
repository and values set in code, but not variables set on the command line.
•
Enforce the pre-defined variables listed in Predefined Substitution Variables.
Variables can be used anywhere in the configuration and will be replaced by
the locally defined adapter instance.
Variable Specification
The Adapter Service Engine can specify variables in the project during
configuration using TIBCO Business Studio. It can also specify variables in a
properties file. The properties file values overwrite values set in the project.
Specifying Substitution Variables Using TIBCO Business Studio
Substitution variables provide an easy way to set defaults for use throughout
your project.
For example, you could assign the value 7600 to the predefined substitution
variable RvaPort, and then use the variable in different sessions in the adapter
service engine. To change the TIBCO Rendezvous daemon for the adapter service
engine, globally set it to a different value or override it from the command line.
To use substitution variables in your project, follow these steps:
1. Start TIBCO Business Studio. For detailed information about starting TIBCO
Business Studio, refer to Starting TIBCO Business Studio.
2. Expand defaultVars under your project in the Project Explorer panel, and
then double-click defaultVars.substvar. All currently defined substitution
variables are displayed in the Editor panel on the right.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
104
| Chapter 8
Configuring Advanced Features
You can perform the following tasks:
— To assign or change a variable value, select the variable from the Defined
Substitution Variables section, then go to the Details section, and enter the
new value in the Value field.
— To add a substitution variable, click the Add button in the Defined
Substitution Variables section. A new substitution variable entry is added
to the bottom of the list. Enter the variable name, type, and, optionally, the
value and description.
3. To use the substitution variable in the fields for a resource, enter the variable
name enclosed with %% on both sides or pick a substitution variable from the
Binding Editor.
When the project is deployed and the configured components are running, all
occurrences of the substitution variable name are replaced with the
substitution variable value (unless it was overridden in a way that had higher
precedence). For example, RvService would be replaced with 7500.
Changing Substitution Variables at Runtime
At runtime, you can update the values of the substitution variables using TIBCO
ActiveMatrix Administrator.
Figure 38 shows the Substitution Variables editor in TIBCO ActiveMatrix
Administrator, where you can specify runtime values for substitution variable.
Figure 38 Substitution Variables in TIBCO ActiveMatrix Administrator
A number of substitution variables are predefined. See Predefined Substitution
Variables for information. You can add definitions for any of the predefined
variables you need.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Using Substitution Variables 105
|
Predefined Substitution Variables
Table 20 lists and explains the predefined substitution variables. Some of them are
automatically used within the system when an adapter instance is configured.
Table 20 Predefined Substitution Variables
Variable
Description
Deployment
Defaults to the project name. This variable is used by the system to
partially define the subject name defined for a service.
DirLedger
Used by the system when defining the path name of the TIBCO
Rendezvous certified messaging ledger file. The default is the root
installation directory.
DirTrace
Used by the system to partially create the path name for the log file used
by the adapter. The default is the root installation directory.
Domain
The default value is Domain. This value can be any string value. This
variable is used by the system to partially define the subject name
defined for a service.
JmsProviderUrl
Specifies where the EMS server is located. Setting this value mostly
makes sense in early stages of a project, when only one EMS server is
used.
JmsSslProviderUrl
Specifies where the EMS SSL daemon is located.
RemoteRvDaemon
Used by the system to identify the TIBCO Rendezvous routing daemon.
See TIBCO Rendezvous Administration for details about specifying the
routing daemon name.
RvDaemon
Used by the system to identify the TIBCO Rendezvous daemon
parameter. The parameter instructs the transport object about how and
where to find the Rendezvous daemon and establish communication.
The default value is "tcp: 7500", which is the default value used by the
Rendezvous daemon. See TIBCO Rendezvous Concepts for details about
specifying the daemon parameter.
RvNetwork
Used by the system to identify the TIBCO Rendezvous network
parameter. Every network transport communicates with other
transports over a single network interface. On computers with more
than one network interface, the network parameter instructs the TIBCO
Rendezvous daemon to use a particular network for all outbound
messages from this transport. See TIBCO Rendezvous Concepts for details
about specifying the network parameter.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
106
| Chapter 8
Configuring Advanced Features
Table 20 Predefined Substitution Variables (Cont’d)
Variable
Description
RvService
Used by the system to identify the TIBCO Rendezvous service
parameter. The Rendezvous daemon divides the network into logical
partitions. Each transport communicates on a single service; a transport
can communicate only with other transports on the same service. The
default value is 7500.You can change the default value depending on
your service requirement. See TIBCO Rendezvous Concepts for details
about specifying the service parameter.
RvaHost
Used by the system to identify the computer on which the TIBCO
Rendezvous agent runs. See TIBCO Rendezvous Administration for details
about specifying the rva parameters.
RvaPort
Used by the system to identify the TIBCO Rendezvous agent TCP port
where the agent listens for client connection requests. See TIBCO
Rendezvous Administration for details about specifying the rva
parameters.
adtuxedo.connection.client
Name
Used by the system to identify the Tuxedo application the adapter needs
to connect to.
adtuxedo.connection.passwo
Password to be used by the system to log into the Tuxedo application.
rd
adtuxedo.connection.flags
The flags that indicate client-specific notification mechanism and the
mode of system access. The valid values are 1,2, 4, 8, 10, 20, 40 and 47.
adtuxedo.connection.groupN
When the adapter is used as a workstation client, the value for this
variable should be set to null, which is the default. When the adapter is
used as a native client, specify a valid Tuxedo group name for this
variable.
ame
adtuxedo.connection.userNa
me
adtuxedo.connection.userPa
ssword
User name or User ID to be used by the adapter to log into the Tuxedo
application.
Variable length data that is forwarded to the application defined
authentication service.
numOfMaxPendingInvcns
This parameter is used to specify the Maximum number of Pending
Invocations. The default value is 50.
pollIntervalForOutstanding
This parameter determines how often the RPC server polls Tuxedo in an
asynchronous mode for the outstanding invocations. The default setting
is 2000 milliseconds.
Invcn
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Using Substitution Variables 107
|
Table 20 Predefined Substitution Variables (Cont’d)
Variable
Description
pollIntervalForReplies
This parameter determines how often the RPC server polls for a reply
from Tuxedo in an asynchronous mode. The default value is 1000
milliseconds.
pollingInterval
This parameter determines how often the Event-based publisher polls
for a connection between the adapter and the Tuxedo server. The
default value is 3000 milliseconds.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
108
| Chapter 8
Configuring Advanced Features
Using Distributed Queues to Process Outbound Messages
The distributed queue mode allows multiple adapters to distribute the load
among the distributed queue members. The agent-based publishers and RPC
clients provide process level load balancing for outbound messages.
You can configure multiple adapter instances to use distributed queues, create a
TIBCO ActiveMatrix BusinessWorks process to test them, and use TIBCO
ActiveMatrix Administrator to deploy the instances on multiple nodes.
Example Scenario
In this scenario, several adapter instances with publishers are configured to use
distributed queues. To do this, follow these steps:
1. Start TIBCO Business Studio and create an adapter project.
2. Create and configure a Tuxedo adapter configuration.
a. Create a Tuxedo connection shared resource. See Tuxedo Connection
Shared Resource for more information.
b. Import the Tuxedo Business Objects to be used. See Tuxedo Business
Object for more information.
c. In the Adapter Services tab of the Tuxedo adapter configuration, add a
publisher.
d. In the Schema area, select Browse from the Request Class Reference From
BO drop-down list to specify the imported Tuxedo BO and click Apply.
e. In the Publisher Option area, select Distributed Queue in the Agent
Transport Type drop-down list. The Publisher RVCMQ Agent Subject field
appears in the Configuration tab.
f.
In the Configuration tab, specify the subject name in the Publisher
RVCMQ Agent Subject field in the Agent Subject area. The subject names
for all the publishers configured to use distributed queues must be same.
g. In the Run-time Connection area, specify the connection for the instance.
Refer to Chapter 5, Configuring an Adapter Service Engine Instance for more
information on how to configure a adapter instance.
3. In Project Explorer, select the adapter project created in step 1, the expend
TuxedoAdapterConfigurationFilename_genresources tree, and double click
DefaultRVCMQSession.rvtransport to open the Rendezvous Shared
Resource Editor.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Using Distributed Queues to Process Outbound Messages 109
|
You may need to specify CMQ Name, Scheduler Weight, and Worker Weight
as shown in Figure 39.
— CMQ Name The adapter instances that you are using must have the same
CMQ Name.
— Scheduler Weight Acceptable values range from 1 to 65545. Default is 1.
— Worker Weight The queue member with the greatest Worker Weight will
process the heaviest message.
Figure 39 Defining an RVCMQ Session
4. Generate the WSDL file for the adapter instance, save the WSDL file in a SOA
project, configure the composite for the adapter instance, and then create the
service assembly archive. Refer to Chapter 6, Working with ActiveMatrix SOA
Projects for more information.
5. Map the service assembly archive on a node in TIBCO ActiveMatrix
Administrator.
6. Deploy and start the service assembly archive in TIBCO ActiveMatrix
Administrator. Refer to Chapter 7, Deploying the Service Assembly Archive
for more information.
7. Repeat step 2 through step 6 to create several adapter instances and service
assembly archives. Each service assembly archive contains the configuration
information for one adapter instance. To use the Distributed Queues function,
the assembly archives need to be mapped on different nodes in TIBCO
ActiveMatrix Administrator.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
110
| Chapter 8
Configuring Advanced Features
8. Create a TIBCO ActiveMatrix BusinessWorks process, configure it, and then
start the process. See TIBCO ActiveMatrix BusinessWorks Process Design Guide
for detail about how to design a process.
9. Prepare Tuxedo, set the environment variables, and start the Tuxedo services.
10. Use the Tuxedo services to send request messages to the Adapter through the
agent.
The procedure for configuring multiple adapters with RPC clients is same as the
procedure for configuring multiple adapters with publishers.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 111
Appendix A
Adapter Properties File
Topics
•
Overview, page 112
•
Properties File Format, page 113
•
Predefined Properties, page 114
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
112
| Appendix A
Adapter Properties File
Overview
The runtime adapter parses a properties file at startup. The default runtime
adapter properties files are named adtuxedo_wrkstn.tra and
adtuxedo_native.tra. Which TRA file you should use is determined by the
client type you are using.
The default properties files are located in the bin subdirectory of the adapter
installation directory.
Each line in a properties file is a single property. Each property consists of a key
and a value. The key starts with the first non-whitespace character and ends at the
first "=", ":", or whitespace character. The value starts at the first character after
the equal sign (=). For example:
tibco.configurl=/tibco/private/adapter/Tuxedo/config/config1
tibco.repourl=tibcr://TEST_PROJECT
tibco.username=admin
tibco.password=samplePassword
tibco.clientVar.service=7600
tibco.clientVar.daemon=tcp:7600
Properties defined in the properties file override the same properties defined in
the project.
The adtuxedo.authinfo property in the adapter properties file indicates the
authorization level set on the Tuxedo server.
There are three possible values:
TPNOAUTH:
No authorization check. This is the default value.
TPSYSAUTH:
System authorization.
TPAPPAUTH:
Application authorization.
If the parameter is not specified, the adapter will attempt to connect to each of
these levels sequentially.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Properties File Format 113
|
Properties File Format
The following restrictions apply to properties:
•
The "!" character may not be used as a comment line indicator. Only the "#"
character is recognized.
•
The line continuation character is ignored (a value must fit on a line).
•
The key may not contain any of the termination characters. The adapter does
not support this syntax.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
114
| Appendix A
Adapter Properties File
Predefined Properties
The next table lists the predefined properties. Properties that start with
ntservice are available only on Microsoft Windows platforms.
All paths inside a properties file, including Microsoft Windows directory names,
must use forward slashes.
Table 21 Predefined Properties
Property
Description
tibco.configurl
Specifies the location of the adapter configuration inside the project file.
If a relative path is specified, the adapter service is assumed to be under the
default area in the project: /tibco/private/adapter/
If an absolute path is specified, the adapter configuration is looked up in the
project as defined by the argument.
tibco.username
The user name and password used by the repository server to access the project.
tibco.password
tibco.clientVar.var
name
Specifies the runtime values to substitute for global variables defined in the
project. This value takes precedence over the named global value set in the
project. Substitution takes place only at start up.
Append the global variable to tibco.clientVar, then give its value. For
example:
tibco.clientVar.DirLedger=TIBCO_HOME/adapter/adtuxedo/verios
n_number/ledger
adtuxedo.perfMon
<on or off>
Turns the performance statistics microagent on or off. Default is off.
adtuxedo.addCustomH
awkMethodstoClassMA
gent<on or off>
If it is set on, the getPollingInterval and setPollingInterval methods
are added to the class microagent. If it is set off, the invocation of these custom
methods will return default values. Default is on.
adtuxedo.enableDebu
g<on or off>
ntservice.name
If it is set on, the adapter will log trace messages with a Debug role; if it is set off,
the adapter will not log those messages.
Name for this Windows Service.
This property is useful if you wish to have multiple Windows Services for the
same executable. That is, you may wish to have two adapters running on the same
machine. By specifying different service names and display names for the
adapters, you can accomplish this.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Predefined Properties 115
|
Table 21 Predefined Properties
Property
Description
ntservice.displayna
me
Name to display in the Services control for this Windows Service.
ntservice.starttype
Start type for this Windows Service. Either manual or automatic. For example:
This property is useful if you wish to have multiple Windows Services for the
same executable. That is, you may wish to have two adapters running on the same
machine. By specifying different service names and display names for the
adapters, you can accomplish this.
ntservice.starttype automatic
You can use this property to initially set the start type for the service, but once the
service is installed, use the Windows Services control to change the start type of
services.
ntservice.binary.pa
th.absolute
Absolute path to the executable that is run when the service is started. For
example:
ntservice.binary.path.absolute
TIBCO_HOME/adapter/adtuxedo/veriosn_number/bin/adtuxedo_wrkstn.exe
ntservice.interacti
ve
Specifies whether the Windows Service is interactive. Either true or false.
ntservice.account
Username under which to run the Windows Service.
ntservice.interactive=true
You can use this property to initially set the account for the service, but once the
service is installed, use the Services control to change the user account of
services.
ntservice.password
Password for the username in the ntservice.account property.
You can use this property to initially set the password for the user account, but
once the service is installed, use the Services control to change the password.
adtuxedo.stackSize
The stack size used by dispatcher threads.
adtuxedo.PollingInt
erval
The polling interval, in milliseconds, used by the Event-based publisher.
adtuxedo.traceOldMe
ssages
To enable the printing of 4.x trace messages. Default is OFF.
tibco.env.WSNADDR
Workstation Address of the Tuxedo server to connect to. Required if the adapter
is used as a Workstation Client.
tibco.env.TUXCONFIG
TUXCONFIG of the Tuxedo server to connect to. Required if the adapter is used as
a Native Client.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
116
| Appendix A
Adapter Properties File
Table 21 Predefined Properties
Property
Description
tibco.env.FLDTBLDIR
32
This contains a list of directories (separated by commas) where field tables can be
found.
tibco.env.FIELDTBLS
32
This contains a list of the files in the table directories (separated by commas) that
are to be used.
Table 22 lists the predefined properties for the TIBCO ActiveMatrix environment.
See MultiThreading for more information.
Table 22 Predefined Properties for TIBCO ActiveMatrix
Property
Description
tibco.env.useNewEcl
ipseUI
The value are ON or OFF. When deploying the adapter in the TIBCO ActiveMatrix
environment, set it to ON.
tibco.env.TUXConnNu
mber
It is the number of connections with the Tuxedo application. The value must be
larger than 0.
tibco.env.RVAgentTh
readNumber
The number of threads to be used for a Rendezvous agent-based, queued-based,
or event-based publisher or a Rendezvous agent-based RPC client. The value
must be larger than 0.
tibco.env.RVCMQAgen
tThreadNumber
The number of threads to be used for a distributed queue agent-based publisher
or RPC client. The value must be larger than 0.
tibco.env.JMSQueueA
gentThreadNumber
The number of threads to be used for a JMS queue agent-based publisher. The
value must be larger than 0.
tibco.env.JMSTopicA
gentThreadNumber
The number of threads to be used for a JMS topic agent-based publisher. The
value must be larger than 0.
tibco.env.ASE_STACK
_SIZE
The stack sized used by the service engine thread. For the applications that use
large amounts of stack storage, you need to set this property.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 117
Appendix B
Message Formats
This appendix details the additional request fields available in the message
schema for subscription and request-response messages.
Topics
•
Subscriber Additional Fields, page 118
•
RPC Server Additional Fields, page 120
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
118
| Appendix B
Message Formats
Subscriber Additional Fields
Table 23 lists the additional fields that are available in the request schema for a
subscriber.
Table 23 Subscriber Additional Fields for the Request Schema
Field
Description
Usage
Type
CommunicationType
The Tuxedo communication
paradigm used to invoke the
Tuxedo service. The possible
values are:
Used to specify the type of
Tuxedo communication
paradigm to be used for an
adapter service.
String
Used when the Tuxedo
communication paradigm is set
to Async, Queue or Convl. It is
not used when it is set to Event.
String
ServiceName
•
Async
•
Queue
•
Event
•
Convl
The name of the Tuxedo service to
be invoked by the adapter.
If set to Queue, the service name
and the request queue name
must be identical.
QueueSpace
The name of the queue space
configured in the Tuxedo
integrated application. This queue
space will contain the request
queue, reply queue, and error
queue.
Used only if the Tuxedo
communication paradigm is set
to Queue-based.
String
ReplyQueue
The name of the reply queue
defined in the Tuxedo queue space.
Replies from the Tuxedo services
will be posted in this queue.
Used only if the Tuxedo
communication paradigm is set
to Queue-based.
String
ConvlBatchField
The field in the request class that
contains the name of the Tuxedo
field where the batch size for the
transfer of data is specified.
Used only if the Tuxedo
communication paradigm is set
to Conversational and appears in
the schema only if the buffer type
is configured as FML32.
String
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
Subscriber Additional Fields 119
|
Table 23 Subscriber Additional Fields for the Request Schema
Field
Description
Usage
Type
EventNameField
The field in the request class that
contains the name of the Tuxedo
field where the event is specified.
This event name is used to post
subscribed data to Tuxedo.
Used only if the Tuxedo
communication paradigm is set
to Event-based and appears in
the schema only if the buffer type
is configured as FML32.
String
EventName
The field in the request class where
the event name is specified. This
event name is used to post
subscribed data to Tuxedo.
Used only if the Tuxedo
communication paradigm is set
to Event-based and appears in
the schema only if the buffer type
is configured String or
CArray.
String
Table 24 lists the additional fields that are available in the reply schema for a
subscriber. The adapter populates these fields in the reply.
Table 24 Subscriber Additional Fields for the Reply Schema
Field
Description
Type
ErrorCode
The field that contains the error code. Example: AETUX-00031
String
ErrorType
The field that contains the error type. The possible values are:
String
ErrorDetails
•
Tuxedo System
•
Connection
The field that contains the complete error description. Tuxedo returned
error code and details will be part of this description.
String
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
120
| Appendix B
Message Formats
RPC Server Additional Fields
Table 25 lists the additional fields that are available in the request schema used for
a RPC server.
Table 25 RPC server Additional Fields for the Request Schema
Field
Description
Usage
Type
ServiceName
The name of the Tuxedo service
to be invoked by the adapter.
Used when the Tuxedo
communication paradigm is set
to Async or Sync.
String
Table 26 lists the additional fields that are available in the reply schema for a RPC
server. The adapter populates these fields in the reply schema.
Table 26 RPC Server Additional Fields for the Reply Schema
Field
Description
Type
ErrorCode
The field that contains the error code. Example: AETUX-00031
String
ErrorType
The field that contains the error type. The possible values are:
String
•
Tuxedo System
•
Connection
ErrorDetails
The field that contains the complete error description. Tuxedo returned
error code and details will be part of this description.
String
isEnd
This field is set by the adapter. This happens only if at least 1 row has
been retrieved.
Boolean
tpurcode
This field can get the value of rcode,an application defined return code.
String
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 121
Appendix C
Adapter Agent API References
This appendix explains some adapter agent methods based on TIBCO
Rendezvous or TIBCO EMS.
Topics
•
TIBCO Rendezvous Adapter Agent Methods, page 122
•
TIBCO EMS Adapter Agent Methods, page 128
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
122
| Appendix C
Adapter Agent API References
TIBCO Rendezvous Adapter Agent Methods
The following adapter agent methods use TIBCO Rendezvous. The header file
relating to them is adapteragent.h and the link library relating to them is
agent.lib for Microsoft Windows or libagent.so/libagent.sl for Unix.
With regard to publishers, there are two methods for Asynchronous Rendezvous
Adapter Agent, callPub() and callCArrayPub(). There are two methods for
Synchronous Rendezvous Adapter Agent, callSyncPub() and
callSyncCArrayPub().
The callPub Method
•
Function
int callPub(char * serviceName, char * sendbuf, char * service, char * network,
char * daemon, char * subject);
•
Description
This method is for publishers based on Asynchronous Rendezvous Adapter
Agent. The user's Tuxedo service invokes the method to send the request
which uses FML32/STRING buffers to TIBCO Rendezvous.
•
Parameters
char * serviceName—
char * sendbuf—
The name of the adapter service to be used
The request buffer of type FML32/STRING
The service parameter of the TIBCO Rendezvous transport
which is used internally
char * service—
The network parameter of the TIBCO Rendezvous
transport which is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
which is used internally
The message subject on which the message is to be sent
from the Adapter Agent to the adapter
char * subject—
•
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
The callCArrayPub Method
•
Function
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
TIBCO Rendezvous Adapter Agent Methods 123
|
int callCArrayPub(char * serviceName, char * sendbuf, char * service, char *
network, char * daemon, char * subject, long sendlen)
•
Description
This method is for publishers Asynchronous Rendezvous Adapter Agent. The
user's Tuxedo service invokes the method to send the request which uses
CArray buffers to TIBCO Rendezvous.
•
Parameters
char * serviceName—
char * sendbuf—
The name of the adapter service to be used
The request buffer of type CArray
The service parameter of the TIBCO Rendezvous transport
that is used internally
char * service—
The network parameter of the TIBCO Rendezvous
transport that is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
that is used internally
char * subject—
long sendlen—
•
The message subject on which the message is to be sent
The length of the CArray buffer to be sent
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
The callSyncPub Method
•
Function
int callSyncPub(char * serviceName, char * sendbuf, char * service, char *
network, char * daemon, char * subject, unsigned long agentTimeout);
•
Description
This method is for publishers based on Synchronous Rendezvous Adapter
Agent. The user's Tuxedo service invokes the method to send the request
which uses FML32/STRING buffers to TIBCO Rendezvous, and then the agent
waits for the feedback from the adapter.
•
Parameters
char * serviceName—
char * sendbuf—
The name of the adapter service to be used
The request buffer of type FML32/STRING
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
124
| Appendix C
Adapter Agent API References
The service parameter of the TIBCO Rendezvous transport
which is used internally
char * service—
The network parameter of the TIBCO Rendezvous
transport which is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
which is used internally
The message subject on which the message is to be sent
from the agent to the adapter
char * subject—
unsigned long agentTimeout — The timeout of the agent in seconds.
•
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
The callSyncCArrayPub Method
•
Function
int callSyncCArrayPub(char * serviceName, char * sendbuf, char * service,
char * network, char * daemon, char * subject, long sendlen, unsigned long
agentTimeout)
•
Description
This method is for publishers based on Synchronous Rendezvous Adapter
Agent. The user's Tuxedo service invokes the method to send the request
which uses CArray buffers to TIBCO Rendezvous, and then the agent waits
for the feedback from the adapter.
•
Parameters
char * serviceName—
char * sendbuf—
The name of the adapter service to be used
The request buffer of type CArray
The service parameter of the TIBCO Rendezvous transport
that is used internally
char * service—
The network parameter of the TIBCO Rendezvous
transport that is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
that is used internally
char * subject—
long sendlen—
The message subject on which the message is to be sent
The length of the CArray buffer to be sent
unsigned long agentTimeout — The timeout of the agent in seconds.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
TIBCO Rendezvous Adapter Agent Methods 125
|
•
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
When some abnormal situations occur, callPub or callCArrayPub will still
return a success message, but callSyncPub or callSyncCArrayPub will report
the errors by returning a failure message, which is received from the adapter.
Those situations are as follows:
— The serviceName (the first parameter of each method) is different from the
publisher name configured in the Configuration area in TIBCO Business
Studio.
— The subject (the six parameter of each method) is different from the
publisher RV Agent Subject specified in the Agent Subject area in the
Configuration tab of each adapter instance in TIBCO Business Studio.
— The adapter suddenly terminates.
— The adapter fails to publish data to TIBCO environment.
The callClient Method
•
Function
int callClient (char * serviceName, char * sendbuf, unsigned long
adapterTimeout, char * service, char * network, char * daemon, unsigned long
agentTimeout, char * subject, void** replyBuf)
•
Description
This method is for Resquest-Response invocation services. The user's Tuxedo
service invokes the method to send the request which uses FML32/STRING
buffers to TIBCO Rendezvous.
•
Parameters
char * serviceName—The
char * sendbuf—The
name of the adapter service to be used
request buffer of type FML32/STRING
unsigned long adapterTimeout—
char * service—The
The timeout of the adapter in seconds
service parameter of the TIBCO Rendezvous transport
that is used internally
The network parameter of the TIBCO Rendezvous
transport that is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
that is used internally
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
126
| Appendix C
Adapter Agent API References
unsigned long agentTimeout—
The timeout of the agent in seconds
The message subject on which the message is to be sent
from the Adapter Agent to the adapter
char * subject—
The address of the reply buffer of type FML32/STRING.
The replyBuf must be allocated by tpalloc.
void ** replyBuf—
•
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
The callCArrayClient Method
•
Function
int callCArrayClient(char * serviceName, char * sendbuf, unsigned long
adapterTimeout, char * service, char * network, char * daemon, unsigned long
agentTimeout, char* subject, void** replyBuf, long sendlen, unsigned int*
rcvlen)
•
Description
This method is for RPC clients. The user's Tuxedo service invokes the method
to send the request which uses CArray buffers to TIBCO Rendezvous.
•
Parameters
char * serviceName—The
char * sendbuf—The
name of the adapter service to be used
request buffer of type CArray
unsigned long adapterTimeout—
char * service—The
The timeout of the adapter in seconds
service parameter of the TIBCO Rendezvous transport
that is used internally
The network parameter of the TIBCO Rendezvous
transport that is used internally
char * network—
char * daemon— The daemon parameter of the TIBCO Rendezvous transport
that is used internally
unsigned long agentTimeout—
The timeout of the agent in seconds
The message subject on which the message is to be sent
from the Adapter Agent to the adapter
char * subject—
void ** replyBuf— The address of the reply CArray buffer. The replyBuf
must be allocated by tpalloc
long sendlen—The
length of the CArray buffer to be sent
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
TIBCO Rendezvous Adapter Agent Methods 127
|
unsigned int* rcvlen—The
address of a integer to return the length of
replyBuf
•
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
128
| Appendix C
Adapter Agent API References
TIBCO EMS Adapter Agent Methods
The following adapter agent methods use TIBCO EMS. The header file relating to
them is adapteragentJms.h and the link library relating to them is
agentJMS.lib.lib for Microsoft Windows or
libagentJMS.so/libagentJMS.sl for Unix.
The callPubJMS Method
•
Function
int callPubJMS(char *serviceName, char *sendbuf, char *serverUrl, char
*jmsType, char *destination, char *userName, char *password)
•
Description
This method is for JMS Adapter Agent-based publishers. The user's Tuxedo
service invokes the method to send the request which uses FML32/STRING
buffers to TIBCO EMS.
•
Parameters
char * serviceName—The
char * sendbuf—The
name of the adapter service to be used
request buffer of the type FML32/STRING
char * serverUrl— The EMS server location with URL format, and the
format is "<protocal>://<host-name>:<port-number>", for
example:"tcp://myhost:7222". Please see EMS documents for further
details.
char * jmsType—
The JMS transport type. The value must be equal
with "queue" or "topic".
char * destination—
The JMS destination. the queue name or the topic
name.
char * userName—
char * password—
•
The user name of the EMS server
The password of the EMS server
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
The callCArrayPubJMS Method
•
Function
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
TIBCO EMS Adapter Agent Methods 129
|
int callCArrayPubJMS(char *serviceName, char *sendbuf, char *serverUrl,
char *jmsType, char *destination, char *userName, char *password, unsigned
int sendlen)
•
Description
This method is for JMS Adapter Agent-based publishers. The user's Tuxedo
service invokes the method to send the request which uses CArray buffers to
TIBCO EMS.
•
Parameters
char * serviceName—The
char * sendbuf—The
name of the adapter service to be used
request buffer of type CArray
char * serverUrl— The EMS server location with URL format, and the
format is "<protocal>://<host-name>:<port-number>", for
example:"tcp://myhost:7222". Please see EMS documents for further
details.
char * jmsType—
The JMS transport type. The value must be equal
with "queue" or "topic".
char * destination—
The JMS destination. the queue name or the topic
name.
char * userName—
char * password—
The user name of the EMS server
The password of the EMS server
unsigned int sendlen—
•
The length of sendbuf
Return Value
The method returns 1 for success, and 0 for failure. Error messages are written
into the Tuxedo ULOG file.
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
130
| Appendix C
Adapter Agent API References
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
| 131
Index
A
Adapter Methods
EMS Adapter Agent Methods 128
Rendezvous Adapter Agent Methods 122
Adapter Properties File
File Format 113
Predefined Properties 114
AMX_HOME xiv
Application Password 48
generating WSDL file 79
Getting Started
Configuring an Adapter Service Engine Instance 32
Deploying a Service Assembly Archive 43
Working with an ActiveMatrix SOA Project 37
Group Name 48
I
Initialization Flags 48
C
Class Microagent Name field, adapter 58
Client Name 48
clientvar property 114
Composite Editor 86
Configuring Composites 86
converting project to repository file 91
Create Tuxedo Configuration Files 23
Creating a TIBCO Shared Resource 81
Creating an ActiveMatrix SOA Project 76
creating service assembly 91
customer support xvii
E
Edit the ubbconfig File 22
ENV_HOME xiv
M
Managing Logs 102
Microagent Session field, adapter 58
P
password property 114
Peparing Tuxedo 20
Predefined Substitution Variables 105
Predefined variables 103
Projects
creating 8
importing 11
importing into workspace 15
R
G
Generating an Adapter WSDL 79
Related Documentation xii
repository file 91
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
132
| Index
RPC Server Additional Fields 120
Using Substitution Variables 103
Uuse Distributed Queues to Process Outbound
Messages 108
S
Service Assembly
deployment
configure 98
deploy 100
start 100
stop 100
upload 98
Starting TIBCO Business Studio 5
Subscriber Additional Fields 118
support, contacting xvii
W
Working with TIBCO ActiveMatrix BusinessWorks
Service Engine 16
T
technical support xvii
TIBCO ActiveMatrix product family 2
TIBCO Business Studio Workbench Layout
Editor Panel 6
Menu 6
Outline Panel 6
Project Explorer Panel 6
Toolbar 6
Views Panel 7
TIBCO_HOME xiv
Tuxedo Adapter Configuration
Adapter Services Tab 60
Configuration Tab 55
MultiThreading 73
Steps 55
Timers Tab 71
Tuxedo Business Object 50
Tuxedo Connection Shared Resource 46
U
username property 114
TIBCO ActiveMatrix Adapter Service Engine for Tuxedo Configuration and Deployment
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