TIBCO Adapter™ for Infranet
User’s Guide
Software Release 5.2
June 2007
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH
EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR
PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE
EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY
OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS
OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE
AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER
LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE
SOFTWARE (AND WHICH IS DUPLICATED IN THE TIBCO ADAPTER FOR INFRANET USER’S
GUIDE). 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 Hawk,
TIBCO Designer, TIBCO Rendezvous, TIBCO Enterprise Message Service, TIBCO Runtime Agent, TIBCO
Administrator and TIBCO Repository 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. PLEASE 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 © 1999-2007 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TIBCO Adapter for Infranet Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Third Party Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xiv
xiv
xiv
xvii
Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii
How to Contact TIBCO Customer Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Chapter 1 Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Infranet Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Adapter Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Adapter Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Adapter Capabilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Message Transports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Multithreading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Connection Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Transaction Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Internationalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Enhanced Time-out Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Subscription Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Request-Response Invocation Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
12
12
13
14
15
Adapter and Infranet Interaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Chapter 2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Preparing your Environment for Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Operating System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Infranet Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
TIBCO Adapter for Infranet User’s Guide
iv
| Contents
Pre-Installation Worksheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adapter Machine Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Server Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infranet User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infranet Client Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Infranet Software Required before installing the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
22
23
23
23
24
Installer Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Upgrading the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Uninstalling the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Installation Registry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Microsoft Windows Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNIX Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
27
27
27
28
Adapter Components and Compatible Software. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Adapter Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Required and Optional TIBCO Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Installation on Microsoft Windows Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Installing the Adapter on Microsoft Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Combining Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Installation on UNIX Systems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Installing the Adapter on UNIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Combining Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Post Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Permission Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Prerequisites to be met before you start configuring the adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Installer FAQs and Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Running Out of Disk Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation Error on HP-UX 11.00 64 bit Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuring TIBCO Hawk. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
40
41
42
43
Chapter 3 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Basic Steps for Configuring and Using the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Configuring the Adapter Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deploying the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Starting the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Stopping the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 4 Adapter Instance Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
TIBCO Adapter for Infranet User’s Guide
Contents v
|
Adapter Instance Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Design-time Connection Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Run-Time Connection Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Adapter Services Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multithreading Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Importing an Opcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opcode Specification Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Specification Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
62
62
65
67
69
70
71
72
74
75
77
78
79
Adding Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
82
82
82
87
88
Subscription Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opcode Configure Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Query Configure Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
90
90
91
92
94
99
Request-Response Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
101
101
106
111
Request-Response Invocation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Opcode Configure Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Transport Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Custom DM Invocation Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
113
113
114
115
120
121
Saving the Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Testing the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Chapter 5 Configuring Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Defining a TIBCO Hawk Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Using Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
TIBCO Adapter for Infranet User’s Guide
vi
| Contents
Variable Specification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Using the Adapter with a Revision Control System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Enabling Event Publishing in Infranet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Transaction Handling. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Important Transaction Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Query Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Invoking Custom Data Manager through Request-Response Invocation Service . . . . . . . . . . . . . . . . . . . . . . . 149
Custom Opcode Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Chapter 6 Deploying and Starting an Adapter Using TIBCO Administrator . . . . . . . . . . . . . . 157
Create an EAR File in TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Deploy the Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Start or Stop the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Monitor the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Adapter Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Properties File Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Obfuscating or Encrypting a Password in the Properties File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
162
162
163
165
Chapter 7 Monitoring the Adapter Using TIBCO Hawk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Starting TIBCO Hawk Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
The Auto-Discovery Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Invoking Microagent Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Available Microagents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Appendix A Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Frequently Asked Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Appendix B Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Trace Message Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Status Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Appendix C Infranet Opcodes, Datatypes and FLISTs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Opcode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Customizing HTML Specification Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
TIBCO Adapter for Infranet User’s Guide
Contents vii
|
PCM_OP_BILL_PURCHASE_DEAL.input.html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
PCM_OP_CUST_UPDATE_CUSTOMER.input.html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
PCM_OP_CUST_COMMIT_CUSTOMER.input.html . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
FLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Known Problems with Infranet HTML FLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
TIBCO Adapter for Infranet User’s Guide
viii
| Contents
TIBCO Adapter for Infranet User’s Guide
| ix
Figures
Figure 1
The 4-tier Architecture of Infranet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Figure 2
Adapter Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Figure 3
Publication Service Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Figure 4
Subscription Service Flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Figure 5
Request-Response Service Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Figure 6
Request-Response Invocation Service Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Figure 7
Logical Architecture for Integration with the Infranet System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Figure 8
Adapter and Infranet System Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 9
The ’Infranet’ folder in a Version Control System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
TIBCO Adapter for Infranet User’s Guide
x
| Figures
TIBCO Adapter for Infranet User’s Guide
Tables xi
|
Tables
Table 1
TIBCO Adapter components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Table 2
Required and Optional TIBCO Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 3
Supported platforms, package names and disk space for Microsoft Windows . . . . . . . . . . . . . . . 31
Table 4
Supported platforms, package names, patches and disk space for UNIX systems . . . . . . . . . . . . 35
Table 5
Predefined Global Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Table 6
Predefined Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Table 7
Microagent Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Table 8
Tracing Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Table 9
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Table 10
Commonly Reported Infranet Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Table 11
Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Table 12
Input FLists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
Table 13
Output FLists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
TIBCO Adapter for Infranet User’s Guide
xii
| Tables
TIBCO Adapter for Infranet User’s Guide
| xiii
Preface
This User’s Guide is intended for system administrators of networks running
TIBCO Adapter for Infranet software, as well as for system integrators, who plan
to integrate Infranet with another system. Readers of this guide must be
experienced system administrators and system integrators. This includes
administration and configuration experience with the TIBCO environment and
Infranet Enterprise applications. This manual assumes familiarity with the basic
concepts of the TIBCO environment, and Portal Infranet technology.
Topics
•
Related Documentation, page xiv
•
Terminology and Acronyms, page xviii
•
How to Contact TIBCO Customer Support, page xx
TIBCO Adapter for Infranet User’s Guide
xiv | Preface
Related Documentation
This section lists documentation resources you may find useful.
TIBCO Adapter for Infranet Documentation
The following documents form the TIBCO Adapter for Infranet documentation
set:
•
TIBCO Adapter Concepts Read this document for an introduction to TIBCO
adapters, adapter components, capabilities, lifecycle and types of adapters
available.
•
TIBCO Adapter for Infranet User’s Guide Read this manual for instructions on
installing and using the adapter.
•
TIBCO Adapter for Infranet Examples Guide Read this manual for examples of
using the adapter.
•
TIBCO Adapter for Infranet Release Notes Read this for a summary of features,
changes since the last release, and a description of any issues that may affect
installing or using the adapter.
Other TIBCO Product Documentation
Note that only books that relate to adapters are listed. Each of the books is
available from the d o c directory in the product’s installation area.
•
TIBCO BusinessWorks™ Software
— TIBCO BusinessWorks Concepts
— TIBCO BusinessWorks QuickStart
— TIBCO BusinessWorks Business Palette Reference
— TIBCO BusinessWorks Process Design Guide
— TIBCO BusinessWorks Error Codes
— TIBCO BusinessWorks Release Notes
•
TIBCO Designer™ software:
— TIBCO Designer User’s Guide
— TIBCO Designer Palette Reference
— TIBCO Designer Release Notes
TIBCO Adapter for Infranet User’s Guide
Related Documentation xv
|
•
TIBCO Administrator™ software:
— TIBCO Administrator User’s Guide
— TIBCO Administrator Server Configuration Guide
— TIBCO Administrator Installation Guide
— TIBCO Administrator Release Notes
•
TIBCO IntegrationManager™ software:
— TIBCO IntegrationManager Concepts
— TIBCO IntegrationManager Administrator’s Guide
— TIBCO IntegrationManager Process Design Guide
— TIBCO IntegrationManager Performance and Tuning Guide
— TIBCO IntegrationManager Reference
— TIBCO IntegrationManager Release Notes
•
TIBCO Rendezvous® software:
— TIBCO Rendezvous Concepts
— TIBCO Rendezvous Administration
— TIBCO Rendezvous Configuration Tools
•
TIBCO Enterprise Message Service™:
— TIBCO Enterprise Message Service User’s Guide
— TIBCO Enterprise Message Service Installation
— TIBCO Enterprise Message Service C API Reference
— TIBCO Enterprise Message Service .NET Reference
— TIBCO Enterprise Message Service Application Integration Guide
— TIBCO Enterprise Message Service Release Notes
•
TIBCO Hawk® software:
— TIBCO Hawk Installation and Configuration
— TIBCO Hawk Administrator’s Guide
TIBCO Adapter for Infranet User’s Guide
xvi | Preface
•
TIBCO Adapter™ SDK
— TIBCO Adapter SDK Concepts
— TIBCO Adapter SDK Status Codes
— TIBCO Adapter SDK Release Notes
— TIBCO Adapter SDK Programmer’s Guide
•
TIBCO Runtime Agent™
— TIBCO Runtime Agent Release Notes
— TIBCO Runtime Agent Domain Utility User’s Guide
— TIBCO Runtime Agent Installation
— TIBCO Runtime Agent Scripting Deployment User’s Guide
TIBCO Adapter for Infranet User’s Guide
Related Documentation xvii
|
Third Party Documentation
You may also find it useful to read the following documents on Infranet , available
from Portal Software, Inc.:
— Understanding Infranet
— User’s Guide
— Installation Guide
— System Administration Guide
— Programmer’s Reference
— Programmer’s Guide
— Service Integration Components
TIBCO Adapter for Infranet User’s Guide
xviii| Preface
Terminology and Acronyms
Acronym
Meaning
<Adapter_Home>
The location where the adapter has been installed on the host.
AE
TIBCO ActiveEnterprise
API
Application Programming Interface.
COM
Component Object Model.
Custom Data Manager
The Custom Data Manager for Infranet that helps Infranet client
application to invoke a Request-Response Service operation on an
Enterprise application.
EAI Plug-in
The EAI Plug-in interfaces with the Infranet EAI Framework of
Infranet.
EAIDM
EAI Data Manager for Infranet that interfaces with the adapter.
EMS
TIBCO Enterprise Message Service
FLIST
The native format of Infranet Application.
GUI
Graphical User Interface.
Inbound
Events coming into the adapter. It refers to the inflow of data into the
Infranet application. It is applicable to Subscription and
Request-response services.
JMS
Java Messaging Service.
Outbound
Events going out from the adapter. It refers to data being captured
from the Infranet application and being sent out. It is applicable to the
Publication and Request-Response Service.
QOS
TIBCO Rendezvous quality of service.
RPC
Remote Procedural Call.
RV
Refers to TIBCO Rendezvous reliable quality of service, as opposed to
certified message.
TIBCO Adapter for Infranet User’s Guide
Terminology and Acronyms xix
|
Acronym
Meaning
RVCM
Refers to TIBCO Rendezvous certified quality of service.
RVCMQ
Refers to TIBCO Rendezvous distributed queue message.
TIBCO_HOME
The folder where all TIBCO products are installed on the host. For
example, C : \ T i b c o .
TIBCO Adapter for Infranet User’s Guide
xx | Preface
How to Contact TIBCO Customer Support
•
For comments or problems with this manual or the software it addresses,
please contact TIBCO Product Support on the web at:
http://support.tibco.com
Entry to this site requires a username and password. Customers with valid
maintenance or support contract can obtain their username and password
from that same website.
•
For an overview of TIBCO Support Services, and information about getting
started with TIBCO Product Support, visit this site:
http://www.tibco.com/services/support/default.jsp
TIBCO Adapter for Infranet User’s Guide
|1
Chapter 1
Concepts
This chapter introduces the TIBCO Adapter for Infranet product by providing
background information about features, configurable operations, and the
applications that use it.
Topics
•
Infranet Overview, page 2
•
Adapter Overview, page 4
•
Adapter Features, page 5
•
Adapter Capabilities, page 7
•
Adapter Services, page 12
•
Adapter and Infranet Interaction, page 17
TIBCO Adapter for Infranet User’s Guide
2
| Concepts
Infranet Overview
Infranet is a customer management and billing system designed specifically for IP
and telecommunication service providers, such as Internet service providers and
IP telephony service providers. Infranet supports customer registration, service
provisioning, authentication and authorization, customer activity tracking,
billing, account management, and data collection and reporting.
The adapter allows enterprise systems to integrate with Infranet.
The Infranet system consists of:
•
The Application tier which comprises of client applications. Client
applications capture data related to customer service usage, update and
retrieve Infranet data.
•
The Connection Manager tier comprises of Connection Managers, Facilities
Modules and External Modules.
— Connection Managers provide the interface between the client applications
and the Infranet system.
— Facilities Modules process the data captured by the client applications.
— External Modules also function like Facilities Modules, but are started as
separate services or processes.
•
The Data Manager tier consists of Data Managers that translate requests from
the Connection Managers and communicate them to the Infranet database.
Data Managers translate data into SQL language, which is understood by the
Infranet database.
•
The Data tier consists of the Infranet database and other data access systems
like credit card processing service and the Taxware database. The database
stores customer account data and business data, including records of all
events occurring in the Infranet system.
TIBCO Adapter for Infranet User’s Guide
Infranet Overview 3
|
Figure 1 The 4-tier Architecture of Infranet
TIBCO Adapter for Infranet User’s Guide
4
| Concepts
Adapter Overview
TIBCO Adapter for Infranet allows enterprise systems to integrate with Infranet.
The adapter mediates between Infranet and the TIBCO environment, allowing
external applications to send and receive messages to and from Infranet.
The adapter maintains data integrity in both directions, and integrates other
software in the TIBCO environment seamlessly into an enterprise.
Components
The Adapter has the following components:
•
Core adapter application This is the run-time adapter application.
•
Infranet Adapter Configuration Palette This is an adapter specific
configuration tool that is packaged with the adapter and loaded in TIBCO
Designer. It presents an intuitive Graphical User Interface (GUI) that enables
you to configure the adapter.
•
EAI Plug-in for Infranet EAI Framework This is a plug-in connector
application built for Infranet EAI Manager Framework to provide access to
Infranet event data for enterprise applications.
•
Infranet Data Manager This is a custom Data Manager for Infranet that helps
Infranet client applications to invoke RPC operations on enterprise
applications.
This book explains the use of the adapter and its configuration using TIBCO
Designer. TIBCO Designer is a configuration tool that provides a standardized
means to configure all TIBCO adapters.
TIBCO Adapter for Infranet User’s Guide
Adapter Features 5
|
Adapter Features
The following features are described in detail throughout this manual.
•
Support for Infranet 7.3 This release adds support for Infranet 7.3.
•
Support for Infranet 7.0 and Infranet 6.7 This release adds support for Infranet
7.0 on all platforms supported by the adapter. The adapter also adds support
for Infranet 6.7 on Solaris and HP-UX platforms.
•
Support for Request-Response Invocation Service The adapter now supports
Request-Response Invocation Service on all platforms.
•
Connection Management The adapter now supports connection management.
The adapter attempts to reconnect to the server based on the reconnection
parameters specified at the time of configuration.
•
Support for PCM Java API Reference The adapter now supports the PCM Java
API reference.
•
Enhanced Infranet Opcode and Event Import The adapter now supports loading
of Opcodes and Events automatically from a location specified during
configuration. The feature of importing the Opcodes and Events is provided
at the instance level.
•
Support for Multiple Operations for the Request-Response Service The adapter
now allows specifying multiple operations instead of Tasks for the
Request-Response Service.
•
Transaction Support for Request-Response Service The adapter now provides
Transaction support for the Request-Response Service. The adapter allows
configuring multiple operations for invoking multiple Opcodes. You can
specify B E G I N , E N D or R O L L B A C K flag for each service request to manage a
transaction and invoke them sequentially using TIBCO Business Works.
•
Support for Specifying Values for Opcode Flags The adapter now supports
specifying values for Opcode flags in TIBCO Designer. This is applicable to
the Subscription and Request-Response Services.
•
Support for TIBCO BusinessWorks BusinessWorks is a scalable, extensible, and
easy to use integration platform that allows you to develop, deploy, and run
integration projects. A TIBCO BusinessWorks project integrates enterprise
applications with TIBCO adapters and automates business processes.
•
Support Fault Tolerance The adapter supports fault tolerance.
•
Multi-lingual Support The adapter supports U T F - 8 for all its supported
services.
TIBCO Adapter for Infranet User’s Guide
6
| Concepts
•
Easy to use GUI or configuring and maintaining the adapter. Using TIBCO
Designer you can quickly specify operational parameters and change them as
needed.
•
Load Balancing The adapter can run multiple Subscription services and
Request-Response services in a distributed queue, resulting in load balancing.
•
Delayed Acknowledgement The adapter supports delayed acknowledgement
for the Subscription service and Request-Response service, for certified
messaging. It sends an acknowledgement of receipt of a message to the
Publisher only after the message is processed successfully by Infranet.
•
Tracking Facility The adapter incorporates the ‘Tracking Info’ functionality of
the TIBCO Adapter SDK. Tracking:
— Provides end-to-end traceability of business documents in case of errors or
processing that hangs.
— Helps identify the source of a business document through all the
components in a given process.
•
Exception handling is supported at both the adapter and Infranet levels. If the
request contains a reply subject, the error is sent back to the requestor. If the
request does not contain a reply subject, the error is logged into the sink using
the tracing mechanism.
•
Adapter Services The adapter provides Publication, Subscription,
Request-Response and Request-Response Invocation services. Basic
configuration templates are provided in TIBCO Designer, which you can use
to configure adapters and services to control your enterprise’s data. The
services are described in detail in the next section.
•
Multithreading The adapter supports a static number of threads. The number
of threads is specified at the time of configuration. The number of connections
to the application server equals the number of threads. With multiple threads,
the adapter processes multiple messages concurrently.
•
Support for TIBCO Rendezvous and TIBCO Enterprise Message Service (Java
Message Service) Support for multiple message transports.
•
Enhanced Time-out Management The adapter now supports Enhanced
Time-out Management. The adapter will stop the ongoing operation if there is
no response from the Infranet server within a specified period of time. The
time-out parameter is specified at the configuration time. This functionality is
available for the Subscription and the Request-Response service.
TIBCO Adapter for Infranet User’s Guide
Adapter Capabilities 7
|
Adapter Capabilities
This section describes in detail how the TIBCO Adapter for Infranet handles each
of the following:
•
Message Transports
•
Multithreading
•
Connection Management
•
Transaction Handling
•
Internationalization
•
Enhanced Time-out Management
Message Transports
TIBCO Rendezvous or TIBCO Enterprise Message Service can be used to
transport messages to and from the adapter.
•
TIBCO Rendezvous supports the following quality of services:
— Reliable (RV) — This ensures that each multicast or broadcast message is
received as long as the physical network and packet recipients are working,
and the loss of a message is detected.
— Certified-delivery (RVCM) — Ensures at least once delivery of messages.
This guarantees that every certified message reaches its intended recipient
in the order sent.
— Distributed Queue (RVCMQ) — This is designed to deliver a message to
one-of-many Subscription services. It has incorporated the features of both
Certified Messaging and Fault Tolerance.
•
TIBCO Enterprise Message Service supports the following connection types:
— Queue — Queue messaging has one sender and one receiver per message.
The receiver receives the message whether or not the receiver is active at
the time the message is sent.
— Topic — In a Topic message system, senders address messages to a topic.
Many senders can publish on a single topic, and a single sender can publish
to many receivers. Receivers subscribe to topics, and receive messages on
those topics.
TIBCO Adapter for Infranet User’s Guide
8
| Concepts
Multithreading
Multithreaded instance of an adapter will generate additional threads to dispatch
events for a given transport session. The number of additional threads to be
created for a given transport session can be specified at design-time and these are
created during startup. The default thread will dispatch events for all the
transport sessions present in the adapter instance.
Subscription and Request-Response services configured in an adapter instance
can be multithreaded by specifying the required number of additional threads for
the transport sessions which they are associated with.
Event dispatching for the Publication Service gets triggered when the
EAIDMSubscriber component of the adapter receives messages from Infranet
EAIFramework Manager. EAIDMSubscriber endpoint is associated with an
exclusive TIBCO Rendezvous transport session named RVAgentSession. The
publication services configured in an adapter instance can be multithreaded by
configuring additional threads for RVAgentSession.
Event dispatching for Request-response invocation service gets triggered when
the AdinfraCustomDMSubscriber component of the adapter receives messages
from custom Infranet Data Manager for the adapter. AdinfraCustomDM endpoint
is associated with an exclusive TIBCO Rendezvous transport session named
RVAgentSession. The Request-Response Invocation services configured in an
adapter instance can be multithreaded by configuring additional threads for
RVAgentSession.
The adapter creates a connection with target application prior to processing
Opcodes configured for Subscription and Request-Response services. The real
advantage of parallel processing in multithreaded mode can be achieved only
when multiple connections are created with target application.
Connection Management
This section explains the feature of Connection Management. Connection
Management comprises of Connection Pooling and Reconnection Mechanism.
Connection Pooling
The adapter creates a static pool of connections with Infranet Connection
Manager during startup. The number of connections to be maintained in the pool
can be specified at design-time.
Upon receiving Subscription or Request-Response requests, the adapter thread
checks if there are any free connections available in the connection pool. If there
are free connections available, it will pick up the first free connection available in
the pool, process the message and place the connection back in the pool.
TIBCO Adapter for Infranet User’s Guide
Adapter Capabilities 9
|
If there are no free connections available in the pool, the adapter waits until a
connection becomes available in the pool.
Reconnection Mechanism
While processing the message using Subscription or Request-Response service if
there is a connection error with Infranet, the adapter starts the reconnection
mechanism.
For the Subscription Service, when the adapter detects a connection error while
executing a request, Connection Retry mechanism is started in R E T R Y I N G mode. In
R E T R Y I N G mode, the adapter attempts to reconnect to the system for a fixed
number of times with a fixed time difference between each retry attempt. The
retry interval time, the number of retries before suspending the listeners and the
maximum number of retries can be configured during design-time. If the Infranet
Server comes up during this period, the connection queue is emptied and is
refilled with a new connection to Infranet. All the events waiting for processing
will be executed.
If the connection retry fails after a specified number attempts the connection retry
mechanism will enter the P O L L I N G mode. During the polling mode the
subscription event is not confirmed, and all the Subscription Services in the
adapter are suspended.
The listeners are suspended so that no events are received during this period. If
the connection retry is successful during the P O L L I N G period, suspended
subscribers will be activated so that the adapter starts processing the message.
If the connection retry fails even after the total number of attempts, the adapter
will be terminated. If the total number of connection retry value is set to -1, the
adapter will try to connect to the Infranet system for infinite number of attempts.
For the Request-Response Service, the adapter checks if the event execution failed
due to connection failure. If the connectivity is lost, the adapter starts the
connection retry mechanism and will then send an error message to the sender
(TIBCO BusinessWorks process). All the requests that are sent to the adapter
when it is in connection retry mode will be replied with the connection error
message.
Since no definite error is thrown from Infranet in case of connection issues, you
must configure the connection related errors. The adapter starts the reconnection
mechanism only if the configured error occurs.
TIBCO Adapter for Infranet User’s Guide
10
| Concepts
Transaction Handling
Transaction in Infranet is similar to any other transaction supported by various
other applications. Using this feature, multiple operations with Infranet can be
carried out in Transaction mode. Before executing an operation in transaction
mode, a transaction needs to be opened with Infranet. After executing an INSERT
or UPDATE operation, the transaction can either be committed or rolled back
based on business requirement.
For details on transaction handling, refer to Configuring Advanced Settings on
page 125.
Internationalization
See the TIBCO Adapter Concepts book for an introduction to Internationalization
topics such as Unicode and how adapters handle it. See General Tab on page 70 of
this guide for setting encoding options for an adapter instance.
You must take these steps prior to running the TIBCO Adapter for Infranet in
Unicode mode.
1. Make sure that the appropriate locales exist and are valid on your operating
system. To verify, do the following.
For Microsoft Windows, verify registry entries under
\\HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\Control\Nls\Codepage
2. Copy the locale files for the relevant code page to the appropriate directory.
For Microsoft Windows, this would be the W I N D O W S \ s y s t e m 3 2 directory.
3. When configuring the adapter, be sure to specify the appropriate locale
Adapter Encoding field, under the General tab for the adapter instance. If this
is not done, character data will not be processed correctly by the adapter.
— For Microsoft Windows, an input locale must exist on the operating system
and the correct code page file must exist under the \ W I N D O W S \ s y s t e m 3 2
directory. To view the possible set of input locales, refer to the Regional
Setting Properties available from the Control Panel.
— For Solaris 8 and 9, verify locale files under the / u s r / l i b / l o c a l e
directory.
— For HP-UX 11.0, the locale specified must exist in the
/ u s r / l i b / n l s / l o c / l o c a l e s directory.
TIBCO Adapter for Infranet User’s Guide
Adapter Capabilities 11
|
Enhanced Time-out Management
The Infranet adapter processes requests in a synchronous mode. In other words, it
waits for a response from the Infranet server before sending the next request.
Therefore, if there is an error on the Infranet server, the adapter will have to wait
indefinitely. To prevent this problem, time-out value should be set during
design-time. When configuring an adapter instance, you can specify a certain
period of time for which the adapter waits for the response. If there is no response
from the Infranet server within the specified period of time, the time-out error
will be thrown out and the adapter will stop the ongoing operation.
Enhanced Time-out Management is available for the Subscription and the
Request-Response service. While running each of the two services, the adapter
calls Infranet Opcodes to perform the business operations. Once the duration of
any operation is longer than the specified time-out value, the error will be caught
by the Infranet server and sent to the adapter. When the adapter receives this
error message, it stops the ongoing operation.
The Enhanced Time-out Management feature will be available only if using
Infranet 7.3 with the patch 5835756.
TIBCO Adapter for Infranet User’s Guide
12
| Concepts
Adapter Services
In TIBCO terminology, an adapter offers services to the host application and to the
TIBCO environment. A service broadly encapsulates routing rules for messages
handled by the service and also custom configuration information.
This section describes the Publication, Subscription, Request-Response and
Request-Response Invocation Services of the adapter in more detail.
Figure 2 Adapter Services
Key configuration activities need to be carried out on the adapter. These are
configured using TIBCO Designer graphical user interface (GUI). Specify the
parameters that are associated with each adapter instance.
Publication Service
This service is used by the Infranet system to communicate with an external
application.
Adapter publication service consists of the following components:
•
EAIPlugin which is a plug-in connector application for Infranet EAI Manager.
It is implemented as a shared library that is loaded by the EAI Manager
during start up. The EAI Manager calls the appropriate methods from
EAIPlugin to publish Business Events. EAIPlugin uses TIBCO Rendezvous
client APIs to publish the Business Events to TIBCO Rendezvous.
•
EAIDM Subscriber that subscribes to Business Events published by
EAIManager through the EAIPlugin.
•
Publisher component that formats and publishes the Business Event data to
TIBCO Active Enterprise.
TIBCO Adapter for Infranet User’s Guide
Adapter Services 13
|
TIBCO Designer allows you to configure publication service for Infranet business
events of interest. The events to be published to the external application must be
registered with the EAI Manager. When a registered event occurs in Infranet, the
EAI Framework Plug-in captures and publishes the event data to TIBCO
Rendezvous in Infranet FLIST format. The adapter EAIDM Subscriber subscribes
to these events from the TIBCO environment and converts the event data from
FLIST format to ActiveEnterprise format or XML format. Thereafter, the adapter
publishes it to the TIBCO environment.
Figure 3 Publication Service Workflow
Subscription Service
The Subscription Service receives messages from the TIBCO environment and
calls Infranet Opcodes to perform business operations in the Infranet system. The
adapter subscribes to events of interest to Infranet. Upon receiving a message, the
adapter converts the external data to an Infranet FLIST and calls corresponding
Opcodes to post data.
If the message contains a reply subject, then the output FLIST of the Opcode will
be returned to the initial sender. TIBCO Designer allows you to configure
Subscription Service for invoking Infranet Opcodes.
If certified messaging is used, delayed acknowledgement is available for the
Subscription Service. After a message is received, the adapter will send an
acknowledgement to the external application only after the message has been
processed successfully by Infranet.
TIBCO Adapter for Infranet User’s Guide
14
| Concepts
Figure 4 Subscription Service Flow
If certified messaging is used, delayed acknowledgement is available in the
Subscriber service. After a message is received, the adapter will send an
acknowledgement to the publisher only after the message has been processed
successfully by the Infranet system.
Request-Response Service
This service is used by clients to invoke a request-response operation. External
applications can send requests to Infranet to execute an Opcode.
When the adapter receives these requests from the TIBCO environment, it
converts the external data to an Infranet FLIST and calls corresponding Opcodes
to execute the required business function. When a response is returned to the
adapter from the Infranet system, the results are sent back to the requesting
application through the TIBCO environment. TIBCO Designer allows user to
configure Request-response operations for invoking Infranet Opcodes. Multiple
operations can be configured with a single request-response service.
If certified messaging is used, delayed acknowledgement is available for the
Request-Response Service. After a message is received, the adapter will send an
acknowledgement to the external application only after the message has been
processed successfully by Infranet.
TIBCO Adapter for Infranet User’s Guide
Adapter Services 15
|
Figure 5 Request-Response Service Workflow
Request-Response Invocation Service
This type of service is used by Infranet to invoke a Request-Response invocation
operation on external applications. The Request-Response Invocation service
consists of the following components:
•
Adinfra Custom Data Manager that connects Infranet Connection Manager
to TIBCO Active Enterprise. Deploying the Custom Data Manager provided
by the adapter in the Infranet System allows Infranet client applications to
invoke Opcodes that would be routed to the adapter's Request-Response
Invocation client through TIBCO Rendezvous.
•
AdinfraCustomDM Subscriber that subscribes to requests from the custom
Data Manager. The adinfraCustomDM Subscriber is created dynamically
during run-time.
•
Request-Response Invocation Client that sends out the Request-Response
Invocation request to TIBCO environment.
When the external application receives these requests from the adapter through
TIBCO environment, it responds with the relevant reply message. When a
response is returned to the adapter from the external application, the results are
sent back to the Infranet Custom Data Manager.
TIBCO Adapter for Infranet User’s Guide
16
| Concepts
Figure 6 Request-Response Invocation Service Workflow
TIBCO Adapter for Infranet User’s Guide
Adapter and Infranet Interaction 17
|
Adapter and Infranet Interaction
Upon receiving a request from Infranet, the adapter executes Infranet APIs, called
Opcode(s), associated with the request to access the Infranet data. The result of
the Opcode is returned to the requestor. The adapter can be configured to publish
an Infranet event to the TIBCO environment.
Figure 7 Logical Architecture for Integration with the Infranet System
The following diagram shows the main components of the adapter and how the
adapter interacts with an Infranet system components to integrate external
applications with it through the TIBCO environment.
TIBCO Adapter for Infranet User’s Guide
18
| Concepts
Figure 8 Adapter and Infranet System Integration
TIBCO Adapter for Infranet User’s Guide
| 19
Chapter 2
Installation
This chapter describes how to install TIBCO Adapter for Infranet on Microsoft
Windows and UNIX systems.
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. Please see Table 3 on page 31 and Table 4 on page 35 for the
availability of this software version on a specific operating system platform.
Topics
•
Preparing your Environment for Installation, page 20
•
Pre-Installation Worksheet, page 22
•
Installer Overview, page 25
•
Installation Registry, page 27
•
Adapter Components and Compatible Software, page 29
•
Installation on Microsoft Windows Systems, page 31
•
Installation on UNIX Systems, page 35
•
Post Installation, page 39
•
Installer FAQs and Troubleshooting, page 40
TIBCO Adapter for Infranet User’s Guide
20
| Installation
Preparing your Environment for Installation
The most time-consuming part of an adapter installation is the collection of
environment information and parameters. This section helps you complete this
process. It provides a checklist of parameters you should obtain from various
system administrators within your organization before installing the adapter.
Note that obtaining an Infranet account can take some time depending on your
corporate policies — so plan in advance!
Operating System Requirements
Obtain the following information from the administrator of the machine on which
you plan to install the adapter:
•
On Microsoft Windows, administrator privileges are required to install.
•
On UNIX systems, you can install as r o o t or a regular user. See Installer
Account on page 36 for details.
•
Note that the TIBCO Runtime Agent (TRA) must be installed prior to
installing the adapter and the adapter installation always places files under
the TIBCO r o o t directory that was set when the TRA was installed.
There should be enough space on that disk or partition to install the adapter. The
adapter needs space in your temp area and the directory where it is installed.
•
See Installation Registry on page 27 for details about temp folder space
requirements on Microsoft Windows and UNIX systems.
•
See Table 3 on page 31 for Microsoft Windows installations.
•
See Table 4 on page 35 for Unix System installations.
You must have write permissions to these directories to install the adapter. In
addition, on UNIX systems certain other permissions must be set to run the
adapter. See Permission Requirements on page 39 for details.
•
To run the adapter you must have permissions to access the project
(repository) where adapter configuration is stored.
•
Depending on whether TIBCO Administrator is used to set access
permissions, you may need an account identified by Administrator. See the
TIBCO Administrator User’s Guide for details.
Determine how the adapter installation files are to be transferred to this system.
The installation files can be downloaded from download.tibco.com (if you have
an account setup to download).
TIBCO Adapter for Infranet User’s Guide
Preparing your Environment for Installation 21
|
Infranet Requirements
Determine which Infranet versions are supported.
•
See Supported Applications on page 31 for Microsoft Windows.
•
See Supported Applications on page 35 for UNIX systems.
TIBCO Adapter for Infranet User’s Guide
22
| Installation
Pre-Installation Worksheet
Use this form to capture the information you will need to collect before starting
installing the TIBCO Adapter for Infranet.
Adapter Machine Information
Field Name
Field Description
Hostname
Name of the machine on which the
adapter is being installed.
(Example:
adapter1.tibco.com)
IP address
(Example: 192.168.12.12)
User account
(Example: administrator)
User domain (if Windows)
(Example: ENGR2)
User password
IP address of the machine on which
the adapter is being installed.
User account to be used for the
installation.
Network domain to which the user
belongs.
User Password
Disk and path on which to
install adapter
(Example: /opt/tibco)
How will the machine be
accessed
[ ] directly [ ] terminal server [ ] xterm
[ ] telnet
[ ] other: ………………………
How will installation files be
transferred to the machine
TIBCO Adapter for Infranet User’s Guide
[ ] CD-drive [ ] internet download
[ ] FTP to machine [ ] network disk
mounting
Field Value
Pre-Installation Worksheet 23
|
Server Information
Field Name
Field Description
Hostname:
Name of the machine on which the
connection manager is running.
(Example: athps5)
Port Number:
Field Value
The Infranet connection manager port.
(Example: 8080)
Infranet User Information
Obtain the following information for the account you will use to access the
Infranet Application.
Field Name
Field Description
Username:
Valid Infranet User ID to logon to
Infranet
(Example: athps5)
Password:
Field Value
Password to logon to Infranet
(Example: Infranet)
Infranet Client Software
Please specify where software for the Infranet client can be found within your
organization:
[ ] It's already installed on adapter machine.
Location on disk: ………………………….
[ ] Installation files are available via:
FTP (Server : ………… User : ………… Password: ……… )
Disk mount (full path : ………………………………………..)
CD provided during install by (name/extension) : ………………………..
It is not mandatory to have an Infranet client for running the adapter.
TIBCO Adapter for Infranet User’s Guide
24
| Installation
Infranet Software Required before installing the Adapter
The Infranet component given below need to be installed on the machine you
intend to install the adapter. This component is required for running the adapter.
•
pcm.jar
•
pcmext.jar
TIBCO Adapter for Infranet User’s Guide
Installer Overview 25
|
Installer Overview
The installer allows you to run in different modes. Each mode is supported on all
platforms.
•
GUI mode
•
Console mode
•
Silent mode
GUI Mode
In GUI mode, the installer presents panels that allow you to make choices about
product selection, product location, and so on. You can invoke the installer by
clicking on the executable.
Console Mode
Console mode allows you to run the installer from the command line or terminal
window. This is useful if your machine does not have a GUI environment.
Silent Mode
Silent mode either installs using default settings or uses a response file that was
saved during an earlier installation. Silent mode installs without prompting you
for information.
•
If no response file has been recorded earlier and you invoke the installer with
the - s i l e n t argument, the default installation parameters are used.
•
If a response file exists, and the installer is started with - o p t i o n s
< r e s p o n s e F i l e N a m e > as an argument, the installer uses the values specified
by the user when the response file was generated.
Upgrading the Adapter
Software from TIBCO uses three numbers to indicate whether the release is major,
minor or a patch. For example, 5.0.0 indicates a major release, 5.1.0 indicate a
minor release and 5.1.1 indicates a patch release. The installer for a patch release
performs an automatic upgrade. For example, the installer automatically
upgrades TRA 5.0.0 to 5.0.1 by overwriting the contents of the 5.0 directory.
TIBCO Adapter for Infranet User’s Guide
26
| Installation
For a major and minor release, the installer prompts whether you wish to
upgrade, and informs you if incompatible products are on your system. If you
proceed, major or minor releases are installed under a new directory that is
named using the major or minor release numbers.
For example, if you have installed the 5.1.2 release and are upgrading to a 5.2.0
minor release, it will be installed under the 5.2 directory. This allows both the 5.1
and 5.2 releases to coexist on the same machine.
If you are upgrading the adapter, or reinstalling a clean version of the software,
you may uninstall the product first or allow the installer to perform the upgrade
or reinstall.
Note that, if you are reinstalling over the same adapter version:
•
You are not prompted to supply the installation location. The software is
automatically reinstalled where the previous version was installed.
•
If any files are currently locked (that is, in use), the installer marks the file for
deletion in the install location. After installation, the installer prompts you to
reboot your system. You must reboot before using the software.
Uninstalling the Adapter
The TIBCO Installation Manager (TIM) allows you to:
•
Display installed products
•
Display product components
•
Display product dependencies and references
•
Uninstall products and all references
To start the program:
•
On Microsoft Windows:
Click Start>TIBCO>TIBCO Installation Manager
•
On Unix:
<install-path>/ t i b c o / T i b c o I n s t a l l a t i o n M a n a g e r . b i n
The TIBCO Installation Manager displays all TIBCO software installed on your
machine. Details about the selected TIBCO product are displayed in the right
rows. Click the U n i n s t a l l button to remove the selected product. Note that some
products cannot be installed from the utility. Instructions about uninstalling these
products are listed in the uninstall window (after clicking the U n i n s t a l l button).
Click the TIBCO Installation Manager help button for information about using the
program.
TIBCO Adapter for Infranet User’s Guide
Installation Registry 27
|
Installation Registry
The installer maintains an installation registry. The registry location depends on
the platform. This section explains where the registry files are located. The files
have vpd as a prefix, which stands for Vital Product Database. Note that the
installer does not recognize TIBCO ActiveEnterprise 4.x products.
Do not edit, modify, rename, move, or remove any of the four registry vpd files.
Microsoft Windows Platforms
ActiveEnterprise 5.1 products maintain the installation registry in the
S y s t e m D r i v e : \ W I N D O W S folder. The following files represent the installation
registry:
SystemDrive:\WINDOWS\vpd.properties
SystemDrive:\WINDOWS\vpd.properties.tibco.systemName
Installer Disk Space Requirements in Temporary Area
The entire package is extracted into a temp folder, typically S y s t e m D r i v e : \ T e m p
or S y s t e m D r i v e : \ D o c u m e n t s a n d S e t t i n g s \ < u s e r _ n a m e > \ L o c a l
Settings\Temp.
The installer requires 30 MB of free space in the temp directory.
UNIX Platforms
If installation is performed by a regular user (non-r o o t ), the installation registry
is maintained in the following files in the user's home directory:
User_Home_Directory/vpd.properties
User_Home_Directory/vpd.properties.tibco.systemName
If installation is performed by the super-user (root), the installation registry is
maintained as follows:
•
On Solaris and HP-UX, in the root user’s home directory (which is /) has two
vpd files.
TIBCO Adapter for Infranet User’s Guide
28
| Installation
Installer Disk Space Requirements in Temporary Area
The installer launcher first extracts a Java Virtual Machine (JVM) in a temporary
directory and uses this JVM to launch itself. The size of the extracted JVM differs
from platform to platform.
On UNIX platforms the following disk space is required in the temporary area:
•
On Solaris, 30 MB of free disk space in / v a r / t m p
•
On HP-UX, 190 MB of free disk space in / v a r / t m p
If your system does not have sufficient free disk space in the above temporary
area, you can still run the installer with a different temporary area by using the
following option when starting the installer:
TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -is:tempdir /new_tmp
where / n e w _ t m p has sufficient free disk space.
Disk Space Requirement in User's Home Directory
On UNIX platforms when a regular (non-root) user installs a TIBCO 5.4 product,
the installation registry (two vpd files) is maintained in the user's home directory.
As more products are installed, entries are added into these vpd files.
The user's home directory must at least have 500 KB of free disk space.
Installation History
The installer and uninstaller create a file called T I B C O I n s t a l l a t i o n H i s t o r y . x m l
in the same location where the installation registry is created. Each time an
installation and uninstallation is performed, entries are appended to the file.
On Microsoft Windows:
SystemDrive:\WINDOWS\TIBCOInstallationHistory.xml
On Unix: U s e r s _ H o m e _ D i r e c t o r y / T I B C O I n s t a l l a t i o n H i s t o r y . x m l
The file T I B C O I n s t a l l a t i o n H i s t o r y . x m l therefore contains the record of all
installation and uninstallation activities of all products, features and components.
Do not edit, modify, rename, move, or remove the
T I B C O I n s t a l l a t i o n H i s t o r y . x m l file.
TIBCO Adapter for Infranet User’s Guide
Adapter Components and Compatible Software 29
|
Adapter Components and Compatible Software
You can install different adapter components on different machines. For example,
you can run the runtime adapter on one machine and install the design-time
components on another machine. This allows you to configure an adapter on one
machine and run it on another.
Adapter Components
Table 1 describes the adapter components on the adapter installation package.
Table 1 TIBCO Adapter components
Component
Run-time
adapter
This process does the actual work of passing and converting data to and from
Infranet. Parameters of data exchanges are stored in projects created using the
adapter palette and the design-time adapter (see below).
Adapter
palette
Adapter-specific GUI that is loaded in TIBCO Designer (see next section for
details) at configuration time.
EAI Plug-in for
Infranet EAI
Framework
This is a plug-in connector application built for Infranet EAI Manager Framework
to provide access to Infranet event data for enterprise applications.
Infranet Data
Manager
This is a custom Data Manager for Infranet that helps Infranet client applications
to invoke RPC operations on enterprise applications.
Required and Optional TIBCO Products
Depending on the tasks you wish to perform, you must install one or more other
TIBCO products. The next table describes required and optional products and
their purpose. For the supported version of the following products, refer to
TIBCO Adapter for Infranet readme.txt.
TIBCO Adapter for Infranet User’s Guide
30
| Installation
Table 2 Required and Optional TIBCO Products
Component
Purpose
TIBCO Runtime Agent
Required. TIBCO Runtime Agent supplies a number of TIBCO and
third-party libraries used by the adapter and other TIBCO products both
at design-time and runtime. This includes RVD libraries, SDK libraries
etc. For example, m a v e r i c k 5 0 . d l l .
You must install TIBCO Runtime Agent on each machine that hosts an
adapter. TIBCO Runtime Agent must be installed before you install the
adapter.
TIBCO Administrator
Required. TIBCO Administrator includes the following modules:
•
User Management. Management of authentication, roles and users,
that is, connecting roles (groups) and users to access control lists
(ACLs). This includes security for server-based projects at
design-time and for deployed applications at runtime.
•
Resource Management. Monitoring of machines and of all running
applications in a TIBCO administration domain. Alerts can be
created, for example, to notify an administrator if the number of
processes or disk usage exceeds a certain number.
•
Application Management. Uploading of Enterprise Archive (EAR)
files, creation, configuration, deployment, and monitoring of
applications. This console is also used to start and stop applications.
TIBCO Administrator is available as a separate installation and can be
installed after installing the adapter.
TIBCO BusinessWorks
Optional. TIBCO BusinessWorks is a scalable, extensible, and easy to use
integration platform that allows you to develop integration projects.
TIBCO Adapters are typically part of integration projects created using
BusinessWorks.
TIBCO BusinessWorks is available as a separate installation and can be
installed after installing the adapter.
TIBCO Adapter for Infranet User’s Guide
Installation on Microsoft Windows Systems 31
|
Installation on Microsoft Windows Systems
Before starting the installation procedure, review the topics in this section to
determine that your system meets the basic requirements and that you have the
prerequisite software installed.
Memory requirement for the adapter installation is around 256 MB.
The following is a list of prerequisites for installing the adapter on Microsoft
Windows systems. See Installer Disk Space Requirements in Temporary Area on
page 27 for additional disk space requirements.
The following table lists the platform-specific installation packages, where
<version_num> is the Adapter release number. For example, the installation
package name for the TIBCO Adapter for Infranet 5.2.0 on the Microsoft Windows
XP platform is T I B _ a d i n f r a - s i m p l e _ 5 . 2 . 0 _ w i n _ x 8 6 . e x e
Table 3 Supported platforms, package names and disk space for Microsoft Windows
Platform
Package Names
Hardware
Platform
Disk
Space
(MB)
Microsoft
Windows 2000
TIB_adinfra-simple_<vers
x86
32 MB
Microsoft
Windows XP
TIB_adinfra-simple_<vers
x86
32 MB
ion_num>_win_x86.exe
ion_num>_win_x86.exe
Supported Applications
Before proceeding to adapter installation, ensure you can connect to the target
application.
The adapter works with the following:
•
Infranet 7.0
•
Infranet 7.2
•
Infranet 7.3
TIBCO Runtime Agent Must be Installed Before the Adapter
Before you can install the adapter, you must install TRA. If you choose the Typical
installation mode for TRA, the installer places all libraries and other products
required by the adapter into the TIBCO HOME directory.
TIBCO Adapter for Infranet User’s Guide
32
| Installation
During installation, the adapter installer checks for the availability of all required
products in the system. If any of these are not available, the installer does not
proceed with the installation.
Installer Account
You must have administrator privileges for the machine on which the adapter is
installed.
If you do not have administrator privileges, the installer will exit. You must then
log out of the system and log in as a user with the required privileges, or request
your system administrator to assign the privileges to your account.
Installing from Network Drive
If you intend to install the product on a network drive, you must ensure that the
account used for installation has permission to access the network drive.
Installing on Microsoft Windows 2000 and 2003 Terminal Server
There are two modes in Microsoft Windows Terminal Server: Execute and Install.
Users are logged on by default in Execute mode, which allows them to run
applications. To install an adapter so that everyone can use it, log on as
administrator in Install mode. When the adapter is installed in the Install mode,
the installation registry is maintained in S y s t e m D r i v e : \ W I N D O W S \ .
Microsoft Windows Terminal Server must be running in remote admin mode, not
application sharing mode. The adapter is not supported if installed on a machine
that is using Microsoft Windows Terminal Server in application sharing mode.
The best way to install the adapter on Microsoft Windows Terminal Server is to
use the Add/Remove Programs control panel applet. This automatically sets your
mode to Install during the installation and then back to Execute afterwards.
Alternatively, you can manually change your mode to Install before starting the
installation by typing the following at a command prompt:
C:\> change user /install
Change back to Execute mode after installation is complete by typing:
C:\> change user /execute
To check your current mode, type the following:
C:\> change user /query
TIBCO Adapter for Infranet User’s Guide
Installation on Microsoft Windows Systems 33
|
Installing the Adapter on Microsoft Windows
You can either download the adapter package or install the package from a CD.
The installer prompts you to accept the license agreement. Then you can choose to
perform a typical install or custom install.
•
A typical install has minimal prompts and installs standard components in
default locations.
•
A custom install prompts you to choose which components of the product
suite to install and installs only those components.
The installer checks your system for the installation home directory that was
established when TIBCO Runtime Agent was installed. The adapter is installed
under the installation home directory.
Use one of the following modes to install the software.
Install Using GUI Mode
GUI Mode allows you to input values in panels. Double-click the following
executable:
TIB_adinfra-simple_5.2.0_win_x86.exe
Install Using Console Mode
Console mode allows you to install the software from a command line. The
installer will prompt you for values. Type the following at the command prompt:
TIB_adinfra-simple_5.2.0_win_x86.exe -is:javaconsole -console
When running in console mode you can move through the installation process as
described next:
Enter Key or 1 = Moves forward in the installer
2 = Goes back to previous screen
3 = Cancels the Wizard and exits the installation or uninstallation
4 = Redisplays the current screen
Install Using Silent Mode
Silent mode allows you to install the software without prompts. Follow these
steps to install using silent mode.
1. Type the following at the command prompt:
TIB_adinfra-simple_5.2.0_win_x86.exe -silent
2. Go to the < T I B C O _ H O M E > \ a d a p t e r \ a d i n f r a \ 5 . 2 \ b i n
folder.
TIBCO Adapter for Infranet User’s Guide
34
| Installation
3. Open the adinfra.tra file to specify the location of pcm.jar and pcmext.jar. For
example:
tibco.env.CUSTOM_CP_EXT C:/tibco/adapter/adinfra/5.2/pcmjar
Install Using a Response File
You can use a previously generated response file for installation. For non-silent
modes, the response file determine the defaults that are presented. For silent
mode, the response file determines what will be installed.
To install using a response file, type the following at the command prompt:
TIB_adinfra-simple_5.2.0_win_x86.exe -options
C:\directory\<responseFileName>
Generate a Template File
You can generate a template file without installing the adapter. The template file
is similar to a response file, but the values are not filled in. You can edit the
template file to generate a response file.
To generate a template file, type the following at the command prompt:
TIB_adinfra-simple_5.2.0_win_x86.exe -options-template
C:\directory\< templateFile>
Combining Options
You can combine the different available options. For example, to install in silent
mode using a response file, use:
TIB_adinfra-simple_5.2.0_win_x86.exe -silent -options
<responseFileName>
To install using Console mode and generate a response file, use:
TIB_adinfra-simple_5.2.0_win_x86.exe -is:javaconsole -console
-options-record <responseFileName>
TIBCO Adapter for Infranet User’s Guide
Installation on UNIX Systems 35
|
Installation on UNIX Systems
Your operating system must meet the minimum patch requirements listed next.
See Installer Disk Space Requirements in Temporary Area on page 28 for
additional disk space requirements.
The following table also lists the platform-specific installation packages, where
<version_num> is the Adapter release number. For example, the installation
package name for the TIBCO Adapter for Infranet 5.2.0 on the Solaris 8 is
TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin
Table 4 Supported platforms, package names, patches and disk space for UNIX systems
Hardware
Platform
Disk
Space
(MB)
TIB_adinfra-simple_<versi
on_number>_sol8_sparc_jav
a.bin
SPARC
60 MB
Solaris 9
TIB_adinfra-simple_<versi
on_number>_sol8_sparc_jav
a.bin
SPARC
60 MB
HP-UX 11.x
TIB_adinfra-simple_<versi
on_number>_hpux111_hppa_j
ava.bin
PA-RISC
116 MB
HP-UX 11i
TIB_adinfra-simple_<versi
on_number>_hpux111_hppa_j
ava.bin
PA-RISC
116 MB
HP-UX 11i
v2/11.23
TIB_adinfra-simple_<versi
on_number>_hpux112_ia64_j
ava.bin
IA64
116 MB
Platform
Package Names
Solaris 8
Minimum Patch(es)
Supported Applications
Before proceeding to adapter installation, ensure you can connect to the target
application.
The adapter works with the following:
•
Infranet 6.7
•
Infranet 7.0
•
Infranet 7.2
•
Infranet 7.3
TIBCO Adapter for Infranet User’s Guide
36
| Installation
TIBCO Runtime Agent Must be Installed Before the Adapter
Before you can install the adapter, you must install TRA. If you choose the Typical
installation mode for TRA, the installer places all libraries and other products
required by the adapter into the TIBCO HOME directory.
During installation, the adapter installer checks for the availability of all required
products in the system. If any of these are not available, the installer does not
proceed with the installation.
Installer Account
TIBCO 5.x products can be installed by a regular (non-root) user and super-user
(root). Different users can install the same product at different locations.
Product dependencies at install time are resolved at the user level through the
installation registry maintained in the user's home directory. See Installation
Registry on page 27 for more information.
Microsoft Windows Environment
A window environment such as CDE (i.e. X Windows) is required to run the
installer in GUI mode. It is not required for a console mode installation.
Installing the Adapter on UNIX
After running the software and accepting the license agreement, you can choose
to perform a typical install or custom install.
•
A typical install has minimal prompts and installs standard components in
default locations.
•
A custom install prompts you to choose which component of the product is to
be installed and installs only those components.
The installer checks your system for the installation home directory that was
established when TIBCO Runtime Agent was installed. The adapter is installed
under the installation home directory.
Use one of the following modes to install the software. The examples assume you
are installing the adapter on Solaris 8.
Install Using GUI Mode
GUI Mode allows you to input values in panels. Type the following in a terminal
window and press Enter:
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin
TIBCO Adapter for Infranet User’s Guide
Installation on UNIX Systems 37
|
Install Using Console Mode
Console mode allows you to install the software from a command line. The
installer will prompt you for values. Type the following in a terminal window:
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -is:javaconsole
-console
When running in console mode you can move through the installation process as
described next:
Enter Key or 1 = Moves forward in the installer
2 = Goes back to previous screen
3 = Cancels the Wizard and exits the installation or uninstallation
4 = Redisplays the current screen
Install Using Silent Mode with Default Values
Silent mode allows you to install the software without prompts using default
values. Follow these steps to install using silent mode.
1. Type the following in a terminal window:
% ./T I B _ a d i n f r a - s i m p l e _ 5 . 2 . 0 _ s o l 8 _ s p a r c _ j a v a . b i n
2. Go to the < T I B C O _ H O M E > / a d a p t e r / a d i n f r a / 5 . 2 / b i n
-silent
folder.
3. Open the adinfra.tra file to specify the location of pcm.jar and pcmext.jar. For
example:
tibco.env.CUSTOM_CP_EXT <TIBCO_HOME>/adapter/adinfra/5.2/pcmjar
Install and Generate a Response File
You can generate a response file during any installation of the product and can
use the same file in future installations. For all installation modes using response
file, the options in the file determines what will be installed.
To install and generate a response file, type the following at the command
prompt:
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -options-record
/dir/<responseFile>
Install Using a Response File
You can use a previously generated response file for installation. For non-silent
modes, the response file determine the defaults that are presented. For silent
mode, the response file determines what will be installed.
To install using a response file, type the following at the command prompt:
TIBCO Adapter for Infranet User’s Guide
38
| Installation
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -options
/dir/<responseFileName>
Combining Options
You can combine the different available options. For example, to install in silent
mode using a response file, use:
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -silent -options
<responseFileName>
To install using Console mode and generate a response file, use:
% ./TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -is:javaconsole
-console -options-record <responseFileName>
TIBCO Adapter for Infranet User’s Guide
Post Installation 39
|
Post Installation
Permission Requirements
All adapter users must have read, write, and execute permissions for the
following directories:
<ADAPTER_HOME>/ledger
$TIBCO_HOME/adapter/adinfra/5.2/bin
$TIBCO_HOME/adapter/adinfra/5.2/logs
$TIBCO_HOME/tra/5.4/logs
$TIBCO_HOME/logs
For example, if the adapter has been installed in / o p t / t i b c o , the user who
installed the adapter can make these directories writable for all other users by
executing the following commands:
% chmod a+w /opt/tibco/adapter/adinfra/5.2/bin/
% chmod a+w /opt/tibco/adapter/adinfra/5.2/bin/logs
% chmod a+w /opt/tibco/tra/5.4/logs
Prerequisites to be met before you start configuring the adapter
Get the encoding used in Infranet deployment from the Infranet application
administrator. This encoding will be used later in the adapter configuration.
TIBCO Adapter for Infranet User’s Guide
40
| Installation
Installer FAQs and Troubleshooting
This section lists some of the frequently asked questions, common errors along
with their causes and solutions.
Frequently Asked Questions
Where is the installation log file located?
Install and uninstall log files are created in the T I B C O _ H O M E \ l o g directory.
What should I do, if JVM crashes when I run the installer?
The installer first extracts this bundled JVM into a temporary area and then uses it
to launch itself. If for some reason, the JVM crashes, you could still run the
installer using another JVM, preferably JVM 1.3.1 or higher. The syntax is:
TIB_adinfra-simple_5.2.0_win_x86.exe -is:javahome C:\j2sdk1.5.0
TIB_adinfra-simple_5.2.0_sol8_sparc_java.bin -is:javahome
/opt/jre150
The j a v a h o m e directory must contain b i n / j a v a . e x e or b i n / j a v a .
The installer will use the externally supplied JRE to launch itself.
Will 5.x installer recognize a 3.x or 4.x installation?
TIBCO products follow a three-digit release numbering scheme:
Major.Minor.Patch
Product releases that differ in either Major or Minor numbers will be a separate
installation, and will not recognize the old installation. In this case, 5.x is a minor
release and hence will not recognize either 3.x or 4.x product installations.
Why and how should I set the DISPLAY variable on UNIX platforms for GUI
mode?
The installer in GUI mode on UNIX must open an additional window, generally
for graphics. It uses the DISPLAY environment variable to tell it on what machine
to open the window. If the environment variable is not set, the installer will either
wait or abort after displaying:
InstallShield Wizard
Initializing InstallShield Wizard...
Preparing Java(tm) Virtual Machine...
...................................
...................................
TIBCO Adapter for Infranet User’s Guide
Installer FAQs and Troubleshooting 41
|
........
The DISPLAY variable must be set to the IP address or name of the machine (on
which the installer graphics window are to be displayed), followed by a screen
address, which can be : 0 . 0 . For example:
# Bourne shell
DISPLAY=<ip_address>:0.0; export DISPLAY
# Korn shell
export DISPLAY=<ip_address>:0.0
# C-shell
setenv DISPLAY <ip_address>:0.0
For example, consider a scenario where you need to install the adapter on a
remote HP-UX machine (named i t a s k a ). Because you have a Solaris 6 machine
(named a l a s k a ) that has a video card and monitor installed, you can run an
X-window application on it. So you decide to telnet to i t a s k a from a l a s k a .
When you telnet to i t a s k a , you will not get access to i t a s k a 's monitor and will
be unable to display an X-window application. That is why you must set the
D I S P L A Y variable, which instructs the X-server to redirect all Microsoft Windows
to the machine set in the variable. Before doing so, the machine (specified in the
D I S P L A Y variable) must give permissions to share its monitor.
alaska> xhost + # give permission for all to its share monitor
alaska> telnet itaska
Welcome to HPUX itaska 11.00
User:
Password:
itaska> export DISPLAY=alaska:0.0
# set display on alaska
itaska> tar -xvf TIB_tra-suite_5.1.3_h7_11.tar
Running Out of Disk Space
The installer calculates the disk space required in product home location, for the
selected components. The calculation is done before the actual installation
(copying of files to system) begins. The installer will not proceed if sufficient free
disk space is not available in product home location.
However, if disk space is consumed by another process while the installer is
copying the files, and if the required disk space is thereby reduced, the installer
may fail and will then give a failure message.
Resolution
While performing installation, avoid running other processes that consume disk
space in product home location.
TIBCO Adapter for Infranet User’s Guide
42
| Installation
Installation Error on HP-UX 11.00 64 bit Platform
An error might occur on the HP-UX platform. This section describes the error and
provides a resolution for the same.
Error message
Installation on a HP-UX 11.00 64 bit system may crash with the following error
message:
Pid nnn killed due to trashed stack.
Pid nnn was killed due to failure in writing the signal context.
This happens only on HP-UX 11.00 64 bit systems. It does not happen on HP-UX
11.00 32 bit system and HP-UX 11.11 (or 11.i) system.
To determine the OS version on your system, run:
uname -a
To determine the kernel bits on your system, run:
getconf KERNEL_BITS
Resolution
HP-UX kernel patch PHKL_27282, resolves the above crash.
To determine if your system has the kernel patch, run:
/usr/sbin/swlist -l product PHKL_27282
or
what /stand/vmunix | grep PHKL_27282
If your system is an HP-UX 11.00 64 bit system and it does not have the patch, first
install HP-UX kernel patch PHKL_27282 and then proceed with the installation.
Installation of patch PHKL_27282, will reboot your system.
Error Message
While installing as root user on HP-UX, you may get the following error:
Assertion failed: so->so_hard_contents, file softobj.c, line 363
Resolution
Install as non-root user.
TIBCO Adapter for Infranet User’s Guide
Installer FAQs and Troubleshooting 43
|
Configuring TIBCO Hawk
Error
TIBCO Runtime Agent includes the TIBCO Hawk Agent only. If you install the
full TIBCO Hawk package after installing TIBCO Runtime Agent and do not have
a Java Runtime Environment (other then the TIBCO JRE) installed, the TIBCO
Hawk Configuration tool is unable to determine the Java home location and the
JVM executable. The TIBCO Hawk services will not start correctly and you will be
unable to start the TIBCO Hawk Display.
Resolution
1. Start the TIBCO Hawk Configuration tool. For example, on Microsoft
Windows:
Start>TIBCO>TIBCO Hawk>Hawk Configuration
2. Under the General tab, click Advanced.
3. In the J a v a
Home Directory
field, provide the path to Java. For example:
C:\tibco\jre\1.4.2
4. In the J V M
Executable
field, provide the JVM executable. For example:
java.exe
The services will start properly and the TIBCO Hawk Display will run.
TIBCO Adapter for Infranet User’s Guide
44
| Installation
TIBCO Adapter for Infranet User’s Guide
| 45
Chapter 3
Getting Started
This chapter provides a short exercise that shows you how to configure TIBCO
Adapter for Infranet with a Publication Service. More extensive details for each of
the steps described here are provided later in the manual.
Topics
•
Overview, page 46
•
Basic Steps for Configuring and Using the Adapter, page 47
•
Configuring the Adapter Components, page 48
•
Deploying the Adapter, page 55
•
Starting the Adapter, page 56
•
Stopping the Adapter, page 57
TIBCO Adapter for Infranet User’s Guide
46
| Getting Started
Overview
There are some prerequisites to be met before you start configuring minimum
settings for the adapter because the adapter and Infranet are closely integrated.
Then you can start TIBCO Designer and configure the adapter. All of these steps
are covered under Basic Steps for Configuring and Using the Adapter on page 47.
The first part of the configuration process involves entering all of the basic
information for an adapter instance that is tailored for your particular
environment. You need to supply a name for the adapter instance that you are
configuring.
As the next part of the configuration process, you need to configure an adapter
service that will perform the publication, subscription or request-response
services for the adapter.
TIBCO Adapter for Infranet User’s Guide
Basic Steps for Configuring and Using the Adapter 47
|
Basic Steps for Configuring and Using the Adapter
A typical configuration section entails the following steps:
1. Start TIBCO Designer and open a project.
2. Drag and drop the Infranet Adapter Configuration icon from the palette
panel into the design panel.
3. In the configuration panel, configure the various settings for the adapter
instance by clicking through the tabs. Supply the appropriate information or
make the necessary selections for each category of options.
Click Apply after selecting each set of options in order to retain the settings
you have specified.
4. Save the project and exit TIBCO Designer.
5. Modify the properties file for the adapter with the project name and adapter
instance name. Start the adapter instance you have configured.
The next sections lead you through a quick configuration exercise.
TIBCO Adapter for Infranet User’s Guide
48
| Getting Started
Configuring the Adapter Components
The TIBCO Designer GUI is used to configure adapter instances. When starting
TIBCO Designer, you must create or select a project. A project contains the
configuration files that define options used by a run-time adapter. After a project
is configured, it is converted to a repository file and available for use by the
run-time adapter.
1. Open TIBCO Designer and choose New Empty Project option.
TIBCO Adapter for Infranet User’s Guide
Configuring the Adapter Components 49
|
2. The default location is C : \ t i b c o \ d e s i g n e r \ 5 . 4 \ . Click OK.
A new project is created and the TIBCO Designer screen appears as shown
below.
Project Panel
Design
Panel
Configuration
Panel
TIBCO Adapter for Infranet User’s Guide
50
| Getting Started
3. Drag and drop Infranet Adapter Configuration icon from the palette panel to
the design panel.
4. In the Configuration tab rename the Instance Name field if required and click
Apply.
5. In the Design-time Connection tab enter appropriate values for Host Name,
Port Number, Database name, Login and Password. If you want to save the
password, select the Remember Password check box. If you want to use
TIBCO Adapter for Infranet User’s Guide
Configuring the Adapter Components 51
|
design-time connection settings for run-time, select the Use Design-time
Connection Settings for Run-time check box. Click Apply.
TIBCO Adapter for Infranet User’s Guide
52
| Getting Started
6. In the Run-time Connection tab, enter appropriate values and click Apply.
7. Click the Adapter Services folder under InfranetAdapterConfiguration in
the project panel.
TIBCO Adapter for Infranet User’s Guide
Configuring the Adapter Components 53
|
8. Drag and drop a Publication Service icon from the palette panel to the design
panel.
9. In the Configuration tab, select the T r a n s p o r t
Leave other default values unchanged.
Type
as R e n d e z v o u s or J M S .
TIBCO Adapter for Infranet User’s Guide
54
| Getting Started
10. Go to Project>Save to save the project. The S a v e P r o j e c t window appears,
with the path you specified shown in P r o j e c t D i r e c t o r y.
TIBCO Adapter for Infranet User’s Guide
Deploying the Adapter 55
|
Deploying the Adapter
Before deploying the adapter, you must export the multi-file project to a dat.
Select Project>Export Full Project from the menu. Browse and select the location
of the directory you wish to save the dat file to. Ensure that the directory is
different from the multi-file project. Enter the name of the project and click OK.
If you want to use the . d a t file, which you just configured, enter the path of the
. d a t file in the R e p o U R L field of the corresponding t r a file. The client variable in
the t r a files for the same is t i b c o . r e p o u r l .
Before starting the adapter you must create a properties file or edit the default
properties file. Each adapter must have a unique properties file. The easiest way
to deploy an adapter is to copy the default a d i n f r a . t r a file to a unique name
and edit the properties defined in the file. At a minimum, the following must be
provided:
•
t i b c o . r e p o u r l —pathname
of the TIBCO Designer project
•
t i b c o . c o n f i g u r l —name
•
a p p l i c a t i o n . a r g s —properties
of the adapter configuration
file to pass to the application
For example, the default a d i n f r a . t r a file can be copied and renamed to
a d i n f r a . t r a . Using a text editor, the file can be opened and the following
properties set:
tibco.repourl C:/TIBCO/adapter/adinfra/5.2/bin/TDTDemoMB.dat
tibco.configurl
tibco/private/adapter/InfranetAdapterConfiguration
application.args adinfra --propFile
C:/tibco/adapter/adinfra/5.2/bin/adinfra.tra
application.start.dir C:/TIBCO/adapter/adinfra/5.2
tibco.clientVar.DirLedger
C:/TIBCO/adapter/adinfra/5.2/ledger
tibco.clientVar.DirTrace
C:/TIBCO/adapter/adinfra/5.2/logs
TIBCO Adapter for Infranet User’s Guide
56
| Getting Started
Starting the Adapter
The following command line starts the adapter from a command window using
the default a d i n f r a . t r a properties file. The default file has been edited with the
name of the project, the adapter configuration and properties file to pass to the
application. Because the properties file has the same name prefix as the executable
and is in the same folder, it need not be specified on the command line.
adinfra --run
You can run the adapter as a console application using a custom properties file.
For example, the next command line starts the adapter service that is identified in
the a d i n f r a . t r a properties file, which is located in the same directory as the
executable. The absolute pathname to the properties file must be given if it is
located in a different directory than the executable.
adinfra --run --propFile
TIBCO Adapter for Infranet User’s Guide
adinfra.tra
Stopping the Adapter 57
|
Stopping the Adapter
From a command prompt you can stop the adapter by publishing a message on
the % % D o m a i n % % . % % D e p l o y m e n t % % . a d i n f r a . % % I n s t a n c e I d % % . e x i t subject or
type Ctrl-C in the window.
TIBCO Adapter for Infranet User’s Guide
58
| Getting Started
TIBCO Adapter for Infranet User’s Guide
| 59
Chapter 4
Adapter Instance Options
This chapter explains how to create an adapter instance and assign it services by
configuring standard settings. All configuration tasks are performed in TIBCO
Designer and the information is stored in a project that is later used by the
run-time adapter.
Topics
•
Overview, page 60
•
Adapter Instance Fields, page 62
•
Adding Adapter Services, page 81
•
Testing the Adapter, page 124
TIBCO Adapter for Infranet User’s Guide
60
| Adapter Instance Options
Overview
Each adapter instance must have its corresponding configuration defined. The
configuration is accessed whenever an adapter application is started.
Configuration is done with TIBCO Designer. Ensure that TIBCO Designer has
been installed before continuing (see the TIBCO Designer User’s Guide). All the
adapter configuration information is saved as a project in a repository.
Configuration Tasks
A typical configuration session entails the following steps:
1. Start TIBCO Designer and create a new project (see the TIBCO Designer User’s
Guide).
2. Drag and drop the InfranetAdapterConfiguration icon to the Design panel.
3. In the Configuration tab, provide an appropriate name in the Instance Name
field and click Apply.
When an adapter service is added to an adapter instance, the following
parameters are automatically generated for the adapter service:
— Subject name
— RVCM name
— RVCMQ name
— Ledger file
— Transactional Name
4. In the Design-time Connection tab, set the appropriate connection parameters,
click Apply and then click Test Connection.
5. Configure adapter services for the adapter instance.
6. Save the project and exit TIBCO Designer (see the TIBCO Designer User’s
Guide).
7. Select Project>Export Full Project from the menu. Browse and select the
location of the directory you wish to save the dat file to. Ensure that the
directory is different from the multi-file project. Enter the name of the project
and click OK.
8. Start the adapter to test the configuration, then stop the adapter (see Start or
Stop the Adapter on page 160)
TIBCO Adapter for Infranet User’s Guide
Overview 61
|
9. Make configuration adjustments as needed.
Repeat the preceding steps as necessary to achieve correct adapter operation.
TIBCO Adapter for Infranet User’s Guide
62
| Adapter Instance Options
Adapter Instance Fields
An InfranetAdapterConfiguration icon represents an adapter instance once the
resource and at least one adapter service have been configured and saved. The
resource contains the following tabs for configuring an adapter instance:
•
Configuration Tab
•
Design-time Connection Tab
•
Run-Time Connection Tab
•
Adapter Services Tab
•
General Tab
•
Multithreading Tab
•
Logging Tab
•
Startup Tab
•
Monitoring Tab
•
Opcode Specification Tab
•
Event Specification Tab
The following sections explain how to use these tabs to configure an adapter
instance.
Configuration Tab
Instance Name
The name of the adapter instance. The name cannot contain numbers or
underscore characters and must be less than 201 characters.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 63
|
When an adapter service is added to an adapter instance, the following
parameters are automatically generated for the adapter service:
— Subject name
— RVCM name
— RVCMQ name
— Ledger file
— Transactional Name
Changing the adapter instance name results in an automatic regeneration of
these names. However, once you modify any of these names manually, that
particular name will not be automatically regenerated on subsequently
modifying the adapter configuration name. You will always have to manually
update it when required.
Description
Enter the description.
Version
The version string indicates the ActiveEnterprise (AE) format in which the
adapter instance is saved.
When a new adapter instance is created in TIBCO Designer 5.4, the version string
is set to AE Version 5.1. When a 4.x adapter instance is opened in Designer 5.x, the
Version field is set to AE Version 4.1. The adapter palette does not allow you to
edit a 4.x adapter instance to be run against a 4.x runtime adapter.
If a 4.x adapter instance is to be run against a 5.x run-time adapter, the Version
field should be set to AE Version 5.1.
To change versions, click the Change Version button.
Changing version from 4.1 to 5.1 will migrate the 4.x configuration to 5.1
configuration. Refer to the Migration and Compatibility Section in TIBCO Adapter
for Infranet 5.2.0 Release Notes.
Changing the adapter version from 5.1 to any previous version is not allowed.
TIBCO Adapter for Infranet User’s Guide
64
| Adapter Instance Options
Message Filter
Specify a message filter, if you have configured a message filter resource for use
with the adapter. The filter allows you to manipulate incoming and outgoing data
before sending it on the network or handing it to the target application. Filters can
be written using the TIBCO Adapter SDK. See the TIBCO Adapter SDK
Programmer’s Guide for information about writing a message filter.
Show Advanced Settings
When not selected (the default), the GUI allows configuring the adapter with
minimum settings. When selected, the Adapter Services tab, General tab and
Multithreading tab become available.
Reset
Clears any entries you made and resets fields to previously applied values or to
their default values if any.
Change Version
Changes the ActiveEnterprise format.
Changing the adapter version from 5.1 to any previous version is not allowed.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 65
|
Sample Configuration Screen
The following sample shows the configuration details entered for an adapter
instance.
Design-time Connection Tab
This tab allows you to define the connection parameters used to connect to the
Infranet application during configuration. At design-time, the palette connects to
Infranet application for fetching the details of Storable objects for Query
operation. Use the following steps to set up design-time connection options:
Host Name
Name or IP address of the machine that hosts Infranet Connection Manager. This
is a mandatory field.
Port Number
TCP port of Infranet connection manager. This is a mandatory field.
TIBCO Adapter for Infranet User’s Guide
66
| Adapter Instance Options
Username
A valid user name to log on to the Infranet application. This is a mandatory field.
Password
A valid password corresponding to the user name. This is a mandatory field.
Remember Password
Select this check box if you want to save the password to the repository. If this
check box is cleared, you will have to re-enter the password when you close and
re-open the repository.
Use Design-time Connection Settings for Run-time
Select this check box if you wish to use the design-time connection parameters for
run-time. On checking this field, design-time parameters will be copied to the
Run-time Connection tab and run-time fields will be disabled. On clearing the
check box, the run-time fields will be enabled and you can enter different
run-time parameters.
You can specify values to the global variables instead of typing in the value for
each field again for each adapter instance.
Click Apply. Click Test Connection to verify if your connection parameters are
right. When the C o n n e c t i o n i s s u c c e s s f u l message appears, click OK.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 67
|
Run-Time Connection Tab
Use the following steps to set up Run-time connection options.
Host Name
Name or IP address of the machine that hosts Infranet Connection Manager. This
is a mandatory field.
Port Number
TCP port of Infranet connection manager. This is a mandatory field.
Database Name
The name of the database to which the adapter will connect. This is a mandatory
field.
Username
A valid user name to log on to the Infranet application. This is a mandatory field.
TIBCO Adapter for Infranet User’s Guide
68
| Adapter Instance Options
Password
A valid password corresponding to the user name. This is a mandatory field.
Connection Time-out (milliseconds)
Specify the time-out value that the Infranet adapter waits for the response from
Infranet server. The adapter will stop the ongoing operation if there is no response
from the Infranet server within the specified period of time. The default value is 0,
indicating that this function is disabled.
The recommended value is greater than 60000 milliseconds. For example, the
value is set to 60000 milliseconds. If the server does not respond within the
specified 60000 milliseconds (1 minute), a ERR_TIMEOUT error message will be
generated and the adapter will stop the ongoing operation.
The time-out value also applies to the Opcode called to set up connection during
the initialization of the adapter. Therefore, if the value is too small, the connection
operation will be stopped when the time-out error occurs.
The Number of Reconnect Attempts Before Suspending Impacted Service(s)
Specify the number of reconnection attempts to make before suspending a
run-time adapter or adapter service.
Maximum Number of Reconnect Attempts
Specify the total number of reconnection attempts to make before the run-time
adapter or adapter service is stopped. A value of -1 means reconnection attempts
will continue indefinitely.
Interval Between Reconnect Attempts (milliseconds)
Specify the time interval in milliseconds to elapse between each reconnection
attempt.
Adapter Termination Criteria
Click Apply. Click Test Connection to verify if your connection parameters are
right. When the C o n n e c t i o n i s s u c c e s s f u l message appears, click OK.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 69
|
Adapter Services Tab
In the Configuration tab, click the Show Advanced Settings check box and then
select Adapter Services tab.
Specify the following options:
Transaction Timer (milliseconds)
Time interval before releasing the reserved transaction connection to the
connection pool.
TIBCO Adapter for Infranet User’s Guide
70
| Adapter Instance Options
General Tab
In the Configuration tab, select the Show Advanced Settings check box. Then
select the General tab. You can configure general options such as Termination
Subject and Encoding values which will be used by all services.
Specify the following options in the General tab:
Adapter Termination Subject
A message sent on the termination subject (if Rendezvous is the transport) or
topic (if JMS is the transport) stops the adapter. In most cases, you should use the
default value. See TIBCO Rendezvous Concepts for information about specifying
subject names. See the TIBCO Enterprise Message Service User’s Guide for
information about publishing on a topic.
Adapter Encoding
The adapter supports only UTF-8 encoding and hence this field is disabled.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 71
|
Error Code List
List of Infranet Error codes that needs to be treated as Connection related error
codes by the run-time adapter. The errors are added as text delimited by comma.
The default list contains the following error codes:
PIN_ERR_STREAM_IO
PIN_ERR_STORAGE_DISCONNECT
For more information on Infranet Error codes refer to Infranet documentation.
If the timeout error is specified in this field, the adapter starts the reconnection
mechanism in the event of a timeout.
Multithreading Tab
You can specify the ThreadCount for each session in the Multithreading tab.
Session Name
The sessions for which the dispatcher count can be edited are listed.
TIBCO Adapter for Infranet User’s Guide
72
| Adapter Instance Options
Number of Threads
Specify the number of threads in this field.
This sample screen shows the Multithreading tab with default values.
Logging Tab
Use Advanced Logging
When Use Advanced Logging is not selected (the default), you can set two
standard output destinations (sinks) for trace messages and set the tracing level
for the roles selected.
When Use Advanced Logging is selected, you have complete control on selecting
the destinations and associating desired roles with each of the destinations.
To create and configure the sinks, select the log sinks folder under the Advanced
folder in the project panel.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 73
|
To create sinks, drag and drop the Generic log sink icon from the palette panel
into the design panel. From the configuration panel, select the sink type. The
following are the sink types available:
— File
— Hawk
— Network
— STDIO
When File and STDIO sinks are created from the Generic log sink, they offer
further configuration options. For the File sink, the file limit, file count, and the
option to append or overwrite can be specified. When created by default, this is
set to 30000 bytes, 3 and append mode respectively. For the STDIO sink, the
option to write to s t d o u t or s t d e r r can be selected. When created by default,
s t d o u t is selected.
The Hawk sink uses the hawk session, created and used by the adapter for
monitoring purposes, to send tracing messages to the TIBCO Hawk monitor or
Display. For details on Hawk sessions, see Using Global Variables on page 128.
The configuration for the Hawk sink involves specifying the M i c r o A g e n t N a m e
that must be specified in the configuration panel.
The Network sink is used to publish tracing message on TIBCO environment. The
configuration for the network sink involves specifying the session, and the subject
on which the trace messages needs to be published.
For all the sinks, optionally the name and description for the sinks can be
provided.
Log to Standard I/O
(STDIO Sink) When selected, trace messages are displayed in the command
prompt window where the adapter is started. When not selected, trace messages
do not display in the window.
Log File
Specify the name of the log file (log sink) to which trace messages are written.
Global variables can be used to specify the location of the log file. See Using
Global Variables on page 128 for more information.
The roles available are Info, Debug, Warning, and Error messages. The trace
message generated depends on the roles selected. Turning on the roles can affect
the performance of the adapter. Therefore, it is recommended that you turn on the
required roles only.
TIBCO Adapter for Infranet User’s Guide
74
| Adapter Instance Options
Log Info/Debug/Warning/Error Messages
Trace messages of the selected level(s) will be collected in the named log sink. You
can configure what levels of trace messages you want logged, and where trace
messages are sent. There are three types of logs (log sinks) that you can configure
to hold trace messages, corresponding to three levels (roles) of trace messages,
Information, Warning and Error. A fourth level of trace messages, Debug, is
reserved and should not be enabled unless requested by the TIBCO Product
Support Group. This option writes a lot of information to the log file and
significantly reduces the speed of the adapter. Click Apply.
To accept the default logging options make sure U s e
selected, then click Apply.
Sample Logging Tab Screen
The following sample shows the logging options.
Startup Tab
The following values can be set in the startup tab.
TIBCO Adapter for Infranet User’s Guide
Advanced Logging
is not
Adapter Instance Fields 75
|
Show Startup Banner
Select the check box to show the startup banner.
Metadata Search URL
This field is predefined and cannot be changed.
Sample Startup Tab Screen
The following sample shows the startup options.
Monitoring Tab
This is an advanced setting. You can use microagents to supplement the
monitoring information provided by the standard logging levels capability.
Examples of supplemental information that you can obtain with microagents
include the repository URL, command line arguments used to start the adapter,
and so on.
•
See Chapter 7, Monitoring the Adapter Using TIBCO Hawk, on page 169 for a
list of all supported microagents.
TIBCO Adapter for Infranet User’s Guide
76
| Adapter Instance Options
In the Configuration tab, select the Show Advanced Settings check box.
Specify the following options in the Monitoring tab:
Enable Standard MicroAgent
Click to use the standard TIBCO Hawk microagent available for this adapter.
Standard MicroAgent Name
Enter the name of the TIBCO Hawk microagent name. In most cases the default
value is used. The default is
C O M . T I B C O . A D A P T E R . a d i n f r a . % % D e p l o y m e n t % % . % % I n s t a n c e I d % % . The values
for the global variables % % D e p l o y m e n t % % and % % I n s t a n c e I d % % can be set or
modified by clicking Edit>Global Variables.
Standard MicroAgent Timeout(ms)
The timeout value for the Standard MicroAgent in milliseconds.
Enable Class MicroAgent
Click to use the adapter-specific TIBCO Hawk microagent available for this
adapter. In most cases the default setting, % % H a w k E n a b l e d % % is used. The global
variable must be set to T R U E . Click Edit>Global Variables to check the value for
the global variable.
Class MicroAgent Name
Enter the name for the adapter-specific microagent. In most cases the default
value is used. The default is
C O M . T I B C O . a d i n f r a . % % D e p l o y m e n t % % . % % I n s t a n c e I d % % . The values for the
global variables % % D e p l o y m e n t % % and % % I n s t a n c e I d % % can be set or modified by
clicking Edit>Global Variables.
Class MicroAgent Timeout(ms)
The timeout value for the Class MicroAgent in milliseconds.
Default MicroAgent Session
This field has been disabled. The default value of the microagent session name is
I n f r a n e t H a w k D e f a u l t . You can modify the session parameters as described in
Configuring Advanced Settings on page 125.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 77
|
Sample Monitoring Tab Screen
The following sample screen shows the monitoring options.
Importing an Opcode
Opcodes need to be imported into the repository for configuring Subscription and
Request-Response services.
You can import an Opcode using the following tab:
•
Opcode Specification Tab
The following steps explain how to import Opcodes into the project:
1. Start TIBCO Designer.
2. Open the project into which you will be importing the Opcode. To create a
new project drag and drop the InfranetAdapterConfiguration icon to the
design panel.
The imported Opcode can be used across adapter instances in this project.
3. Specify the following options in the Opcode Specification Tab.
TIBCO Adapter for Infranet User’s Guide
78
| Adapter Instance Options
Opcode Specification Tab
Opcode Directory
Specify the path where the FLISTS are present or click Browse to select the folder.
The default value is
<TIBCO_HOME>\adapter\adinfra\5.2\bin\data\flist.specs
Loaded
Select the check box to select the Opcodes to be loaded. Click Load Opcodes to
load the required Opcodes.
Sample Opcodes Configuration Screen
Refreshing Opcode Schemas
1. Select a particular Opcode
2. Click Load Opcodes
3. Select another Opcode
4. Click Load Opcodes
5. The following message occurs (as shown in the image below).
6. Click Yes to refresh the Opcode schema.
TIBCO Adapter for Infranet User’s Guide
Adapter Instance Fields 79
|
Event Specification Tab
Business event data specifications must be imported into the repository before
configuring a Publication service. Before importing an event, it must be
configured and registered with the Infranet Application. Refer to the Infranet
documentation - Integrating Infranet with Enterprise Applications for details about
these tasks.
Infranet Business Events are defined in the Infranet p a y l o a d c o n f i g . x m l file. To
import Business Events, use the Event Specification Tab.
To import Business Events:
1. Start TIBCO Designer.
2. Open the project for which you will be importing the event. Or, drag and drop
the InfranetAdapterConfiguration icon to the design panel.
TIBCO Adapter for Infranet User’s Guide
80
| Adapter Instance Options
3. Specify the following options in the Event Specification tab.
Payload File
Enter the name and location of the p a y l o a d c o n f i g . x m l file. Click Browse to
select the file.
Loaded
Select the check box to select the events to be loaded. Click Load Events to load
the required Events.
Sample Business Event Configuration Screen
The following screen shows a business event configured.
TIBCO Adapter for Infranet User’s Guide
Adding Adapter Services 81
|
Adding Adapter Services
To add an adapter service to an adapter instance:
1. Drag the InfranetAdapterConfiguration icon to the design panel or select the
icon in the project panel.
2. In the project tree, click Adapter Services.
3. In the palettes panel, drag the required adapter service to the design panel.
After configuring global settings for an adapter instance, you select one or
multiple adapter services for the instance. The following adapter services are
available to the adapter.
•
Publication Service
•
Subscription Service
•
Request-Response Service
•
Request-Response Invocation Service
TIBCO Adapter for Infranet User’s Guide
82
| Adapter Instance Options
Publication Service
The Publication service sends messages from Infranet to applications configured
for the TIBCO environment.
Before adding a Publication service, you must import the required business
events that the service will use.
Configuration Tab
Drag a Publication Service icon to the design panel. Specify the following options
in the Configuration tab:
Name
Enter a unique name for the publication service in this adapter instance.
Description
Enter a description.
Transport Type
Select the Transport Type as Rendezvous or JMS.
The transport can be configured to use a trusted store and identity resource for
use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions,
JMS topics and JMS queue sessions have an SSL configuration field which uses a
dialog to perform SSL configuration.
To enable and configure SSL, in the Project panel, expand the Advanced folder,
then expand the Sessions folder. Select the TIBCO Rendezvous session, JMS topic
session or JMS queue session and click Use SSL?. The SSL configuration options
are explained in the online help associated with the session dialog. Click the
question mark to display the online help.
Click Apply.
Transport Tab
Message Transport options can be set for the Publication Service depending on
the transport type selected in the Configuration tab of the Publication Service.
TIBCO Adapter for Infranet User’s Guide
Publication Service 83
|
The following options are displayed in the Transport tab if Rendezvous is selected
as the transport in the Configuration tab:
Message Subject
By default, a service uses a message subject that is generated using the D o m a i n
and D e p l o y m e n t global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default subject, make sure the values
for D o m a i n and D e p l o y m e n t are not empty. You can type a Rendezvous subject
name different from the default in this field. See TIBCO Rendezvous Concepts for
information about specifying subject names.
Reply Message Subject
Reply subject for this Request-Response service.
Quality of Service
If Rendezvous is selected as the transport type, select:
—
Certified
Guarantees that every certified message reaches its intended recipient in
the order sent. The message can be sent across network boundaries, and if
a network fails, delivery attempts continue until delivery succeeds or until
the message's time limit expires. This is often called certified message
delivery.
If certified message delivery is used, data is stored in a ledger file. The size
of the ledger depends on several factors, the most important of which is the
retention rate of stored data. That is, the ledger grows fastest in response to
the cumulative length of undeliverable messages. You must ensure that
sufficient disk space is available for the expected size of the ledger.
—
Reliable
Ensures that each multicast or broadcast message is received as long as the
physical network and packet recipients are working, and that the loss of a
message is detected. This choice can compensate for brief network failures
because it can retransmit a message on request if the first attempt failed.
This choice is appropriate when message delivery is expected but some loss
can be tolerated.
Transactional (RVTX) quality of service is not supported.
TIBCO Adapter for Infranet User’s Guide
84
| Adapter Instance Options
Wire Format
Services must use the same wire format to exchange data.
ActiveEnterprise Message
Control information for validation is sent in the message. If no control
information is included, an exception is returned to the subscription service.
ActiveEnterprise standard wire format provides class information and
packing rules for the TIBCO Adapter SDK set of data types. This format
allows ActiveEnterprise components to perform extra validation on messages
sent or received. XML allows you to retrieve data as XML documents and
metadata as XML Schemas (XSD).
See the TIBCO Adapter SDK Programmer’s Guide for details about the control
information generated and sent with ActiveEnterprise messages.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the A d v a n c e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
TIBCO Adapter for Infranet User’s Guide
Publication Service 85
|
A screen shot of the Publication Service Transport tab with Rendezvous transport
options set is shown next
.
The following options are displayed in the Transport tab if JMS is selected as
the transport in the Configuration tab:
Destination
By default, a service uses a dynamic destination that is generated using the
D o m a i n and D e p l o y m e n t global variables, the adapter acronym, the adapter
instance name and the service name. If you use this default dynamic destination,
make sure the values for D o m a i n and D e p l o y m e n t are not empty. You can override
the default dynamic destination by specifying the static destination in this field.
The static destination must be defined on the EMS server before it can be used by
the run-time adapter.
See the TIBCO Enterprise Message Service User’s Guide for information about
destinations.
Reply Destination
Reply destination of this Request-Response Service.
TIBCO Adapter for Infranet User’s Guide
86
| Adapter Instance Options
Wire Format
The format in which messages are to be published. Different options are
displayed according to the T r a n s p o r t T y p e selected. For JMS mode of transport
only one wire format is available. Publication Service and Subscription Service
can only send and receive data if they agree on a specific wire format. The X M L
M e s s a g e wire format conforms to specifically constructed and fully compliant
XML Schema (XSD) based on the existing definition of the ActiveEnterprise
schema.
Connection Factory Type
—
Topic
A message published to a topic is broadcast to one or more subscription
services. All messages published to the topic are received by all services
that have subscribed to the topic. This messaging model is known as
publish-subscribe.
—
Queue
A message sent to a queue is consumed by one and only one receiver. Each
message has only one receiver though multiple receivers may connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point.
Delivery Mode
The delivery mode for the message. There are two options to choose from:
•
Persistent — indicates that the message will be available to an EMS client even
if the EMS server goes down.
•
Non-persistent — indicates that the message will not be available to an EMS
client if the EMS server goes down.
Messages sent with the durable delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages re-sent in the event of a server failure. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
The semantics for these fields are somewhat more complex than the explanation
given here. See the TIBCO Enterprise Message Service User’s Guide for more
information.
TIBCO Adapter for Infranet User’s Guide
Publication Service 87
|
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the A d v a n c e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
A screen shot of the Publication Service Transport tab with JMS transport options
set is shown next.
Schema Tab
The schema options can be set in the Schema tab.
TIBCO Adapter for Infranet User’s Guide
88
| Adapter Instance Options
Class Reference
The Class Reference is set automatically depending on the Infranet event for
which the service has been configured. This field is read-only.
Event Tab
Event Name
Select the name of the Business Event to be published from the drop-down list.
The Business Event must exist in the project before you configure the Publication
service.
Select All
Select the check box if you want to select all the fields.
TIBCO Adapter for Infranet User’s Guide
Publication Service 89
|
Deselect All
Select the check box if you do not want to select any field.
The next sample shows the Event Mapping tab.
TIBCO Adapter for Infranet User’s Guide
90
| Adapter Instance Options
Subscription Service
The Subscription Service gets messages from applications configured for the
TIBCO environment and sends the messages to Infranet. If the message requests a
reply, on receiving the reply, the Subscription Service sends the reply to the
requestor.
Configuration Tab
Drag a Subscription Service icon to the design panel. Specify the following
options in the Configuration tab:
Name
Enter a unique name for the subscription service in this adapter instance.
Description
Enter a description.
Transport Type
Select the Transport Type as R e n d e z v o u s or J M S .
The transport can be configured to use a trusted store and identity resource for
use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions,
JMS topics and JMS queue sessions have an SSL configuration field which uses a
dialog to perform SSL configuration. XML allows you to retrieve data as XML
documents and metadata as XML Schemas (XSD).
To enable and configure SSL, in the Project panel, expand the Advanced folder,
then expand the Sessions folder. Select the TIBCO Rendezvous session or JMS
topic and click U s e S S L ? . The SSL configuration options are explained in the
online help associated with the session dialog. Click the question mark to display
the online help.
Click Apply.
Function Type
Select the function to be performed by the adapter service. Select Opcode or
Query from the drop-down as required.
TIBCO Adapter for Infranet User’s Guide
Subscription Service 91
|
Opcode Configure Tab
This tab appears if you select Opcode as the Function Type in the Configuration
tab. Following are the fields for the Opcode tab.
Opcode Name
Select the Opcode from the drop-down list. These are the Opcodes loaded at the
instance level.
Opcode Flag
The default value for this field is 0 .
Load Schema
Click this button to fetch the schema.
Select All
Select this check box to select all the fields.
Deselect All
Clear this check box to deselect all the fields.
TIBCO Adapter for Infranet User’s Guide
92
| Adapter Instance Options
Query Configure Tab
This tab appears if you select Query as the Function Type in the Configuration
tab. Following are the fields for the Query tab.
Query Name
Select the query to run from the drop-down.
Search Template
SQL Query for the Infranet Database.
Storable Class
The storable class to be queried.
Search Flag
The method in which the database should be searched.
TIBCO Adapter for Infranet User’s Guide
Subscription Service 93
|
The value for the Search flag should be an integer. Example: To search for ALL
ROWS you need to enter 0. Refer to the following table for details on other valid
values.
Search Flag
Value
SRCH_DISTINCT
256
SRCH_EXACT
512
SRCH_EXACT and SRCH_DISTINCT can be combined by
adding their flag values
768
To return all values
0
Schema File Directory
The temporary XML files created by the adapter are stored in this directory. This
is a mandatory field.
Fetch Schema
Click the button to fetch the schema.
Load Schema
Click the button to load the schema.
TIBCO Adapter for Infranet User’s Guide
94
| Adapter Instance Options
Transport Tab
Message Transport options can be set for the Subscription Service depending on
the transport type selected in the Configuration tab of the Subscription Service.
The following options are displayed in the Transport tab if Rendezvous is selected
as the transport in the Configuration tab:
Message Subject
By default, a service uses a message subject that is generated using the D o m a i n
and D e p l o y m e n t global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default subject, make sure the values
for D o m a i n and D e p l o y m e n t are not empty. You can type a Rendezvous subject
name different from the default in this field. See TIBCO Rendezvous Concepts for
information about specifying subject names.
Reply Message Subject
Reply subject for this Request-Response service.
TIBCO Adapter for Infranet User’s Guide
Subscription Service 95
|
Quality of Service
If Rendezvous is selected as the transport type, select:
—
Certified
Guarantees that every certified message reaches its intended recipient in
the order sent. The message can be sent across network boundaries, and if
a network fails, delivery attempts continue until delivery succeeds or until
the message's time limit expires. This is often called certified message
delivery.
If certified message delivery is used, data is stored in a ledger file. The size
of the ledger depends on several factors, the most important of which is the
retention rate of stored data. That is, the ledger grows fastest in response to
the cumulative length of undeliverable messages. You must ensure that
sufficient disk space is available for the expected size of the ledger.
—
Reliable
Ensures that each multicast or broadcast message is received as long as the
physical network and packet recipients are working, and that the loss of a
message is detected. This choice can compensate for brief network failures
because it can retransmit a message on request if the first attempt failed.
This choice is appropriate when message delivery is expected but some loss
can be tolerated.
—
Distributed Queue
Indicates load balancing should be enabled. An RVCMQ Session allows
applications to use distributed queues for certified delivery to any number
of listeners using queuing member sessions that act together to process
inbound task messages.
Transactional (RVTX) quality of service is not supported.
Wire Format
Services must use the same wire format to exchange data.
ActiveEnterprise Message
Control information for validation is sent in the message. If no control
information is included, an exception is returned to the Subscription Service.
ActiveEnterprise standard wire format provides class information and
packing rules for the TIBCO Adapter SDK set of data types. This format
allows ActiveEnterprise components to perform extra validation on messages
sent or received. XML allows you to retrieve data as XML documents and
metadata as XML Schemas (XSD).
TIBCO Adapter for Infranet User’s Guide
96
| Adapter Instance Options
See the TIBCO Adapter SDK Programmer’s Guide for details about the control
information generated and sent with ActiveEnterprise messages.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the A d v a n c e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
A screen shot of the Subscription Service Transport tab with Rendezvous
transport options set is shown next.
TIBCO Adapter for Infranet User’s Guide
Subscription Service 97
|
The following options are displayed in the Transport tab if JMS is selected as the
transport in the Configuration tab:
Destination
By default, a service uses a dynamic destination that is generated using the
D o m a i n and D e p l o y m e n t global variables, the adapter acronym, the adapter
instance name and the service name. If you use this default dynamic destination,
make sure the values for D o m a i n and D e p l o y m e n t are not empty. You can override
the default dynamic destination by specifying the static destination in this field.
The static destination must be defined on the EMS server before it can be used by
the run-time adapter.
See the TIBCO Enterprise Message Service User’s Guide for information about
destinations.
Reply Destination
Reply destination of this Request-Response Service.
Wire Format
The format in which messages are to be published. Different options are
displayed according to the T r a n s p o r t T y p e selected. For JMS mode of transport
only one wire format is available. Publication Service and Subscription Service
can only send and receive data if they agree on a specific wire format. The X M L
M e s s a g e wire format conforms to specifically constructed and fully compliant
XML Schema (XSD) based on the existing definition of the ActiveEnterprise
schema.
Connection Factory Type
—
Topic
A message published to a topic is broadcast to one or more subscription
services. All messages published to the topic are received by all services
that have subscribed to the topic. This messaging model is known as
publish-subscribe.
—
Queue
A message sent to a queue is consumed by one and only one receiver. Each
message has only one receiver though multiple receivers may connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point.
TIBCO Adapter for Infranet User’s Guide
98
| Adapter Instance Options
Delivery Mode
This field is displayed only if T o p i c is selected as the C o n n e c t i o n
Factory Type.
The subscription service can be durable or non- durable.
—
Durable
(JMS only)
Durable indicates that the service is registered with the EMS server.
Messages sent to a durable subscription service are held by the EMS server
until they are consumed by the service. The service can be down and expect
to receive its messages when it comes back up.
—
Non Durable
(JMS only)
Non Durable indicates that the service is not registered with the EMS
server. Messages sent to a non-durable subscription service are not held by
the EMS server. If the service is down, it will not receive the messages that
arrived at the EMS server while the service was down.
Messages sent with the durable delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages re-sent in the event of a server failure. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
The semantics for these fields are somewhat more complex than the explanation
given here. See the TIBCO Enterprise Message Service User’s Guide for more
information.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the S e s s i o n s folder of the A d v a n c e d folder and displays it in this
field. If you have explicitly created a custom session of the same type, you can
click the Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
TIBCO Adapter for Infranet User’s Guide
Subscription Service 99
|
A screen shot of the Subscription Service Transport tab with JMS transport
options set is shown next
.
Schema Tab
The schema options can be set in the Schema tab.
Class Reference
The Class Reference is set automatically depending on the table for which the
service has been configured. This field is read-only.
TIBCO Adapter for Infranet User’s Guide
100
| Adapter Instance Options
TIBCO Adapter for Infranet User’s Guide
Request-Response Service 101
|
Request-Response Service
This service is often called a Request Reply Server or RPC (Remote Procedural
Call) Server. When running as a Request-Response Service, the adapter receives
requests from other TIBCO ActiveEnterprise applications, parses them, calls the
appropriate Infranet Opcode. The output fields are wrapped in a schema and sent
back to the caller.
Configuration Tab
Drag a Request-Response Service icon to the design panel. Specify the following
options in the Configuration tab:
Name
Enter a unique name for the Request-Response service in this adapter instance.
Description
Enter a description.
Transport Type
Select the Transport Type as Rendezvous or JMS.
The transport can be configured to use a trusted store and identity resource for
use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions
and JMS topics have an SSL configuration field which uses a dialog to perform
SSL configuration. XML allows you to retrieve data as XML documents and
metadata as XML Schemas (XSD).
To enable and configure SSL, in the Project panel, expand the Advanced folder,
then expand the Sessions folder. Select the TIBCO Rendezvous session or JMS
topic and click U s e S S L ? . The SSL configuration options are explained in the
online help associated with the session dialog. Click the question mark to display
the online help.
TIBCO Adapter for Infranet User’s Guide
102
| Adapter Instance Options
Run In Transaction
By default, this check box is not selected. If this check box is not selected, the
adapter service will run all the inbound operations in normal non-transaction
mode. If this check box is selected, all the adapter Request-Response Services
configured under this instance will run in transaction mode. This parameter must
be selected to run the adapter service in the transaction mode.
Click Apply.
TIBCO Adapter for Infranet User’s Guide
Operation Tab 103
|
Operation Tab
This tab is used to create a new operation, modify an existing operation or delete
an operation.
TIBCO Adapter for Infranet User’s Guide
104
| Adapter Instance Options
Click New to create a new operation. The following fields appear
.
TIBCO Adapter for Infranet User’s Guide
Operation Tab 105
|
Click Modify to modify an existing operation. The following fields appear.
TIBCO Adapter for Infranet User’s Guide
106
| Adapter Instance Options
Click Delete to delete an existing operation. The following fields appear.
Transport Tab
Message Transport options can be set for the Request-Response Service
depending on the transport type selected in the Configuration tab of the
Request-Response Service.
The following options are displayed in the Transport tab if Rendezvous is selected
as the transport in the Configuration tab:
Message Subject
By default, a service uses a message subject that is generated using the D o m a i n
and D e p l o y m e n t global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default subject, make sure the values
for D o m a i n and D e p l o y m e n t are not empty. You can type a Rendezvous subject
name different from the default in this field. See TIBCO Rendezvous Concepts for
information about specifying subject names.
TIBCO Adapter for Infranet User’s Guide
Operation Tab 107
|
Reply Message Subject
Reply subject for this Request-Response service.
Quality of Service
If Rendezvous is selected as the transport type, select:
—
Certified
Guarantees that every certified message reaches its intended recipient in
the order sent. The message can be sent across network boundaries, and if
a network fails, delivery attempts continue until delivery succeeds or until
the message's time limit expires. This is often called certified message
delivery.
If certified message delivery is used, data is stored in a ledger file. The size
of the ledger depends on several factors, the most important of which is the
retention rate of stored data. That is, the ledger grows fastest in response to
the cumulative length of undeliverable messages. You must ensure that
sufficient disk space is available for the expected size of the ledger.
—
Reliable
Ensures that each multicast or broadcast message is received as long as the
physical network and packet recipients are working, and that the loss of a
message is detected. This choice can compensate for brief network failures
because it can retransmit a message on request if the first attempt failed.
This choice is appropriate when message delivery is expected but some loss
can be tolerated.
—
Distributed Queue
Indicates load balancing should be enabled. An RVCMQ Session allows
applications to use distributed queues for certified delivery to any number
of listeners using queuing member sessions that act together to process
inbound task messages.
Transactional (RVTX) quality of service is not supported.
Wire Format
Services must use the same wire format to exchange data.
—
ActiveEnterprise Message
Control information for validation is sent in the message. If no control
information is included, an exception is returned to the subscription
service. ActiveEnterprise standard wire format provides class information
and packing rules for the TIBCO Adapter SDK set of data types. This
TIBCO Adapter for Infranet User’s Guide
108
| Adapter Instance Options
format allows ActiveEnterprise components to perform extra validation on
messages sent or received. XML allows you to retrieve data as XML
documents and metadata as XML Schemas (XSD).
See the TIBCO Adapter SDK Programmer’s Guide for details about the control
information generated and sent with ActiveEnterprise messages.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the A d v a n c e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
A screen shot of the Request-Response Service Transport tab with Rendezvous
transport options set is shown next
.
TIBCO Adapter for Infranet User’s Guide
Operation Tab 109
|
The following options are displayed in the Transport tab if JMS is selected as the
transport in the Configuration tab:
Destination
By default a service uses a dynamic destination that is generated using the D o m a i n
and D e p l o y m e n t global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default dynamic destination, make
sure the values for D o m a i n and D e p l o y m e n t are not empty. You can override the
default dynamic destination by specifying the static destination in this field. The
static destination must be defined on the EMS server before it can be used by the
run-time adapter.
See the TIBCO Enterprise Message Service User’s Guide for information about
destinations.
Reply Destination
Reply destination of this Request-Response Service.
Wire Format
The format in which messages are to be published. Different options are
displayed according to the T r a n s p o r t T y p e selected. For JMS mode of transport
only one wire format is available. Publication Service and Subscription Service
can only send and receive data if they agree on a specific wire format. The X M L
M e s s a g e wire format conforms to specifically constructed and fully compliant
XML Schema (XSD) based on the existing definition of the ActiveEnterprise
schema.
Connection Factory Type
—
Topic
A message published to a topic is broadcast to one or more subscription
services. All messages published to the topic are received by all services
that have subscribed to the topic. This messaging model is known as
publish-subscribe.
—
Queue
A message sent to a queue is consumed by one and only one receiver. Each
message has only one receiver though multiple receivers may connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point.
TIBCO Adapter for Infranet User’s Guide
110
| Adapter Instance Options
Delivery Mode
This field is displayed only if T o p i c is selected as the C o n n e c t i o n
Factory Type.
The Request-Response service can be durable or non- durable.
—
Durable
(JMS only)
Durable indicates that the service is registered with the EMS server.
Messages sent to a durable subscription service are held by the EMS server
until they are consumed by the service. The service can be down and expect
to receive its messages when it comes back up.
—
Non Durable
(JMS only)
Non Durable indicates that the service is not registered with the EMS
server. Messages sent to a non-durable subscription service are not held by
the EMS server. If the service is down, it will not receive the messages that
arrived at the EMS server while the service was down.
Messages sent with the durable delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages re-sent in the event of a server failure. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
The semantics for these fields are somewhat more complex than the explanation
given here. See the TIBCO Enterprise Message Service User’s Guide for more
information.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the A d v a n c e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
TIBCO Adapter for Infranet User’s Guide
Operation Tab 111
|
A screen shot of the Request-Response Service Transport tab with JMS transport
options set is shown next.
Schema Tab
The schema options can be set in the Schema tab.
Class Reference
The Class Reference is set automatically depending on the Opcode/query for
which the service has been configured. This field is read-only.
TIBCO Adapter for Infranet User’s Guide
112
| Adapter Instance Options
TIBCO Adapter for Infranet User’s Guide
Request-Response Invocation Service 113
|
Request-Response Invocation Service
The adapter gets a request from Infranet and sends the request through the
TIBCO environment. When a response is returned from the TIBCO environment,
the adapter sends the response back to Infranet.
Configuration Tab
Drag a Request-Response Invocation Service icon to the design panel. Specify
the following options in the Configuration tab:
Name
Enter a unique name for the Request-Response Invocation service in this adapter
instance.
Description
Enter a description.
Transport Type
Select the Transport Type as R e n d e z v o u s or J M S .
The transport can be configured to use a trusted store and identity resource for
use in SSL (Secure Sockets Layer) configurations. TIBCO Rendezvous sessions,
JMS topics and JMS queue sessions have an SSL configuration field which uses a
dialog to perform SSL configuration.
To enable and configure SSL, in the Project panel, expand the Advanced folder,
then expand the Sessions folder. Select the TIBCO Rendezvous session or JMS
topic and click U s e S S L ? . The SSL configuration options are explained in the
online help associated with the session dialog. Click the question mark to display
the online help.
Click Apply.
TIBCO Adapter for Infranet User’s Guide
114
| Adapter Instance Options
Opcode Configure Tab
The settings for the Opcode can be specified in this tab.
Operation Name
Specify the name of the operation.
Opcode Name
Specify the name of the Opcode.
Opcode Flag
Specify the Opcode flag.
TIBCO Adapter for Infranet User’s Guide
Request-Response Invocation Service 115
|
Transport Tab
Message Transport options can be set for the Request-Response Invocation
Service depending on the transport type selected in the Configuration tab of the
Request-Response Invocation Service.
The following options are displayed in the Transport tab if Rendezvous is selected
as the transport in the Configuration tab:
Message Subject
By default, a service uses a message subject that is generated using the D o m a i n
and D e p l o y m e n t global variables, the adapter acronym, the adapter instance
name and the service name. If you use this default subject, make sure the values
for D o m a i n and D e p l o y m e n t are not empty. You can type a Rendezvous subject
name different from the default in this field. See TIBCO Rendezvous Concepts for
information about specifying subject names.
TIBCO Adapter for Infranet User’s Guide
116
| Adapter Instance Options
Reply Message Subject
Reply subject for this Request-Response Invocation service.
Quality of Service
If Rendezvous is selected as the transport type, select:
—
Certified
Guarantees that every certified message reaches its intended recipient in
the order sent. The message can be sent across network boundaries, and if
a network fails, delivery attempts continue until delivery succeeds or until
the message's time limit expires. This is often called certified message
delivery.
If certified message delivery is used, data is stored in a ledger file. The size
of the ledger depends on several factors, the most important of which is the
retention rate of stored data. That is, the ledger grows fastest in response to
the cumulative length of undeliverable messages. You must ensure that
sufficient disk space is available for the expected size of the ledger.
—
Reliable
Ensures that each multicast or broadcast message is received as long as the
physical network and packet recipients are working, and that the loss of a
message is detected. This choice can compensate for brief network failures
because it can retransmit a message on request if the first attempt failed.
This choice is appropriate when message delivery is expected but some loss
can be tolerated.
Transactional (RVTX) quality of service is not supported.
Wire Format
Services must use the same wire format to exchange data.
—
ActiveEnterprise Message
Control information for validation is sent in the message. If no control
information is included, an exception is returned to the subscription
service. ActiveEnterprise standard wire format provides class information
and packing rules for the TIBCO Adapter SDK set of data types. This
format allows ActiveEnterprise components to perform extra validation on
messages sent or received. XML allows you to retrieve data as XML
documents and metadata as XML Schemas (XSD).
See the TIBCO Adapter SDK Programmer’s Guide for details about the control
information generated and sent with ActiveEnterprise messages.
TIBCO Adapter for Infranet User’s Guide
Request-Response Invocation Service 117
|
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the Advanc e d folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
A screen shot of the Request-Response Invocation Service Transport tab with
Rendezvous transport options set is shown next.
The following options are displayed in the Transport tab if JMS is selected as the
transport in the Configuration tab:
TIBCO Adapter for Infranet User’s Guide
118
| Adapter Instance Options
Destination
By default, a service uses a dynamic destination that is generated using the
D o m a i n and D e p l o y m e n t global variables, the adapter acronym, the adapter
instance name and the service name. If you use this default dynamic destination,
make sure the values for D o m a i n and D e p l o y m e n t are not empty. You can override
the default dynamic destination by specifying the static destination in this field.
The static destination must be defined on the EMS server before it can be used by
the run-time adapter.
See the TIBCO Enterprise Message Service User’s Guide for information about
destinations.
Reply Destination
Reply destination of this Request-Response Invocation Service.
Wire Format
The format in which messages are to be published. Different options are
displayed according to the T r a n s p o r t T y p e selected. For JMS mode of transport
only one wire format is available. Publication Service and Subscription Service
can only send and receive data if they agree on a specific wire format. The X M L
M e s s a g e wire format conforms to specifically constructed and fully compliant
XML Schema (XSD) based on the existing definition of the ActiveEnterprise
schema.
Connection Factory Type
—
Topic
A message published to a topic is broadcast to one or more Subscription
Services. All messages published to the topic are received by all services
that have subscribed to the topic. This messaging model is known as
publish-subscribe.
—
Queue
A message sent to a queue is consumed by one and only one receiver. Each
message has only one receiver though multiple receivers may connect to
the queue. The first receiver to access the queue gets the message. The other
receivers do not. This messaging model is known as point-to-point.
Delivery Mode
The delivery mode for the message. There are two options to choose from:
TIBCO Adapter for Infranet User’s Guide
Request-Response Invocation Service 119
|
•
Persistent — indicates that the message will be available to an EMS client even
if the EMS server goes down.
•
Non-persistent — indicates that the message will not be available to an EMS
client if the EMS server goes down.
Messages sent with the durable delivery mode are always written to persistent
storage, except when they are published to a topic that has no durable
subscribers. When a topic has no durable subscribers, there are no subscribers
that need messages re-sent in the event of a server failure. Therefore, messages do
not need to be saved, and performance is improved because disk I/O is not
required.
The semantics for these fields are somewhat more complex than the explanation
given here. See the TIBCO Enterprise Message Service User’s Guide for more
information.
Session Reference
When you create a service, TIBCO Designer creates a corresponding session
resource in the Sessions folder of the Advanced folder and displays it in this field.
If you have explicitly created a custom session of the same type, you can click the
Browse icon to replace the auto-created session.
Endpoint Reference
An endpoint reference for the service. This is a disabled field and points to the
corresponding endpoint resource in the S e s s i o n s folder of the A d v a n c e d folder.
The endpoint resource is automatically created by TIBCO Designer.
TIBCO Adapter for Infranet User’s Guide
120
| Adapter Instance Options
A screen shot of the Request-Response Invocation Service Transport tab with JMS
transport options set is shown next.
Schema Tab
The schema options can be set in the Schema tab.
Class Reference
The Class Reference is set automatically to the operation class created for this
service. This field is read-only.
TIBCO Adapter for Infranet User’s Guide
Request-Response Invocation Service 121
|
Custom DM Invocation Tab
The parameters for the Custom Data Manager can be specified in this tab.
Custom DM Subject
Specify the subject for the Custom Data Manager that is to be associated with this
Request-Response Invocation Service.
Client Timeout
Specify the time interval after which the request times out. The time interval that
the client has to wait for the response from the external application.
TIBCO Adapter for Infranet User’s Guide
122
| Adapter Instance Options
TIBCO Adapter for Infranet User’s Guide
Saving the Project 123
|
Saving the Project
Configuration information for an adapter instance and all other parameter
settings related to the adapter instance are saved as a TIBCO Designer project.
You can save the project any time during configuration. Each time you save a
project, any configuration information you have entered is saved as a multi-file
project.
For details on saving a project, see the TIBCO Designer User’s Guide.
TIBCO Adapter for Infranet User’s Guide
124
| Adapter Instance Options
Testing the Adapter
To test the adapter, start it after configuring it and check for correct messaging.
You can configure the adapter as desired, then start it as described in Start or Stop
the Adapter on page 160. If your preparations and configuration are successful,
the adapter will connect to Infranet and messaging will indicate no errors.
TIBCO Adapter for Infranet User’s Guide
| 125
Chapter 5
Configuring Advanced Settings
This chapter explains how to configure an adapter with advanced options.
Topics
•
Overview, page 126
•
Defining a TIBCO Hawk Session, page 127
•
Using Global Variables, page 128
•
Using the Adapter with a Revision Control System, page 133
•
Enabling Event Publishing in Infranet, page 135
•
Custom Opcode Configuration, page 155
TIBCO Adapter for Infranet User’s Guide
126
| Configuring Advanced Settings
Overview
Advanced configuration options are available in the palette so that you can refine
and enhance various adapter operations. There are advanced configuration
options for monitoring, using the adapter with the revision control system,
configuring a remote adapter , using global variables and enabling event
publishing in Infranet. All of these options are described in this chapter.
TIBCO Adapter for Infranet User’s Guide
Defining a TIBCO Hawk Session 127
|
Defining a TIBCO Hawk Session
A default TIBCO Rendezvous session, H a w k S e s s i o n is defined in the project
whenever a new instance of the adapter is configured. You can use this session to
monitor the adapter using TIBCO Hawk. Use the following steps to modify the
parameters of this default session.
1. In the project tree panel, click the Infranet Adapter Configuration icon
defined for your adapter instance.
2. Select the Advanced>Sessions>InfranetHawkDefault.
3. The default values in the Service, Network and Daemon fields are 7 4 7 4 , None
and t c p : 7 4 7 4 . These values are specified in the global variables. Change the
default values if required and click Apply. The screen shot of the default
HawkSession is given next.
TIBCO Adapter for Infranet User’s Guide
128
| Configuring Advanced Settings
Using Global Variables
The variable substitution mechanism can override global variables predefined in
the project in a restricted manner. Predefined variables can be viewed and set in
TIBCO Designer. Variables are specified as % % V A R N A M E % % and cannot contain any
white space.
Global variable substitution allows you to accomplish the following.
•
Substitute global variables specified in the project at startup time.
•
Locally define the value for a global variable for a specific project. The local
value takes precedence over any global value.
•
Specify the value for a variable in the a d i n f r a . t r a file. This overrides the
project repository.
•
Enforce the predefined variables listed in Predefined Global Variables on
page 130.
Global variables can be used anywhere in the configuration and will be
replaced by the values specified in the Global Variables tab.
Variable Specification
You can specify variables:
•
In the project during configuration using TIBCO Designer
•
In a properties file
Properties file values overwrite values set in the project.
Specifying Variables Using TIBCO Designer
Global variables provide an easy way to set variable values for use throughout
your project across multiple adapter instances.
For example, you can assign the value 7474 to the predefined global variable
R v D a e m o n . You can then use the variable in different sessions in your adapter. If
you wish to change the TIBCO Rendezvous daemon for your adapter, you can
globally set it to a different value or override it from the . t r a file.
TIBCO Adapter for Infranet User’s Guide
Using Global Variables 129
|
To use global variables in your project, follow these steps:
1. In TIBCO Designer, click the Global Variables tab. The window is shown next
.
The project panel is updated to display all currently defined global variables.
You now have these choices:
— To assign or change a variable value, select that region and click the Open
Advanced Editor button and specify the values for the variable. The
variable expands so you can change either the variable name or the variable
value. Press Enter when you are done.
— To add a new global variable group, click the icon on the extreme left.
Specify the name of the group, then press Enter. With the group icon
selected, you can click the abc icon to add variables to the group.
— To add a global variable, click the abc icon. A new global variable item is
added to the bottom of the list. Supply the variable name and, optionally,
the value. Press Enter when you are done.
The global variable is now displayed in the global variables list.
2. When you want to use the global variable in the fields of a resource, enter the
variable name surrounded by % % on both sides.
When the project is deployed and the configured components are run, all
occurrences of the global variable name are replaced with the global variable
value (unless it was overridden in a way that had higher precedence).
A number of global variables are predefined. See Predefined Global Variables on
page 130 for information. You may add definitions of any new variables you need
to the existing list.
TIBCO Adapter for Infranet User’s Guide
130
| Configuring Advanced Settings
Predefined Global Variables
The next table lists and explains the predefined global variables. Some global
variables are automatically used within the system when an adapter instance is
configured.
Table 5 Predefined Global Variables
Variable
Description
Deployment
Defaults to the TIBCO Designer project name. This
global variable is used by TIBCO Designer 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.
DirLedger
Used by the system when defining the path name of
the TIBCO Rendezvous certified messaging ledger file.
The default is root installation directory.
DirTrace
Used by TIBCO Designer to partially create the path
name for log file used by the adapter. The default is the
root installation directory.
Domain
The default value is M y D o m a i n . This value can be any
string value. This global variable is used by the system
to partially define the subject name defined for a
service.
Env
Included for backward compatibility. Do not use.
HawkEnabled
Used by the adapter to indicate whether TIBCO Hawk
is used to monitor the adapter. T r u e indicates that a
TIBCO Hawk microagent is defined for the adapter.
F a l s e indicates the microagent is not to be used.
JmsSslProviderUrl
RemoteRvDaemon
TIBCO Adapter for Infranet User’s Guide
Defines where the JMS SSL daemon is located.
Used by the adapter to identify the TIBCO
Rendezvous routing daemon. See TIBCO Rendezvous
Administration for details about specifying the routing
daemon name.
Using Global Variables 131
|
Table 5 Predefined Global Variables
Variable
Description
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
TIBCO Rendezvous daemon and establish
communication. The default value is 7 5 0 0 , which is
the default value used by the TIBCO 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 machines 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.
RvService
Used by the system to identify the TIBCO Rendezvous
service parameter. The TIBCO 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. See TIBCO Rendezvous Concepts
for details about specifying the service parameter.
RvaHost
Used by the system to identify the machine on which
the TIBCO Rendezvous agent runs. See TIBCO
Rendezvous Administration for details about specifying
the r v a 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 r v a
parameters.
TIBHawkDaemon
Used by the system to identify the TIBCO Hawk
daemon parameter. See the TIBCO Hawk Installation
and Configuration manual for details about this
parameter.
TIBCO Adapter for Infranet User’s Guide
132
| Configuring Advanced Settings
Table 5 Predefined Global Variables
Variable
Description
TIBHawkNetwork
Used by the system to identify the TIBCO Hawk
network parameter. See the TIBCO Hawk Installation
and Configuration manual for details about this
parameter.
TIBHawkService
Used by the system to identify the TIBCO service
parameter. See the TIBCO Hawk Installation and
Configuration manual for details about this parameter.
TIBCO Adapter for Infranet User’s Guide
Using the Adapter with a Revision Control System 133
|
Using the Adapter with a Revision Control System
TIBCO Designer supports revision control systems such as Microsoft Visual
SourceSafe and Perforce. If you are using a revision control system, you must
manually add some configured resources to the revision control system and check
in the resources when completing the instance configuration.
As part of service configuration, the adapter creates schema files in
r o o t / A E S c h e m a s / a e / I n f r a n e t . For example, if you configure a service in
I n f r a n e t A d a p t e r C o n f i g u r a t i o n , the following files are created:
Project_root /AESchemas/ae/Infranet/tdschmea.aeschema
Project_root /AESchemas/ae/Infranet/tdschmea(folder)
Project_root
/AESchemas/ae/Infranet/InfranetAdapterConfiguration.aeschema
Project_root
/AESchemas/ae/Infranet/InfranetAdapterConfiguration(folder)
where I n f r a n e t A d a p t e r C o n f i g u r a t i o n is the adapter configuration.
The following images show the above-mentioned folders in a Revision Control
System:
Figure 9 The ’Infranet’ folder in a Version Control System
TIBCO Adapter for Infranet User’s Guide
134
| Configuring Advanced Settings
When the project is saved and a revision control system has been specified, the
adapter displays a warning that additional files were created and should be
added to the revision control system. This warning appears only when the files
are created for the first time. The warning displays a Go To Resource button that
helps in navigating to the resource. You should use the M u l t i - U s e r > A d d
R e s o u r c e s t o R C S menu command to add these files to the revision control
system
.
For information about how to be used the Multi-User feature in TIBCO Designer,
refer to the TIBCO Designer User’s Guide.
Copy, Cut, Paste and Move Operations
To successfully copy and paste a service from adapter Instance1 to Instance2, the
adapter configuration and schema files for the Instance2 must be checked out.
To successfully cut and paste a service from adapter Instance1 to Instance2, the
adapter configuration and schema files for both Instance1 and Instance2 must be
checked out.
To successfully move a service from adapter Instance1 to Instance2, the adapter
configuration and schema files for both Instance1 and Instance2 must be checked
out.
TIBCO Adapter for Infranet User’s Guide
Enabling Event Publishing in Infranet 135
|
Enabling Event Publishing in Infranet
To enable the adapter to publish messages from Infranet, the Infranet EAI
framework must be installed on the Infranet Application. Following are the steps
to install the Infranet EAI framework on the Infranet Application:
1. Copy the T i b E A I C o n f i g . i n i file:
On UNIX, from the $ { T I B C O _ A D I N F R A _ H O M E } / l i b directory to the
$ P O R T A L _ H O M E / s y s / d m _ e a i directory.
On Windows, from the < % T I B C O _ A D I N F R A _ H O M E % > \ l i b directory to the
< % P O R T A L _ H O M E % > \ s y s \ d m _ e a i directory.
Modify the file to include the following arguments:
Entry
Description
TibPub_Service
Service group for this session. If not given, the
default TIBCO Rendezvous service is used.
TibPub_Network
Specifies the network to use. If not given, the
primary network interface for the host computer is
used. Use this attribute on computers with more
than one network interface to specify the interface
to use.
TibPub_Daemon
Specifies the TIBCO Rendezvous daemon for this
session. If not specified, the default port 7500 is
used.
TibPub_PubSubject
TIBCO Rendezvous subject name to be used. For
example, E A I . P u b l i s h i n g .
TibPub_sendercmName
Specifies the CM Name used by the EAI Plugin
Certified message Publisher. Any unique name can
be given. The default value is E A I P L U G I N S e n d e r.
TibPub_ledgerName
Specifies the file name for file-based ledger for the
Certified message publisher. The default value is
e a i p l u g i n . l d r.
TibPub_listenercmNa
me
Specifies the CM Name of Certified Message
Subscriber in the adapter which is listening for the
messages published by the EAI Plugin. The default
value is E A I P L U G I N .
TIBCO Adapter for Infranet User’s Guide
136
| Configuring Advanced Settings
2. Change the p a y l o a d c o n f i g . x m l file publisher format to F L I S T. For example:
<Publisher DB="0.0.9.1" Format="FLIST">
On UNIX, the file is located in $ P O R T A L _ H O M E / s y s / e a i _ j s
On Windows, the file is located in % P O R T A L _ H O M E % \ s y s \ e a i _ j s
3. Copy the E A I P l u g i n library
On HP-UX, copy $ { I N F _ A D A P T E R _ H O M E } / b i n / E A I P l u g i n . s l to
$PORTAL_HOME/sys/dm_eai
On Solaris, copy $ { T I B C O _ A D I N F R A _ H O M E } / l i b / E A I P l u g i n . s o to
$PORTAL_HOME/sys/dm_eai
On Windows, copy %
TIBCO_ADINFRA_HOME %\bin\EAIPlugin.dll
to
%PORTAL_HOME%\sys\dm_eai
4. Register the EAIPlugin plugin. The plugin generates the p l u g i n . l o g file in
the d m _ e a i directory. The file is used to trace errors while publishing.
On HP-UX 11.x/11i, modify the $ P O R T A L _ H O M E / s y s / d m _ e a i / p i n . c o n f file to
register the plugin. For example:
- dm plugin_name ./EAIPlugin.sl
On HP-UX 11i v2/11.23,modify the $ P O R T A L _ H O M E / s y s / d m _ e a i / p i n . c o n f
file to register the plugin. For example:
- dm plugin_name ./EAIPlugin.so
On Solaris, modify the $ P O R T A L _ H O M E / s y s / d m _ e a i / p i n . c o n f file to register
the plugin. For example:
- dm plugin_name ./EAIPlugin.so
On Windows, modify the % P O R T A L _ H O M E % \ s y s \ d m _ e a i \ p i n . c o n f file to
register the plugin. For example:
- dm plugin_name ./EAIPlugin.dll
5. Make sure you have TIBCO Rendezvous installed on the machine on which
you are running d m _ e a i .
On HP-UX add the following lines to the $ P O R T A L _ H O M E / b i n / s t a r t _ d m _ e a i
file, after the PATH variable.
export SHLIB_PATH = ${SHLIB_PATH}:${RV_HOME}/lib
export LD_PRELOAD =
/usr/lib/libcl.2:/usr/lib/libpthread.1:/usr/lib/libc.2
The L D _ P R E L O A D command pre-loads the thread libraries.
TIBCO Adapter for Infranet User’s Guide
Transaction Handling 137
|
Transaction Handling
TIBCO Adapter for Infranet provides an option to run Request-Response service
in transaction mode. Both opcode and query are supported in the
Request-Response Service to be run in transaction mode. When the adapter
comes up, it establishes the configured number of connections with Infranet. The
adapter maintains these connections in a main connection queue for it to use them
for normal non-transaction operations.
When the adapter receives non-transaction inbound requests, the adapter thread
that receives the message picks up a free connection from the main connection
queue, and uses it for further processing of the request. After the message is
processed, the adapter thread places back the connection in the main connection
queue so that the connection can be used by other threads.
Transaction handling is not supported with RVCMQ transport.
The above mentioned method is used by the adapter for non-transaction type
requests. But the process/method used by the adapter is different when
processing a transaction type request - which is described below:
When the Request-Response Service of the adapter detects that the message
received is of type T r a n s a c t i o n , it clones a new connection using any of the free
connections available in the main connection queue. Cloning of a connection in
Infranet is similar to opening a new connection.
The reason for cloning a connection for transaction request instead of using a free
connection available in the connection queue is to improve the adapter
performance in a multithreaded adapter environment. After the adapter clones a
connection, it uses the same to open a transaction with Infranet, associates a
c o n n e c t i o n _ i d for the connection, puts the c o n n e c t i o n _ i d and the connection
in a transaction connection queue map, and returns the c o n n e c t i o n _ i d in the
reply sent. You can use the c o n n e c t i o n _ i d for further operations that need to be
carried out in the same transaction.
Using the c o n n e c t i o n _ i d given in the request sent to the adapter for executing
operations within transaction, the adapter picks up the corresponding connection
from the transaction connection queue, uses it for the Infranet operations, and
sends the c o n n e c t i o n _ i d in the reply after putting the connection back to
transaction connection queue. When the adapter detects that a transaction needs
to be committed or rolled back based on the corresponding value mentioned in
the request, it commits or rolls back the transaction accordingly using the
c o n n e c t i o n _ i d mentioned, and closes the connection.
TIBCO Adapter for Infranet User’s Guide
138
| Configuring Advanced Settings
Important Transaction Parameters
Run In Transaction
This is a design-time parameter available for the Request-Response Service of the
adapter. This field is available in the Configuration tab of the adapter instance. By
default, this check box is not selected. If this check box is not selected, the adapter
service will run all the inbound operations in normal non-transaction mode. If
this check box is selected, all the adapter Request-Response Services configured
under this instance will run in transaction mode. This parameter must be selected
to run the adapter service in the transaction mode. However this parameter value
can be overwritten during run-time so that though the Request-Response Services
are configured for transaction, any of the services can be run in normal
non-transaction mode. This can be done by using the r u n _ i n _ t r a n s a c t i o n field
of run-time in the TIBCO IntegrationManager or TIBCO BusinessWorks mapping.
A sevice configured for non-transaction mode cannot be run in transaction mode
using the r u n _ i n _ t r a n s a c t i o n field. If the Run in Transaction check box is not
selected, the r u n _ i n _ t r a n s a c t i o n field will not be available in the TIBCO
IntegrationManager or TIBCO BusinessWorks mapping.
TIBCO Adapter for Infranet User’s Guide
Transaction Handling 139
|
Transaction Connection timeout:
This is a design-time parameter available for adapter Request-Response service.
This field is available at Services tab of the adapter instance. The value mentioned
in this field decides the lifetime of connections kept in the Transaction
Connections Queue. During run-time, after a connection is put in the transaction
connection queue after executing a transaction operation, if it is not used for any
other transaction operations for the specified number of milliseconds i.e. if the
connection is kept idle for that time period, the connection will automatically be
removed from the transaction connection queue and the transaction opened using
the connection will be aborted. This feature is to ensure that no transaction is kept
idle for infinite time.
If the value of 30000 milliseconds is specified during configuration, the time
interval between successive transaction operations of a particular transaction
should not exceed 30 seconds during run-time. If the time interval between
successive transaction operations of a particular transaction exceeds 30 seconds
the transaction will be aborted. This value can be specified as required.
TIBCO Adapter for Infranet User’s Guide
140
| Configuring Advanced Settings
Max number of concurrent transactions that can be opened:
This is a design-time parameter available for Request-Response service of the
adapter. This field is available in the Services tab. The value mentioned in this
field decides the maximum number of transactions that can be opened or in
process at a given point of time. For every new transaction, the adapter opens a
new connection with Infranet. The adapter checks the current number of
transactions that are opened or in process. If the current number of opened
transaction is equal to the configured max number of concurrent transactions that
can be opened, the adapter will not open a new transactions, and it will display an
error. In this case, a new transaction can be opened only if any of the current
opened transactions are committed or rolled back.
If the value of 5 mentioned during configuration, the adapter can have a
maximum of 5 transactions opened at any point during run-time. Suppose the
first transaction is opened and is being processed. At the same time if the adapter
receives a request to open a new transaction it will open the transaction
successfully. Similarly, three more new transaction can be opened. Now if the
adapter receives a request to open the 6th transaction (transactions one to five are
not closed), the adapter will not open the 6th transaction. This value can be
specified as required.
TIBCO Adapter for Infranet User’s Guide
Transaction Handling 141
|
transaction_type
This is a run-time parameter available for the Request-Response Service. This
field is available in TIBCO IntegrationManager or TIBCO BusinessWorks process
during run-time. In this field you must specify S T A R T for starting a transaction,
E N D for ending a transaction. If no field is specified, it will be taken as an
operation inside a transaction. If R O L L B A C K has been specified, the transaction
shall be roll backed.
connection_id
This is a run-time parameter available for the Request-Response service. This field
is available in TIBCO IntegrationManager or TIBCO BusinessWorks process
during run-time. If you specify S T A R T as the value in transaction type field, the
adapter creates a new connection for transaction and associates a c o n n e c t i o n _ i d
for the cloned connection. This c o n n e c t i o n _ i d will be returned in the reply sent
by the adapter to the sender of the request. For other operations that need to be
executed inside the transaction (including the C O M M I T or R O L L B A C K transaction
operations), the same c o n n e c t i o n _ i d needs to be provided in the request.
The c o n n e c t i o n _ i d returned by the adapter will be available on c o n n e c t i o n _ i d
field of the reply schema of TIBCO IntegrationManager or TIBCO BusinessWorks
process. The c o n n e c t i o n _ i d that needs to be provided to the adapter is to be
mentioned in c o n n e c t i o n _ i d field of the request schema of TIBCO
TIBCO Adapter for Infranet User’s Guide
142
| Configuring Advanced Settings
IntegrationManager or TIBCO BusinessWorks process. For transaction requests
other than of type S T A R T transaction, if no value is mentioned/mapped to the
c o n n e c t i o n _ i d field of the request schema, the adapter will not be able to
process the transaction request and will throw an error.
run_in_transaction
This is a run-time parameter available for the Request-Response service. This field
is available in TIBCO IntegrationManager or TIBCO BusinessWorks process
during run-time. The value of the field has to be specified as 1 (TRUE). If you
want to run a specific operation in non-transaction mode (which is configured to
run in transaction mode), you can change the value of this field to 0 (FALSE) in
TIBCO IntegrationManager or TIBCO BusinessWorks mapping. All the requests
coming from this operation will be processed like any other normal
Request-Response service request by the adapter, and not as a transaction request.
If r u n _ i n _ t r a n s a c t i o n is set to 0 (FALSE), values specified in the
t r a n s c a t i o n T y p e and c o n n e c t i o n _ i d fields will be ignored.
TIBCO Adapter for Infranet User’s Guide
Transaction Handling 143
|
TIBCO Adapter for Infranet User’s Guide
144
| Configuring Advanced Settings
Query Operation
Infranet Object Search Strategy
Infranet supports searching database for storable objects that meet a specific
criteria.
There are two main types of searching supported by Infranet:
•
Simple searching on a single class and its inherited classes. For example,
searching for a specific account involves searching for /account storable class
that meets the specific criteria.
•
Complex searching across multiple classes at the same time. For example,
searching for all accounts located in a specific city that used a specific service,
includes both the /account and /service classes.
These searches can be carried out on one or more databases, depending on the
requirement.
Infranet provides the following search Opcodes to facilitate Object search:
•
PCM_OP_SEARCH - Searches for storable objects in a single Infranet
database.
•
PCM_OP_STEP_SEARCH - Searches for storable objects in a single Infranet
database and returns the result in discrete chunks. This opcode must be used
in combination with the PCM_OP_STEP_NEXT and PCM_OP_STEP_END
opcodes to complete a search cycle. The cycle must start with
PCM_OP_STEP_SEARCH which initiates a step search and gets the first set of
PIN_FLD_RESULT elements. One or more PCM_OP_STEP_NEXT opcodes
follow, each retrieving the next specified number of result sets.
PCM_OP_STEP_END must come last, and ends the step search.
•
PCM_OP_GLOBAL_SEARCH - Searches for storable objects across multiple
databases.
•
PCM_OP_GLOBAL_STEP_SEARCH - Allows step search for storable objects
across multiple databases.
Adapter Query operation
Adapter Subscription and Request-Response services support Query operation in
addition to Opcode execution. Query operation allows single database search for
storable objects. The adapter calls the PCM_OP_SEARCH opcode to execute
Query operation.
TIBCO Adapter for Infranet User’s Guide
Query Operation 145
|
PCM_OP_SEARCH opcode allows the adapter to search for storable objects in a
single Infranet database that meet a set of criteria defined by the client
application. The search criteria are passed in by the adapter in the input FLIST.
Input FLIST for this opcode must contain the following fields:
•
PIN_FLD_POID - Search POID. The search POID identifies the search
template to be used. The search criteria can be predefined as search templates
and stored in a /search storable object in the Infranet database. The POID ID
specifies which predefined search template to be used. For example, if you use
a predefined search template , the input FLIST field would look like:
0 PIN_FLD_POID
POID [0] 0.0.0.1 /search 301 0
If the search template is defined at run-time, you add the search object POID
to the input FLIST with an object ID of 0, and define the search query in a
PIN_FLD_TEMPLATE field on the input FLIST. In this case the field would
look like:
0 PIN_FLD_POID
POID [0] 0.0.0.1 /search 0 0
•
PIN_FLD_ARGS - Array containing the argument list. You specify the
arguments for the search query in the PIN_FLD_ARGS array. Each array
element contains one argument. The arguments in the PIN_FLD_ARGS array
are referenced in the W H E R E clause of the search query.
•
PIN_FLD_RESULTS - Array containing fields to be returned by the search.
When search template is to be defined at run-time, two more fields are required:
•
PIN_FLD_TEMPLATE - Specifies the search query in the form of a string. The
template is in the form of an SQL-like search string. For example, "select X
from <object> where <expression>".
•
PIN_FLD_FLAGS - Specifies the type of search to perform.
•
PIN_FLD_PARAMETERS - When you use a predefined search template, you
can use an optional $1 object type parameter in the ’ F R O M ’ clause of the search
query. This parameter specifies a subclass and allows you to specialize the
search without having to modify the stored template.
PIN_FLD_PARAMETERS field needs to be specified when you use the $1
optional parameter in the ’ F R O M ’ clause. The $1 parameter in the search
template is replaced by the value of the PIN_FLD_PARAMETERS field on the
input FLIST.
Adapter query operation supports only search queries. It does not support
pre-defined search templates. When the adapter QUERY operation is used, you
do not have an option to specify PIN_FLD_RESULTS array. The adapter passes
NULL value for PIN_FLD_RESULTS array in the input FLIST and as a result all
fields in matched storable object are returned.
TIBCO Adapter for Infranet User’s Guide
146
| Configuring Advanced Settings
At design-time you need to specify the following options for configuring a query
operation:
•
Query Name - Name to identify the query operation to be performed
•
Search Template - SQL like search query string. The following syntax should
be used for search queries SELECT X FROM OBJECT_NAME WHERE
EXPRESSION , where
— X is a placeholder for the field(s) being requested.
— OBJECT_NAME is the name of the storable object that contains the
argument(s). The storable object name has to be fully specified. The adapter
does not support optional parameters in the object name.
— EXPRESSION is an SQL expression such as W H E R E F 1 = V 1 and F 2 = V 2 .
The column names and literal values (Fn and Vn) are replaced by the field
names and field values specified in the PIN_FLD_ARGS array on the input
FLIST. The column name and value indexes must be contiguous and
correspond with the elements in the arguments array starting with element
ID 1. That is, F 1 and V 1 correspond to the field name and value in
PIN_FLD_ARGS[1], F 2 and V 2 to the field name and value in
PIN_FLD_ARGS[2], and so on.
Make sure you insert a space after the Fn and Vn. The Fn and the Vn always need
a space before and after them.
•
Storable Class - The storable object to be queried.
•
Search Flag - Flag specifying the type of search to be performed. Supported
values are SRCH_DISTINCT and SRCH_EXACT
The value for the Search flag should be an integer. Example: To search for ALL
ROWS you need to enter 0. Refer to the following table for details on other valid
values.
Search Flag
Value
SRCH_DISTINCT
256
SRCH_EXACT
512
SRCH_EXACT and SRCH_DISTINCT can be combined by
adding their flag values
768
To return all values
0
TIBCO Adapter for Infranet User’s Guide
Query Operation 147
|
On applying this query options, the adapter palette will fetch the storable object
schema from Infranet and create the Query output schema. At design-time user
will have an option to filter out fields in the output FLIST.
Input schema for a Query operation will consist of Parameter-Value list
corresponding to the search query arguments. This is show in the screen below.
The adapter creates PIN_FLD_ARGS array at run-time based on the
Parameter-Value list in the input schema.
TIBCO Adapter for Infranet User’s Guide
148
| Configuring Advanced Settings
In TIBCO Adapter for Infranet 4.x, a field name was specified as PIN_FLD_POID.
In 5.x version of the adapter, it has to be specified in the format F l d P o i d .
TIBCO Adapter for Infranet User’s Guide
Invoking Custom Data Manager through Request-Response Invocation Service 149
|
Invoking Custom Data Manager through Request-Response
Invocation Service
This service allows interaction between the adapter and external applications
other than the Infranet.
•
The portal client requests for information from the external application.
•
This request is sent to the adapter through the Custom Data Manager
(d m _ g e n e r i c . d l l for Windows, d m _ g e n e r i c . s o for Solaris , d m _ g e n e r i c . s l
for HP-UX 11.x/11i and d m _ g e n e r i c . s o for HP-UX 11i v2/11.23).
•
The Custom Data Manager sends the request to the adapter using the
RPCCLIENT.ini.
•
The adapter receives the request and sends it to the external application
through TIBCO Rendezvous (or TIBCO Enterprise Message Service).
•
The external application queries for the required data and sends it back to the
adapter through TIBCO Rendezvous (or TIBCO Enterprise Message Service).
•
The adapter sends the reply to portal client.
Configuration for Infranet:
When the portal client (or any client) interacts with Infranet, the Connection
Manager creates a connection to Data Manager.
Specify the following environment variables on the machine where the Custom
Data Manager exists:
•
for Microsoft Windows, specify the c l a s s p a t h as < T I B C O _ H O M E > \ t i b r v \ l i b
•
for Solaris, specify the L D _ L I B R A R Y _ P A T H as < T I B C O _ H O M E > / t i b r v / l i b
•
for HP-UX, specify the S H L I B _ P A T H as < T I B C O _ H O M E > / t i b r v / l i b
The Connection Manager points to a particular Data Manager depending on the
Data Manager pointer present in the POID of the Input FLIST of the opcode
executed.
1. Copy the d m _ g e n e r i c . d l l and R P C C L I E N T . i n i both at the same location .
(d m _ g e n e r i c . s o for Solaris and d m _ g e n e r i c . s l for HP-UX)
2. Modify the contents of the R P C C L I E N T . i n i file as required and provide the
value for the following parameters:
- Tib_Service 7500
- Tib_Network
TIBCO Adapter for Infranet User’s Guide
150
| Configuring Advanced Settings
- Tib_Daemon tcp:7500
- Tib_Subject TEST.CLIENT
- Tib_Timeout 60000 (Timeout for Portal Client response)
3. Create the service in Windows or process in Unix using the steps as described
in Infranet Documentation. Refer Writing a custom Data Manager in the
Customizing Portal server component chapter of Infranet Programmer's Guide.
4. The Data Manager pointer has to be registered in the p i n . c o n f file of the
Connection Manager.
for example, P o i d
Data Manager.
Poid
- 0.0.200.1
- 0.0.0.1 /account 1269149
/account 1269149
will point to the Oracle
will point to Custom Data Manager.
Perform the following configuration tasks based on the platform you are using:
Microsoft Windows Platform
1. Create a folder named d m _ g e n e r i c
under <INFRANET_HOME>\sys
folder
2. Copy dm_oracle.exe <INFRANET_HOME>\bin under folder, and paste in
the same location and rename it to dm_generic.exe
3. Copy pin.conf file from <INFRANET_HOME>\sys\dm_oracle to dm_generic
folder
4. Copy the dll to dm_generic folder.
5. Following changes are to be done in dm_generic pin.conf file
— Modify the dm_logfile entry
dm dm_logfile
C:/Infranet/var/dm_generic/dm_generic.pinlog
— Modify dm_sm_obj entry
dm dm_sm_obj C:/Infranet/sys/dm_generic/dm_generic.dll
— Modify dm_db_no entry
dm dm_db_no 0.0.100.0 / 0
— Modify dm_port to the corresponding value mentioned in dm_pointer
entry of cm's pin.conf
dm dm_port 11950
6. Add new dm_pointer entry with different port number similar to default
dm_pointer entry in the cm pin.conf file
cm dm_pointer 0.0.100.0 ip blrkec41009d 11950
TIBCO Adapter for Infranet User’s Guide
Invoking Custom Data Manager through Request-Response Invocation Service 151
|
7. Add the Windows service for the dm_generic service using the following
example command:
addserv -t dm_generic -n GenericDM -l "Infranet Base CustomDM"
-e C:\Infranet\bin\dm_generic.exe -w
C:\Infranet\sys\dm_generic
8. Copy the .ini file to d m _ g e n e r i c folder.
9. Start the Windows service.
10. Stop the Windows service.
HP-UX Platforms:
1. Make sure that all the files/folders created in the below stes are given 777
permission
2. Create a folder named dm_generic under < I N F R A N E T _ H O M E > / s y s folder
3. Copy dm_oracle execuatable < I N F R A N E T _ H O M E > / b i n under folder, and paste
in the same location and rename it to d m _ g e n e r i c .
4. Copy p i n . c o n f file from < I N F R A N E T _ H O M E > / s y s / d m _ o r a c l e to dm_generic
folder
5. Copy the . s l to d m _ g e n e r i c folder.
6. Following changes to be done in c m
pin.conf
file
Add new d m _ p o i n t e r entry with different port number similar to default
dm_pointer entry c m d m _ p o i n t e r 0 . 0 . 1 0 0 . 0 i p t r i s h u l 1 1 9 5 0
7.
Following changes to be done in d m _ g e n e r i c
pin.conf
file
— Modify the d m _ l o g f i l e entry
dm dm_logfile /var/portal/7.0/dm_generic/dm_generic.pinlog
— Modify dm_sm_obj entry
dm dm_sm_obj /opt/portal/7.0/sys/dm_generic/dm_generic.sl
— Modify d m _ d b _ n o entry
dm dm_db_no 0.0.100.0 / 0
— Modify d m _ p o r t to the corresponding value mentioned in
entry of cm's pin.conf
dm_pointer
dm dm_port 11950
8. Copy the s t a r t _ d m _ o r a c l e available under / o p t / p o r t a l / 7 . 0 / b i n folder
and save as s t a r t _ d m _ g e n e r i c .
9. Replace all o r a c l e words with g e n e r i c in the file s t a r t _ d m _ g e n e r i c .
TIBCO Adapter for Infranet User’s Guide
152
| Configuring Advanced Settings
10. Copy the s t o p _ d m _ o r a c l e available under / o p t / p o r t a l / 7 . 0 / b i n folder and
save as s t o p _ d m _ g e n e r i c .
11. Replace all o r a c l e words with g e n e r i c in the file s t o p _ d m _ g e n e r i c .
12. Copy the .ini file to d m _ g e n e r i c folder.
13. Start the service by running the excutable s t a r t _ d m _ g e n e r i c .
14. Stop the service by running the excutable s t o p _ d m _ g e n e r i c .
Solaris Platforms:
1. Make sure that all the files/folders created in the below stes are given 777
permission
2. Create a folder named dm_generic under < I N F R A N E T _ H O M E > / s y s folder
3. Copy dm_oracle execuatable < I N F R A N E T _ H O M E > / b i n under folder, and paste
in the same location and rename it to d m _ g e n e r i c .
4. Copy p i n . c o n f file from < I N F R A N E T _ H O M E > / s y s / d m _ o r a c l e to d m _ g e n e r i c
folder
5. Copy the . s o to d m _ g e n e r i c folder.
6. Following changes to be done in c m
pin.conf
file
Add new d m _ p o i n t e r entry with different port number similar to default
dm_pointer entry c m d m _ p o i n t e r 0 . 0 . 1 0 0 . 0 i p t r i s h u l 1 1 9 5 0
7.
Following changes to be done in d m _ g e n e r i c
pin.conf
file
— Modify the d m _ l o g f i l e entry
dm dm_logfile /var/portal/7.0/dm_generic/dm_generic.pinlog
— Modify d m _ s m _ o b j entry
dm dm_sm_obj /opt/portal/7.0/sys/dm_generic/dm_generic.so
— Modify d m _ d b _ n o entry
dm dm_db_no 0.0.100.0 / 0
— Modify d m _ p o r t to the corresponding value mentioned in
entry of cm pin.conf file
dm_pointer
dm dm_port 11950
8. Copy the s t a r t _ d m _ o r a c l e available under / o p t / p o r t a l / 7 . 0 / b i n folder
and save as s t a r t _ d m _ g e n e r i c .
9. Replace all o r a c l e words with g e n e r i c in the file s t a r t _ d m _ g e n e r i c .
10. Copy the s t o p _ d m _ o r a c l e available under / o p t / p o r t a l / 7 . 0 / b i n folder and
save as s t o p _ d m _ g e n e r i c .
TIBCO Adapter for Infranet User’s Guide
Invoking Custom Data Manager through Request-Response Invocation Service 153
|
11. Replace all o r a c l e words with g e n e r i c in the file s t o p _ d m _ g e n e r i c .
12. Copy the .ini file to d m _ g e n e r i c folder.
13. Start the service by running the excutable s t a r t _ d m _ g e n e r i c .
14. Stop the service by running the excutable s t o p _ d m _ g e n e r i c .
Configuration for the Adapter:
Follow the steps mentioned below to configure the adapter to invoke a Custom
Data Manager from Request-Response Invocation Service.
1. Configure a Request-Response Service or Subscription Service to execute an
opcode to invoke the Custom Data Manager.
2. RV Agent code within the Custom Data Manager will convert the input FLIST
into string and send it on the TIBCO Rendezvous (or TIBCO Enterprise
Message Service) with the parameters as specified in the R P C C L I E N T . i n i file.
Refer Infranet setup section below for more details on R P C C L I E N T . i n i and
d m _ g e n e r i c . d l l (d m _ g e n e r i c . s o for Solaris and d m _ g e n e r i c . s l for
HP-UX).
3. The Request-Response Invocation Service will receive the RVmessage and
then extract the F L I S T string from it. The F L I S T is then converted to a request
to be sent to TIBCO Rendezvous (or TIBCO Enterprise Message Service).
4. The Request-Response Invocation Service will append this message with the
subject specified in the configuration of the service.
5. The External Application (TIBCO BusinessWorks or TIBCO
IntegrationManager) will receive the message and send back the response to
the request.
6. The response from the External Application is then converted back to F L I S T
by the Request-Response Invocation Service.
7. The FLIST is then sent back to the RV agent.
8. The output FLIST and the input FLIST are logged in the log file with name
R P C C L I E N T appended with the timestamp (long value) e.g.
RPCCLIENT1117107063.log.
The contents of the log file is as shown next:
Service=7500, Network=172.25.184.66, Daemon=tcp:7500
Opcode Name12
Network transport created
No. of Fields in the Flist = 1
Input FLIST String
# number of field entries allocated 1, used 1
TIBCO Adapter for Infranet User’s Guide
154
| Configuring Advanced Settings
0 PIN_FLD_POID
POID [0] 0.0.200.1 /account 1269149 0
Output FLIST String
0 PIN_FLD_RESULTS
PIN_FLD_POID
PIN_FLD_POID
0 PIN_FLD_FIELD
PIN_FLD_DESCR
TIBCO Adapter for Infranet User’s Guide
ARRAY [1] allocated 1, used 1 1
POID [0] 0.0.0.1 /account 9293 0 0
POID [0] 0.0.0.1 /account 9293 0
ARRAY [1] allocated 1, used 1 1
STR [0] "VIN"
Custom Opcode Configuration 155
|
Custom Opcode Configuration
Follow the steps mentioned below to configure a custom opcode:
1. Create a new header file for the custom Facilities Module defining new
opcodes, by using the format below (you may also use the existing header file
created for your Facilities Module):
#define opcode_name_1
opcode_number_1
For example, you might create a header file named m y _ o p c o d e s . h with these
definitions:
#define MY_OP_SET_NAME
#define MY_OP_SET_LANGUAGE
100001
100002
All custom opcode names in the header file must start with P C M _ O P _ . If the
custom opcode names do not start with P C M _ O P _ , append the same. For example,
if the opcode name is M Y _ O P _ S E T _ N A M E , add P C M _ O P _ to the custom opcode
name thereby renaming it as P C M _ O P _ M Y _ O P _ S E T _ N A M E . This modification is
required only to run the perl script mentioned in Step 2.
2. Run the perl script (p a r s e _ c u s t o m _ o p s _ f i e l d s . p l ) to generate the java file
corresponding to the header file generated in step 1 with the package
com.portal.custom_opcode:
<INFRANET_HOME>\bin>perl parse_custom_ops_fields.pl -L pcmjava
-I <Header File Path>\op_define.h -O
<Output Path>\com\portal\custom_opcode -P
com.portal.custom_opcode
Specify the package name as c o m . p o r t a l . c u s t o m _ o p c o d e . Ensure that the
folders c o m , p o r t a l and c u s t o m _ o p c o d e exist on your machine and you have
w r i t e permission on the same.
3. Compile the java code using the following syntax:
<Output Path> > javac com\portal\custom_opcode\CustomOp.java
4. A custom class will be created. Copy the directory c o m ( with the
sub-directories c o m \ p o r t a l \ c u s t o m _ o p c o d e \ C u s t o m O p . c l a s s ) to the
< A D A P T E R _ H O M E > \ l i b folder. Or, create a jar with the
TIBCO Adapter for Infranet User’s Guide
156
| Configuring Advanced Settings
and place it in the
folder or specify the location of the jar as follows:
com\portal\custom_opcode\CustomOp.class
<ADAPTER_HOME>\lib
— for Microsoft Windows, specify in the c l a s s p a t h
— for Solaris, specify in the L D _ L I B R A R Y _ P A T H
— for HP-UX, specify in the S H L I B _ P A T H
5. Configure the custom opcode in TIBCO Designer.
TIBCO Adapter for Infranet User’s Guide
| 157
Chapter 6
Deploying and Starting an Adapter Using
TIBCO Administrator
This chapter provides an overview about deploying, starting, stopping, and
monitoring adapters using the TIBCO Administrator web interface.
Topics
•
Create an EAR File in TIBCO Designer, page 158
•
Deploy the Project, page 159
•
Start or Stop the Adapter, page 160
•
Monitor the Adapter, page 161
•
Adapter Properties File, page 162
TIBCO Adapter for Infranet User’s Guide
158
| Deploying and Starting an Adapter Using TIBCO Administrator
Create an EAR File in TIBCO Designer
Generate an Enterprise Archive file (EAR) that contains information about the
adapter services to deploy.
The EAR file contains information on what you wish to deploy. This could be one
or more adapter services, one or more TIBCO BusinessWorks process engines, or
both.
Building an archive creates the EAR file, which you can then deploy from TIBCO
Administrator. If you make changes to the business processes or adapter services
included in the archive, you need to rebuild the archive. Saving the project does
not affect the archive.
In TIBCO Designer, follow these steps to create an EAR:
1. Configure the adapter services.
2. Drag and drop the E n t e r p r i s e A r c h i v e resource from the palette panel to
the design panel. If there are any configured adapter services in your project,
an A d a p t e r A r c h i v e resource becomes available in the palette panel.
3. Drag the A d a p t e r A r c h i v e into the design panel and specify information in
the Configuration tab, then click Apply.
4. Go to the E n t e r p r i s e
file.
Archive
and click Build Archive to create the archive
See Also
See the TIBCO Designer User’s Guide for more information about this procedure.
The guide is available from the Designer H e l p menu.
TIBCO Adapter for Infranet User’s Guide
Deploy the Project 159
|
Deploy the Project
Before deploying a project, the machine on which the adapter is installed must be
part of a TIBCO administration domain. After you have installed the TIBCO
Administration Server, any machine on which you install TIBCO Runtime Agent
(required by an adapter) can be added to the administration domain. The TIBCO
software installed on the machine is then visible and accessible via the TIBCO
Administrator GUI.
When you deploy a project, startup scripts and other information about the
different components are sent to the machines to which the components were
assigned. The project data store and TIBCO Administration Server are updated
with the deployed components.
To deploy a project:
1. Import the EAR file into TIBCO Administrator Enterprise Edition.
2. Assign adapter archives in the EAR file to adapters installed in the
administration domain and likewise assign process archives to process
engines.
3. Specify startup options for each adapter service.
Password Handling
At design-time, the adapter uses a password to connect to the backend
application and fetch metadata. At run-time, the adapter uses a password to
connect to the back-end application and interoperate with it. If you create a 4.x
configuration using TIBCO Designer 5.4, and use the configuration against a 4.x
adapter version, some special considerations are required for security.
When deploying the adapter check the S e r v i c e property of the global variable in
the global variables section, then go to the Advanced tab of the adapter archive
and set the password value under the R u n - T i m e V a r i a b l e s section.
Do not set the password to type P a s s w o r d in the global variables section for
adapter configurations that are set to A E V e r s i o n 4 . 0 or A E V e r s i o n 5 . 2 (in the
Configuration tab V e r s i o n field) or any intermediate version.
See Also
See the TIBCO Administrator User’s Guide for an introduction to the TIBCO
administration domain and detailed information about the above steps.
TIBCO Adapter for Infranet User’s Guide
160
| Deploying and Starting an Adapter Using TIBCO Administrator
Start or Stop the Adapter
The TIBCO Administrator A p p l i c a t i o n
and stop deployed applications.
Management
module allows you to start,
To start an adapter service from the module:
1. In the Administrator GUI left pane, expand Application Management>
Application-Name>Service Instances.
2. In the S e r v i c e
service.
Instance
panel, select the check box next to the adapter
3. Click the Start Selected button.
The status changes from S t o p p e d to S t a r t i n g
up
to S t a r t e d .
4. To stop the adapter service, click the Stop Selected button.
See Also
See the TIBCO Administrator User’s Guide for more information.
TIBCO Adapter for Infranet User’s Guide
Monitor the Adapter 161
|
Monitor the Adapter
TIBCO Administrator offers a number of monitoring options.
•
Specify alerts and TIBCO Hawk rulebases for each machine in the domain.
•
Specify alerts and Hawk rulebases for each adapter service.
•
View the log for each adapter service instance.
See Also
See the TIBCO Administrator User’s Guide for information about configuring the
above monitoring options.
TIBCO Adapter for Infranet User’s Guide
162
| Deploying and Starting an Adapter Using TIBCO Administrator
Adapter Properties File
Both the design-time and run-time adapters parse a properties file at startup.
•
The default run-time adapter properties file is named a d i n f r a . t r a .
The default properties file is located in b i n 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/test/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.
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. Java allows
termination characters by escaping the value with a preceding "\" character.
The adapter does not support this syntax.
Tagging Values for Obfuscation
The presence of a "# " character as the first character in a value (not the key)
indicates that the value has been obfuscated or is to be obfuscated. The
obfuscation command-line tool prompts for values to be obfuscated when it
encounters a value with "# " as the first character in the properties file.
When the obfuscate tool is run, it rewrites the properties file with the obfuscated
value in place. See Obfuscating or Encrypting a Password in the Properties File on
page 165 for more information.
TIBCO Adapter for Infranet User’s Guide
Adapter Properties File 163
|
Predefined Properties
The next table describes predefined properties. Properties that start with
n t s e r v i c e are available only on Microsoft Windows platforms.
All paths inside a properties file, including Windows directory names, must use
forward slashes.
Table 6 Predefined Properties
Property
Description
tibco.repourl
Identifies the absolute pathname to the Designer
project where the adapter configuration is
defined.
tibco.configurl
Specifies the location of the adapter configuration
inside the project file.
tibco.username
tibco.password
tibco.clientVar.<varn
ame>
•
If a relative path is specified, the adapter
service is assumed to be under the default
area in the project:
/t i b c o / p r i v a t e / a d a p t e r /
•
If an absolute path is specified, the adapter
configuration is looked up in the project as
defined by the argument.
The user name and password used by the
repository server to access the project.
Specifies run-time 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.
You append the global variable to
t i b c o . c l i e n t V a r, then give its value. For
example:
tibco.clientVar.DirLedger=C:/tibco/adapt
er/adinfra/5.2/myledger
adinfra.perfMon
<on/off>
Turns the performance statistics microagent on or
off.
TIBCO Adapter for Infranet User’s Guide
164
| Deploying and Starting an Adapter Using TIBCO Administrator
Table 6 Predefined Properties
Property
Description
adinfra.addCustomHawk
MethodstoClassMAgent
<on/off>
If set to on, custom methods are added to the class
microagent. If set to off, custom methods are not
available from the standard microagent. Default is
on.
ntservice.name
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.
ntservice.displayname
Name to display in the Services control 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
adapter running on the same machine. By
specifying different service names and display
names for the adapters, you can accomplish this.
ntservice.starttype
Start type for this Windows Service. Either
manual or automatic. For example:
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.path
.absolute
Absolute path to the executable that is run when
the service is started. For example:
ntservice.binary.path.absolute
C:/tibco/adapter/adinfra/5.2/bin/adinfra
.exe
ntservice.interactive
Specifies whether the Windows Service is
interactive. Either true or false.
ntservice.interactive=true
TIBCO Adapter for Infranet User’s Guide
Adapter Properties File 165
|
Table 6 Predefined Properties
Property
Description
ntservice.account
Username under which to run the Windows
Service.
You can use this property to initially set the
account for the service, but once the service is
installed, use the S e r v i c e s control to change the
user account of services.
ntservice.password
Password for the username in the
n t s e r v i c e . a c c o u n t property.
You can use this property to initially set the
password for the user account, but once the
service is installed, use the S e r v i c e s control to
change the password.
adinfra.allowBackward
CompatStopSubscriber
off
A new parameter
adinfra.allowBackwardCompatStopSubscribe
r o f f has been added in the tra file of the
adapter. This parameter is used to enable and
disable the default stop subject
_ L O C A L . a d i n f r a . S H U T D O W N . A L L for the run-time
adapter.
Obfuscating or Encrypting a Password in the Properties File
Password Handling
At design-time, the adapter uses a password to connect to the backend
application and fetch metadata. At run-time, the adapter uses a password to
connect to the back-end application and interoperate with it. If you create a 4.x
configuration using TIBCO Designer 5.4, and use the configuration against a 4.x
adapter version, some special considerations are required for security.
If you plan to run the adapter locally, define the run-time password value to be a
global variable. Before starting the adapter, include the run-time password as
client variable in the adapter's . t r a file and obfuscate it using obfuscate tool. For
example, if the password value is defined as % % m y P a s s w o r d % % , create a global
variable named m y P a s s w o r d in the global variables section with no value and
include the following entry in the adapter's . t r a file:
TIBCO Adapter for Infranet User’s Guide
166
| Deploying and Starting an Adapter Using TIBCO Administrator
tibco.clientVar.myPassword
Do not set the password to type P a s s w o r d in the global variables section for
adapter configurations that are set to A E V e r s i o n 4 . 0 or A E V e r s i o n 5 . 2 (in the
Configuration tab Version field) or any intermediate version.
Obfuscating a Password
If the run-time adapter uses a password to access Infranet, the password is stored
in readable form as a value to the t i b c o . c l i e n t V a r . < v a r i a b l e > = # < p a s s w o r d >
property in the run-time adapter’s properties file. You can use the obfuscate tool
to hide the password in the properties file so the password cannot be viewed by
unauthorized users.
To obfuscate the password:
1. Using TIBCO Designer, open the adapter instance and navigate to the panel
where the password used by the run-time adapter to connect to Infranet is
defined. In the password field, provide a user defined global variable, such as
% % M y P a s s w o r d % % . The global variable must also be added to the global
variable list. See Using Global Variables on page 128 for information about
creating global variables.
2. In the run-time adapter properties file, verify that the
t i b c o . c l i e n t V a r . < v a r i a b l e > = # < p a s s w o r d > property is defined in the file.
3. Run the obfuscation tool supplied with adapter software against the
properties file. This tool is named o b f u s c a t e . e x e and resides in the
< i n s t a l l _ d i r > \ t i b c o \ t r a \ < n . n > \ b i n directory.
The command syntax on Windows for a default installation is:
C:\tibco\tra\5.4\bin\obfuscate <tra-file-path-name>
where < t r a - f i l e - p a t h - n a m e > is the absolute pathname of the adapter
properties file that contains the t i b c o . c l i e n t V a r . <variable>= # <password>
property.
For example, on Windows:
<install-path>\ t i b c o \ t r a \ 5 . 4 \ b i n \ o b f u s c a t e
C:\tibco\adapter\adinfra\5.2\bin\
adinfra.tra
The password is now obfuscated and you can start the adapter with the
changed properties file.
If you don’t want to obfuscate a password, remove the # at the beginning of the
obfuscated password and replace it with the password in plain text.
TIBCO Adapter for Infranet User’s Guide
Adapter Properties File 167
|
Encrypting a Password
Encryption is only supported for TIBCO Adapter 5.x and higher. If you have a
property in a properties file that needs to be encrypted, follow these steps:
1. In the property file, add the #! characters in front of the value you wish to
encrypt. For example:
Repo.serverPassword = #!mysecret
2. Invoke the obfuscate utility from the command line:
<install-path>/ tibco/tra/5.4/bin/obfuscate.exe
--propertyfile=<property-file-name>
The next time you open the property file, m y s e c r e t will have been replaced
with a random sequence of characters.
TIBCO Adapter for Infranet User’s Guide
168
| Deploying and Starting an Adapter Using TIBCO Administrator
TIBCO Adapter for Infranet User’s Guide
| 169
Chapter 7
Monitoring the Adapter Using TIBCO Hawk
This chapter explains how to use TIBCO Hawk microagents to monitor and
manage the adapter.
Topics
•
Overview, page 170
•
Starting TIBCO Hawk Software, page 171
•
The Auto-Discovery Process, page 172
•
Invoking Microagent Methods, page 173
•
Available Microagents, page 175
TIBCO Adapter for Infranet User’s Guide
170
| Monitoring the Adapter Using TIBCO Hawk
Overview
TIBCO Hawk is a sophisticated tool for enterprise-wide monitoring and
managing of all distributed applications and systems. System administrators can
use it to monitor adapters in a wide area network of any size. TIBCO Hawk can be
configured to monitor system and adapter parameters and to take actions when
predefined conditions occur. These actions include: sending alarms that are
graphically displayed in the TIBCO Hawk display, sending E-mail, paging,
running an executable, or modifying the behavior of a managed adapter.
Unlike other monitoring applications, TIBCO Hawk relies on a purely distributed
intelligent agent architecture using publish or subscribe to distribute alerts.
TIBCO Hawk uses TIBCO Rendezvous for all messaging and thus gains the
benefits and scalability from the TIBCO Rendezvous features of publish or
subscribe, subject name addressing, interest-based routing, and reliable multicast.
TIBCO Hawk is a purely event-based system that uses alerts. The agents are
configured with rules that instruct them on everything from what and how to
monitor to what actions to take when problems are discovered. Thus the
workload is fully distributed throughout the enterprise. Every agent is
autonomous in that it does not depend on other components to perform its
functions.
The TIBCO Hawk Enterprise Monitor consists of these components:
•
Display—The GUI front end that displays alarms and provides editors to
create rule bases, create tests, view messages, and invoke microagents to
request information or initiate an action.
•
Agents—Intelligent processes that perform monitoring and take actions as
defined in rules.
•
Rulebases—Rules that are loaded by agents to determine agent behavior.
•
Application Management Interface (AMI)—Manages network applications
via TIBCO Rendezvous and supports communication between a network
application and monitoring TIBCO Hawk agents, including the ability to
examine application variables, invoke methods, and monitor system
performance.
•
Microagents—Feed information back to TIBCO Hawk and expose action
methods to rulebases.
For more information, see the TIBCO Hawk documentation.
TIBCO Adapter for Infranet User’s Guide
Starting TIBCO Hawk Software 171
|
Starting TIBCO Hawk Software
The TIBCO Hawk agent can be configured to start automatically during the
system boot cycle. See the TIBCO Hawk Installation and Configuration guide for
information about starting TIBCO Hawk.
The TIBCO Hawk Administrator’s Guide explains how to start the TIBCO Hawk
Display.
The guides are included in your TIBCO Hawk software installation area.
TIBCO Adapter for Infranet User’s Guide
172
| Monitoring the Adapter Using TIBCO Hawk
The Auto-Discovery Process
After you start an instance of TIBCO Hawk Display, it continually discovers
machines running TIBCO Hawk Agents on your network. Container icons are
created for each agent, and arranged hierarchically in clusters. By default, agent
icons are clustered according to subnets.
At first, the Agents container is empty. Its counter displays a value of zero and, on
the right, the Discovered counter is also at zero. Both icons are initially green in
color to show that no alerts, or warning messages, are in effect. As agents are
discovered, the counters increment to reflect the current number of discovered
agents:
Monitored network nodes are arranged in a hierarchical tree of containers.
Clicking a container in the left panel displays nested items on the right.
Icon colors change to reflect the highest level of alert found on discovered agents.
For explanations of icon elements and characteristics, see your TIBCO Hawk
Administrator’s Guide.
TIBCO Adapter for Infranet User’s Guide
Invoking Microagent Methods 173
|
Invoking Microagent Methods
A set of default microagents is loaded when a TIBCO Hawk Agent is started.
When you install and start the adapter, its microagents are dynamically added to
the local agent.
To invoke a microagent method:
1. Start TIBCO Hawk Display and then right-click the agent icon and select Get
Microagents.
If TIBCO Hawk security is implemented on your system and you do not have
access to microagents on this agent, an error dialog displays. Select another
agent, or contact your system administrator to obtain access. The Microagents,
Methods and Arguments dialog displays. The panel on the upper left lists
microagents you can access on the current agent.
This dialog has two modes, I n v o k e and S u b s c r i b e . Invoking a method
immediately returns a single set of current results. Subscribing provides
updates of current results at regular intervals. Radio buttons at the bottom of
the dialog control these modes.
2. Click a microagent name, such as Self, to display a list of associated methods
and text descriptions in the panels below.
TIBCO Adapter for Infranet User’s Guide
174
| Monitoring the Adapter Using TIBCO Hawk
3. Click the name of the method to invoke, such as getComponentInfo.
If the method accepts arguments, fields for each argument display in the
upper right panel. Detailed help text displays in the lower panel.
4. Specify any arguments for the method invocation.
5. Verify that the I n v o k e radio button is selected.
6. Click the Invoke button to invoke the selected method. The I n v o c a t i o n
R e s u l t s dialog displays the results returned by the method.
7. Click Done to close the dialog.
These steps describe how to interactively invoke a microagent method and
receive a single set of results in TIBCO Hawk Display. You can also use a
microagent method as the data source of a TIBCO Hawk rule. Rules automatically
receive method results, apply tests to evaluate them and then take action if
necessary. For more information on building TIBCO Hawk rules and rule bases,
see your TIBCO Hawk Administrator’s Guide.
TIBCO Adapter for Infranet User’s Guide
Available Microagents 175
|
Available Microagents
Each adapter has three microagents, a standard TIBCO Hawk microagent named
C O M . T I B C O . A D A P T E R .xyz where xyz is the adapter configuration name, a custom
microagent and a class microagent. The microagents provide:
•
Business level statistics—statistics that report the progress of the adapter as it
interacts with the vendor application. For example, in a database adapter such
statistics might indicate whether objects were successfully or unsuccessfully
inserted, updated, or deleted in the database.
•
Queries that return information about the state of the adapter. This can be an
important tool for seeing the internals of an adapter and debugging it if
something appears wrong. For example, methods can return information
about threads, internal queues, or connections to the target system. Using
these methods, one might be able to identify certain bottlenecks or gauge how
successfully an adapter is scaling with respect to the current environment.
•
Updates of the adapter runtime parameters. This includes retrieving the
current runtime parameters and setting new runtime parameters without
restarting the adapter. An example of this is getting and setting the polling
interval. Updating a runtime parameter through the Hawk microagent only
affects the setting of the instance that is running. It does not make a
permanent change of the setting in either the repository or the .tra file.
By default all microagents, custom, standard and class microagents are available
at runtime.
Custom microagents are deprecated in this release. All business statistics related
methods, which were part of the custom microagent are now available in the class
microagent.
property value set in the adapter’s property file affects the business
statistics related methods. If this property is set to on, the adapter does all the
performance related calculations. When you invoke the methods, if the perfMon
property is set to off, default values are displayed and not the valid values.
perfMon
You can disallow adding custom methods to the class microagent when
deploying the adapter by changing the a d d C u s t o m H a w k M e t h o d s t o C l a s s M A g e n t
property value in the adapter’s property file. If this property is set to o n , custom
methods are added to the class microagents. If set to o f f , these methods are not
visible.
TIBCO Adapter for Infranet User’s Guide
176
| Monitoring the Adapter Using TIBCO Hawk
The following table lists each method available for the adapter and page on which
the method is explained.
Table 7 Microagent Methods
Method
Description
Page
activateTraceRole()
Activates a mapping of a role to a sink at
runtime.
179
deactivateTraceRole()
Deactivates a mapping of a roles to sinks
at runtime.
180
getActivityStatistics
()
Returns the total number of objects
processed for all the schemas.
181
getActivityStatistics
ByOperation()
Returns the total number of objects
processed for all the schemas by each
service that is associated with a specified
operation.
182
getActivityStatistics
ByService()
Returns information about the services
implemented by this adapter.
183
getAdapterServiceInfo
rmation()
Returns information about the services
implemented by this adapter.
184
getComponents()
Returns information about the publisher,
subscriber and IODescriptor.
185
getConfig()
Returns basic configuration information.
More specific information is accessed by
the more specific methods.
186
getConfigProperties()
Returns all attributes and elements for
the given repository object.
187
getConnectionStatisti
cs()
Returns the state and statistics for all the
current connections used by the adapter.
188
getHostInformation()
Returns standard and extended
application information.
189
getQueueStatistics()
Returns the current count of elements in
any internal queue used by the adapter.
190
TIBCO Adapter for Infranet User’s Guide
Available Microagents 177
|
Table 7 Microagent Methods (Cont’d)
Method (Cont’d)
Description (Cont’d)
Page
getRvConfig()
Returns information about all TIBCO
Rendezvous sessions defined.
191
getStatus()
Returns general status information, such
as the number of TIBCO Rendezvous
messages received and published, the
number of errors since the last call, the
PID of the application, and more.
192
getThreadStatistics()
Returns the operation counts of the
current threads
193
getTraceSinks()
Returns information about sinks to
which traces currently go.
194
getVersion()
Returns the configuration ID, application
name, version, and date for this adapter
instance.
195
_onUnsolictedMsg()
Displays alert messages sent to the
current adapter.
196
preRegisterListener()
Preregisters an anticipated listener.
197
resetActivityStatisti
cs()
Resets all the counts for the activity
statistics.
198
resetConnectionStatis
tics()
Resets all the counts for the connection
statistics.
199
resetThreadStatistics
()
Resets all the counts for the thread
statistics.
200
reviewLedger()
Returns information retrieved from the
ledger file of a certified messaging
session for a publisher adapter.
201
setDebugLevel()
Sets the debug level for the current
adapter instance.
203
setTraceSinks()
Adds a role or changes the file limit of a
previously specified sink.
204
TIBCO Adapter for Infranet User’s Guide
178
| Monitoring the Adapter Using TIBCO Hawk
Table 7 Microagent Methods (Cont’d)
Method (Cont’d)
Description (Cont’d)
Page
stopApplicationInstan
ce()
Stops the running adapter instance.
205
unRegisterListener()
Unregisters a currently preregistered
listener.
206
getPerfMonSetting()
Returns the setting of the perfMon
option. This is a custom microagent
method.
207
getInfranetTraceInfo(
)
Provides information about tracing of
SQL statements issued by the Infranet
application. This is a custom microagent
method.
208
setInfranetTraceOn()
Turns on the tracing of SQL statements
issued by the Infranet application. This is
a custom microagent method.
209
setInfranetTraceOff()
Turns off the tracing of SQL statements
issued by the Infranet application. This is
a custom microagent method.
210
TIBCO Adapter for Infranet User’s Guide
activateTraceRole() 179
|
activateTraceRole()
Activates a mapping of a role to a sink at runtime. This replaces the
now-deprecated s e t T r a c e S i n k ( ) TIBCO Hawk method.
Input
Parameters
Type
Description
Role Name
string
Name of the role to activate.
Sink Name
string
Name of the sink for which to activate the role.
TIBCO Adapter for Infranet User’s Guide
180
| Monitoring the Adapter Using TIBCO Hawk
deactivateTraceRole()
Deactivates a mapping of a roles to sinks at runtime.
Input
Parameters
Type
Description
Role Name
string
Name of the role to activate.
Sink Name
string
Name of the sink for which to activate the role.
TIBCO Adapter for Infranet User’s Guide
getActivityStatistics() 181
|
getActivityStatistics()
Returns the total number of events processed for all the schemas, based on the
request type. Also, returns the number of success and error events.
Input
Parameter
Type
Description
GetSubTotalBy
string
Indicates how to group the subtotals, by
S e r v i c e or O p e r a t i o n .
Returns
Type
Description
Name
string
Service name or A l l S e r v i c e s which represents
the final tally of all the services
Total
integer
Total number of events processed including both
success and failures.
Success
integer
Total number of events successfully processed.
Failure
integer
Total number of events that caused an error
during processing.
MeasurementIn
terval
integer
Displays the time (in seconds) since last time the
adapter was reset, or if never reset, since the
adapter started.
TIBCO Adapter for Infranet User’s Guide
182
| Monitoring the Adapter Using TIBCO Hawk
getActivityStatisticsByOperation()
Returns statistics about one operation.
Input
Parameter
Type
Description
Operation
string
Name of the operation.
Returns
Type
Description
Operation
string
Name of the operation.
Service Name
string
Name of the service.
Total
integer
Total number of events processed, both success
and failures.
Success
integer
Total number of events successfully processed.
Failure
integer
Total number of events that caused an error
during processing.
MeasurementIn
terval
integer
Displays the time (in seconds) since last time the
adapter was reset, or if never reset, since the
adapter started.
LineIndex
string
Concatenated string of S e r v i c e N a m e and
O p e r a t i o n separated by a comma.
TIBCO Adapter for Infranet User’s Guide
getActivityStatisticsByService() 183
|
getActivityStatisticsByService()
Returns statistics about the data handled by a given adapter service or all adapter
services since the time the adapter was started.
Input
parameter
Type
Description
Service Name
string
Name of service to get the statistics for. If no
service name is given, performance statistics for
all services is returned.
Returns
Type
Description
Service Name
string
Service name
Schema Name
string
Name of top level schema processed by this
service.
Operation
string
Type of operation this service provides.
Total
integer
Total number of events processed, both success
and failures.
Success
integer
Total number of events successfully processed.
Failure
integer
Total number of events that caused an error
during processing.
MeasurementIn
terval
integer
Displays the time (in seconds) since last time the
adapter was reset, or if never reset, since the
adapter started.
LineIndex
string
Concatenated string of S e r v i c e N a m e and
O p e r a t i o n separated by a comma.
TIBCO Adapter for Infranet User’s Guide
184
| Monitoring the Adapter Using TIBCO Hawk
getAdapterServiceInformation()
Returns information about the services implemented by this adapter.
Input Parameter
Type
Description
Service Name
string
Name of the service from which to get
information. Default is A L L .
Returns
Type
Description
Line
integer
Sequential row number.
Service Name
string
Name of the service as defined at design-time.
Endpoint Name
string
Name of the endpoint used for this service.
Type
string
Type of the endpoint, for example, publisher or
subscriber.
Quality of
Service
string
Quality of service for the endpoint. For example
RVCM or JMS Persistent.
Subject
string
Subject defined for this endpoint.
Class
string
Class associated with the endpoint.
Number of
Messages
integer
Number of messages processed for this endpoint.
TIBCO Adapter for Infranet User’s Guide
getComponents() 185
|
getComponents()
Returns information about the currently active TIBCO Hawk components such as
publishers, subscribers, or timers.
Input Parameters
Type
Description
Component Name
string
Name of the component. If no value is enter, all
components display.
Component Type
string
Any of P u b l i s h e r, S u b s c r i b e r, T i m e r, or
I O D e s c r i p t o r. The default value is A l l .
Returns
Type
Description
Instance ID
string
Name of this adapter instance as defined at
design-time.
Adapter Name
string
Name of the adapter.
Component Name
string
Name of the component.
Component Type
string
The name of the TIBCO Adapter SDK class for
this component, such as P u b l i s h e r,
S u b s c r i b e r , or I O D e s c r i p t o r S o u r c e . For
more information about the class, see your
TIBCO Adapter SDK documentation.
Session Name
string
Name of the session.
Description
string
Information about this component, for
example, time interval, signal type, and
validating the publisher or subscriber.
TIBCO Adapter for Infranet User’s Guide
186
| Monitoring the Adapter Using TIBCO Hawk
getConfig()
Retrieves generic configuration information. More specific configuration
information is accessed through separate methods.
Returns
Type
Description
Instance ID
string
Configuration ID of this adapter.
Adapter Name
string
Name of the adapter.
Repository
Connection
string
URL of the repository used for adapter instance.
Configuration
URL
string
Location of the adapter project; either a file name
or configuration URL.
Command
string
Command line arguments used to start the
adapter.
TIBCO Adapter for Infranet User’s Guide
getConfigProperties() 187
|
getConfigProperties()
Returns all attributes and elements for the given repository object.
Input Parameter
Type
Description
Property
string
Name of the property for which elements (tags)
and attributes are desired. For example,
agentone/startup.
If no value is given, all properties are returned.
Returns
Type
Description
Element Name
string
Repository directory for the property.
Attribute Name
string
Name of the repository object attribute.
Attribute Value
string
Value of the repository object attribute.
Line
integer
Line number in which this property is defined
in the project file.
TIBCO Adapter for Infranet User’s Guide
188
| Monitoring the Adapter Using TIBCO Hawk
getConnectionStatistics()
Returns the state and statistics for all the current connections used by the adapter.
Returns
Type
Description
Connection ID
string
Unique identification of a particular connection.
Connection Type
string
Type or key that will match this connection to a
thread or queue.
State
string
Current state: CONNECTED or
DISCONNECTED.
NumRetries
integer
Total number of times this connection had to be
reestablished.
TotalNumOperat
ions
integer
Total number of operations processed by this
connection since the adapter started.
CurrentNumOpe
rations
integer
Total number of operations processed by this
connection since the last reconnection.
NumLostConnec
tions
integer
Total amount of time that this connection has
been lost.
MeasurementInte
rval
integer
Displays the time (in seconds) since last time the
adapter was reset, or if never reset, since the
adapter started.
TIBCO Adapter for Infranet User’s Guide
getHostInformation() 189
|
getHostInformation()
Return standard and extended application information set. It returns the
following information.
Returns
Type
Description
Name
string
Name of the property.
Value
string
Value of the property.
TIBCO Adapter for Infranet User’s Guide
190
| Monitoring the Adapter Using TIBCO Hawk
getQueueStatistics()
Return the current count of elements in any internal queue used by the adapter.
This includes the TIBCO Rendezvous event queues automatically spawned by
TIBCO Rendezvous for each adapter.
Returns
Type
Description
QueueID
string
Unique identification of a particular queue.
QueueType
string
Type or key that will match this queue to a
thread or connection.
QueueCount
integer
Current number of elements in the queue.
MaxQueueSize
integer
Maximum number of elements in the queue.
MeasurementInte
rval
integer
Displays the time (in seconds) since last time the
adapter was reset, or if never reset, since the
adapter started.
TIBCO Adapter for Infranet User’s Guide
getRvConfig() 191
|
getRvConfig()
Returns information about the TIBCO Rendezvous session defined by this
adapter. Information about all currently defined sessions is returned if no
s e s s i o n N a m e is provided.
Input
Parameter
Type
Description
Session Name
string
Name of the TIBCO Rendezvous session for
which configuration is required. If not given,
information about all sessions is returned. The
default is all.
Returns
Type
Description
Instance ID
string
Configuration ID of this adapter.
Adapter Name
string
Name of the adapter.
Session Name
string
Name of the session.
Service
string
Service parameter for this session.
Daemon
string
Daemon parameter for this session.
Network
string
Network parameter for this session.
Synchronous?
boolean
Returns 1 if this is a synchronous session, 0
otherwise.
Session Type
string
Type of session; one of M _ R V, M _ R V C M , or
M_RVCMQ.
Certified Name
string
Name of this certified session.
Ledger File
string
Ledger file for this certified messaging session.
Returns the empty string for sessions that are
not certified messaging sessions.
CM Timeout
string
Timeout for this certified messaging session.
Returns the empty string for sessions that are
not certified messaging sessions.
TIBCO Adapter for Infranet User’s Guide
192
| Monitoring the Adapter Using TIBCO Hawk
getStatus()
Retrieves basic status information about the adapter.
This information is fairly limited; for more detail, additional methods are
provided (getConfig() on page 75 and getRvConfig() on page 77.
Returns
Type
Description
Instance ID
string
Configuration ID for this adapter instance.
Adapter Name
string
Name of the adapter.
Uptime
integer
Number of seconds since startup.
Messages Received
integer
Number of TIBCO Rendezvous messages
received.
Messages Sent
integer
Number of TIBCO Rendezvous messages
published.
New Errors
integer
Number of errors since the last call to this
method.
Total Errors
integer
Total number of errors since startup.
Process ID
integer
Process ID of the application.
Host
string
Name of host machine on which this adapter
is running.
TIBCO Adapter for Infranet User’s Guide
getThreadStatistics() 193
|
getThreadStatistics()
Return the operation counts of the current threads.
Returns
Type
Description
ThreadID
string
Unique identification of a particular thread.
ThreadType
string
Type that tells what part of the adapter this
thread belongs. Valid types include
"Publisher", "Subscriber", "RPC", or
"Connection".
TaskType
string
One-word description of the tasks this thread
processes.
TaskCount
integer
Number of tasks processed by this thread.
MeasurementInterv
al
integer
Displays the time (in seconds) since last time
the adapter was reset, or if never reset, since
the adapter started.
TIBCO Adapter for Infranet User’s Guide
194
| Monitoring the Adapter Using TIBCO Hawk
getTraceSinks()
Returns information about sinks to which traces currently go.
Input
Parameters
Type
Description
Sink Name
string
Name of the sink for which you need information.
If no name is specified, information about all sinks
is returned. Default is all.
Role Name
string
Name of the role for which you need information
for the specified sink or sinks. Default is all.
Returns
Type
Description
Instance ID
string
Name of this adapter instance as a string.
Adapter Name
string
Name of the application for this sink.
Sink Name
string
Name of the sink
Sink Type
string
Type of this sink. One of fileSink, rvSink,
hawkSink, stderrSink.
Roles
string
Roles this sink supports, as a string. For example
warning, error, debug.
TIBCO Adapter for Infranet User’s Guide
getVersion() 195
|
getVersion()
Retrieves version information for the current application. Two lines may be
returned, one for the TIBCO Adapter SDK, one for the adapter.
Returns
Description
Instance ID
Configuration ID as a string, for example S D K .
Adapter Name
Name of the adapter as a string, for example a g e n t o n e .
Version
Version number as a string, for example 5 . 1 .
TIBCO Adapter for Infranet User’s Guide
196
| Monitoring the Adapter Using TIBCO Hawk
_onUnsolictedMsg()
Displays all alert messages sent from the adapter or an error if not successful.
TIBCO Adapter for Infranet User’s Guide
preRegisterListener() 197
|
preRegisterListener()
Preregister an anticipated subscription service. Some sending applications can
anticipate requests for certified delivery even before the listening applications
start running. In such situations, the publication service can preregister
subscription services, so TIBCO Rendezvous software begins storing outbound
messages in the publication service ledger. If the listening correspondent requires
old messages, it receives the backlogged messages when it requests certified
deliver.
Input
Parameters
Type
Description
Session Name
string
Name of the session that anticipates the
listener.
Publisher Name
string
Name of the component for which the
listener should be preregistered.
Listener Session
Name
string
Name of the subscription service to
preregister.
Returns OK if the subscription service was preregistered successfully, false
otherwise.
TIBCO Adapter for Infranet User’s Guide
198
| Monitoring the Adapter Using TIBCO Hawk
resetActivityStatistics()
Resets all the counts for the activity statistics and when
g e t A c t i v i t y S t a t i s t i c s ( ) is invoked, default values are displayed.
TIBCO Adapter for Infranet User’s Guide
resetConnectionStatistics() 199
|
resetConnectionStatistics()
Resets all the counts for the connection statistics and when
g e t A c t i v i t y S t a t i s t i c s ( ) is invoked, default values are displayed.
TIBCO Adapter for Infranet User’s Guide
200
| Monitoring the Adapter Using TIBCO Hawk
resetThreadStatistics()
Resets all the counts for the thread statistics and when
g e t A c t i v i t y S t a t i s t i c s ( ) is invoked, default values are displayed.
TIBCO Adapter for Infranet User’s Guide
reviewLedger() 201
|
reviewLedger()
Returns information retrieved from the ledger file of a TIBCO Rendezvous
certified messaging session.
Before invoking this method, ensure that the certified messaging publisher
adapter has established a certified delivery agreement with its subscriber agents.
Input
Parameters
Type
Description
Session Name
string
Name of the TIBCO Rendezvous session for
which ledger information is desired (default is
all).
Subject
string
Name of the subject for which ledger
information is desired.
Returns
Type
Description
Session Name
string
Name of the TIBCO Rendezvous CM session
to which this information applies.
Subject
string
Subject name for this session.
Last Sent Message
integer
Sequence number of the most recently sent
message with this subject name.
Total Messages
string
Total number of pending messages with this
subject name.
Total Size
integer
Total storage (in bytes) occupied by all
pending messages with this subject name.
If the ledger contains ten messages with this
subject name, then this field sums the storage
space over all of them.
Listener Session
Name
string
Within each listener submessage, the Listener
Session Name field contains the name of the
delivery-tracking listener session.
TIBCO Adapter for Infranet User’s Guide
202
| Monitoring the Adapter Using TIBCO Hawk
Returns (Cont’d)
Type
Description
Last Confirmed
string
Within each listener submessage, the Last
Confirmed field contains the sequence
number of the last message for which this
listener session confirmed delivery.
Line
integer
Row number in ledger file.
Unacknowledged
Messages
integer
Number of RVCM messages pending for this
listener. The value is computed by subtracting
the last sent sequence number from the last
acknowledged sequence number.
TIBCO Adapter for Infranet User’s Guide
setDebugLevel() 203
|
setDebugLevel()
Sets the debug level for the current adapter instance.
Input
Parameter
Type
Description
DebugLevel
integer
Sets the debug level to 0 (off), 1, 2, or 3.
0— No debug information displayed.
1—SQL commands executed against the database
shown.
2—ODBC data source for each SQL command shown.
3—All debug information displayed.
Returns OK if successful or an error if not successful.
TIBCO Adapter for Infranet User’s Guide
204
| Monitoring the Adapter Using TIBCO Hawk
setTraceSinks()
Adds a role or changes the file limit of a previously specified sink.
Input
Parameters
Type
Description
Sink Name
string
Name of the sink for which you want to add a
role or change the file limit.
Role Name
string
Name of the role you want to add to this sink
(warning, error, debug, or user defined). Default
is all.
File Size
integer
Maximum file size for this sink.
This parameter is ignored if the sink specified
by sinkName is not a file sink.
Returns OK if successful or an error if not successful.
TIBCO Adapter for Infranet User’s Guide
stopApplicationInstance() 205
|
stopApplicationInstance()
Stops the specified adapter by calling the internal s t o p ( ) method. This method
returns OK if successful or an error if not successful.
TIBCO Adapter for Infranet User’s Guide
206
| Monitoring the Adapter Using TIBCO Hawk
unRegisterListener()
Unregister a currently preregistered subscription service.
Input
Parameters
Type
Description
Session Name
string
Name of the session that anticipates the
subscription service.
Publisher Name
string
Name of the publication service to which the
subscription service is preregistered.
Listener Session
Name
string
Name of the subscription service to unregister.
This method returns true if the subscription service was unregistered successfully,
false otherwise.
TIBCO Adapter for Infranet User’s Guide
getPerfMonSetting() 207
|
getPerfMonSetting()
Return the setting of the perfMon option. It returns the following information.
Returns
Type
Description
Setting
string
Value of the perfMon option.
TIBCO Adapter for Infranet User’s Guide
208
| Monitoring the Adapter Using TIBCO Hawk
getInfranetTraceInfo()
Purpose
Provides all information about tracing of SQL statements issued by the Infranet
application. This method is only available to the adapter when importing and
exporting data from the Infranet system.
Parameters
None
Returns
This method returns the following values:
Name
Type
Description
Trace On
String
Specifies whether the Infranet tracing is currently
on ('Y') or off ('N').
File Name
String
Output filename for the trace messages.
Trace Type
String
Specifies the type of tracing to start.
TIBCO Adapter for Infranet User’s Guide
setInfranetTraceOn() 209
|
setInfranetTraceOn()
Purpose
Turns on the tracing of SQL statements issued by the Infranet applications for all
connections in the connection pool.
Parameters
Name
Type
Description
File Name
String
Output filename for the trace messages.
Trace Type
String
Specifies the type of tracing to start.
Returns
None.
TIBCO Adapter for Infranet User’s Guide
210
| Monitoring the Adapter Using TIBCO Hawk
setInfranetTraceOff()
Purpose
Turns off the tracing of SQL statements issued by the Infranet applications for all
connections in the connection pool.
Parameters
Name
Type
Description
File Name
String
Output filename for the trace messages.
Trace Type
String
Specifies the type of tracing to start.
Returns
None
TIBCO Adapter for Infranet User’s Guide
| 211
Appendix A
Frequently Asked Questions
This appendix lists answers to the frequently asked questions.
Topics
•
Frequently Asked Questions, page 212
TIBCO Adapter for Infranet User’s Guide
212
| Frequently Asked Questions
Frequently Asked Questions
Can I bring up TIBCO Designer from a UNIX command-line?
No. TIBCO Designer is a GUI based tool and a UNIX GUI environment is
mandatory to run it. It cannot be brought up from a terminal.
When starting the adapter, what if the repository is not found?
Start the TIBCO Repository server before starting the adapter. If you are starting a
remote repository ensure that TIBCO Repository is installed on the remote
location. Ensure that a properly configured . d a t file is available in the path
specified (local or remote). Ensure that the RepoUrl has been specified accurately
in the adapter’s . t r a file.
Why does the adapter startup fail?
Either the repository file (.d a t ) is not placed in the
directory, or the . d a t file is
not properly configured. Ensure that the RepoUrl syntax has been specified
accurately in the adapter’s . t r a file. Ensure that the path specified for the . t r a
file is correct.
<install_path>\tibco\repository\remoterepos
Why does the adapter startup fail, even after specifying the appropriate DAT file?
You must start the repository server before you start the adapter. If it is a remote
repository ensure that the RepoUrl syntax has been specified accurately in the
adapter’s . t r a file. Ensure that the path specified for the . t r a file is correct.
Why is the adapter unable to discover any domains on the network even though the TIBCO
BusinessWorks administration server is up and running?
If your installation is on a Windows platform, go to the Services Panel and check
if the TIBCO Runtime Agent Windows service is running. If it is not, start it and
re-discover it.
When saving an adapter configuration to the project, why does it result in error messages
indicating network problems?
If your installation is on a Windows platform and your adapter is installed in a
TIBCO BusinessWorks environment, go to the Services Panel and check if the
TIBCO Runtime Agent windows service is running. If it is not, start it and
re-discover it.
TIBCO Adapter for Infranet User’s Guide
Frequently Asked Questions 213
|
If it is a stand-alone installation, check if the <install_path>\T R A \ b i n directory is
present in your PATH settings.
When saving an adapter configuration to the project, if an error occurs, where is it logged?
TIBCO Designer error messages are logged to the files s t d e r r . l o g and
d e s i g n e r . l o g under the TIBCO_HOME\ D e s i g n e r \ <ver>\ l o g s directory.
When an error occurs in a Subscription Service adapter service, where is it displayed?
Errors that occur in a request-response operation are sent to the client. Errors that
occur in a subscription operation are logged to a trace file. The log file path and
name is set in the . t r a file corresponding to the adapter instance. All logs are sent
to <install_path>\ a d a p t e r \ <adaper name>\ <version>\ l o g s unless otherwise
specified.
Why does the adapter fail to respond to a request?
The subject name may be inconsistent. The subject name to which the adapter
listens may be different from that of the subject name of the client.
Why does the adapter fail to respond to a request after successfully receiving it?
The adapter may fail to respond due to various reasons like errors resulting
from class mismatch, records not being available in the target application or,
connectivity problems with the target application.
When running the adapter, why does the following error occur?
Connection to TIB CR failed
You have referred an incorrect .DAT file in your command line.
Why does the Query feature not work while using TIBCO BusinessWorks to send a request to
the adapter?
While using TIBCO BusinessWorks to send a request to the adapter, the Query
feature does not work in the following scenario:
— if the Transport Type is JMS or,
— if the Transport Type is TIBCO Rendezvous and the wireformat is AEXML
TIBCO Adapter for Infranet User’s Guide
214
| Frequently Asked Questions
Request schema information for all queries is stored as NAME and VALUE pair in
the repository, where the NAME is stored as type STRING and VALUE is store as
type ANY. If a specific value is mapped for the field type ANY in TIBCO
BusinessWorks mapping during run-time, and if the request is sent to the adapter,
the adapter does not process the request successfully. If an ANY type field is used
to send a request from TIBCO BusinessWorks, the request will not be created
correctly if the transport is JMS or if the wireformat is AEXML in case of TIBCO
Rendezvous transport.
Specify the field type while configuring the Query operation in TIBCO Designer
as follows:
1. In the project panel, navigate to
AESchemas>ae>Infranet>GenericStaticSchema>Classes>RequestInputGe
nericSearch
2. Modify the field type of the p a r a V a l u e fields by selecting the appropriate
option from the T y p e drop-down.
3. Click Apply after modifying the field type for each p a r a V a l u e field.
For example, if STRING type information is to be provided for paraValue1 field
during run-time, change the type of paraValue1 field to STRING as mentioned
above. Similarly, other paraValue fields can be specified with corresponding data
types as per the requirement.
Once schema information of R e q u e s t I n p u t G e n e r i c S e a r c h schema is modified
as mentioned above, all query configurations across the corresponding project
configuration will have the same schema. Hence, the above workaround can not
be used if you need to have different Query request schema configurations in a
single project.
Why does an adapter instance configured with QOS as RVCMQ and multiple threads,
processes messages sequentially?
The adapter will process requests sequentially, even though multiple threads
have been configured, under the following conditions:
1. Quality of Service is RVCMQ
2. Number of Threads is greater than 1
3. Only a single Adapter instance is deployed, though the configuration is
RVCMQ.
4. Listener Task is set to 1.
TIBCO Adapter for Infranet User’s Guide
Frequently Asked Questions 215
|
The reason behind this behaviour of adapter is that the single adapter instance
will act as both a scheduler and a worker. Therefore, the requests will be handled
only one at a time. In order to ensure that the adapter behaves in a multithreaded
mode , ensure the following:
1. There is more than one instance of adapter running
2. The listener task is set to a value corresponding to the number of dispatchers.
TIBCO Adapter for Infranet User’s Guide
216
| Frequently Asked Questions
TIBCO Adapter for Infranet User’s Guide
| 217
Appendix B
Trace Messages
This appendix explains the trace messages that are logged to a location specified
at configuration time.
Topics
•
Overview, page 218
•
Trace Message Fields, page 220
•
Status Messages, page 223
TIBCO Adapter for Infranet User’s Guide
218
| Trace Messages
Overview
Trace messages provide information about adapter activities. The messages are
logged to the console where the runtime adapter was started and to a log file.
Trace messages can also be redirected to the TIBCO Hawk Display application, or
sent to other applications using the TIBCO Rendezvous transport.
Each trace message can include the following fields:
<Timestamp> <Adapter Identifier> <Role> <Category> <Status Code>
<Tracking Identifier>
The above fields are explained in Trace Message Fields on page 220. The
following diagram shows an example trace message and calls out the fields.
Timestamp
2003 Feb 22 20:15:12:937 GMT -8
Adapter Identifier
Role Category
InfranetAdapter.InfranetAdapterConfiguration Info [Adapter]
Status Code
ADINFRA-000067 Message containing class /tibco/public/class/ae/Customer received on
subject FROM.SAP
Tracking Identifier
tracking=#MU3oTJ/WWCV1MU96J0zzwA9kzzw#
Example Trace Messages
The following trace messages were written during a session where TIBCO
Adapter for Infranet received an object from TIBCO Adapter for R/3 and then
processed the object.
The first message indicates that TIBCO Adapter for Infranet has started. The
timestamp indicates when the adapter started, and the role indicates that the trace
message is informational, which means the activity is normal for the adapter. The
category is identified and the corresponding status code is displayed. The status
code indicates that the adapter started successfully.
2003 Apr 07 16:10:38:446 GMT +5
InfranetAdapterConfiguration Info [Configuration]
AESEBL-990038 "Application Ready".
The next set of trace messages indicates the adapter received an object that was
sent on the TIBCO Rendezvous subject, F R O M . S A P. The
# M U 3 o T J / W W C V 1 M U 9 6 J 0 z z w A 9 k z z w # tracking identifier included in the trace
message uniquely identifies the message. The adapter (TIBCO Adapter for R/3)
from which the message originated provided the identifier.
TIBCO Adapter for Infranet User’s Guide
Overview 219
|
2003 Apr 07 16:14:53:943 GMT +5
InfranetAdapterConfiguration Info [Adapter]
AESEBL-990034 Incoming event is BusCompPubEvent with Key Name/A*
and Operation type 4.
tracking=#iGQSCYoeNvds1kkG67zzw6R-zzw#
2003 Apr 07 16:14:57:959 GMT +5
InfranetAdapterConfiguration Info [Adapter]
AESEBL-990036 Event BusCompPubEvent completed with result 0. Time
elapsed: 3996 ms.
tracking=#iGQSCYoeNvds1kkG67zzw6R-zzw#
The final trace message states that the event has been completed with result 0 .
TIBCO Adapter for Infranet User’s Guide
220
| Trace Messages
Trace Message Fields
Each trace message includes the following fields:
Table 8 Tracing Fields
Field Name
Description
Timestamp
Timestamp of occurrence. For example, 2 0 0 3
Adapter
Identifier
This is the name of the adapter instance. For example,
InfranetAdapterConfiguration.
Role
A role can be:
Feb 22 20:14:51:718 GMT -8.
•
Info. Indicates normal adapter operation. No action is necessary. A tracing
message tagged with Info indicates that a significant processing step was
reached and has been logged for tracking or auditing purposes. Only info
messages preceding a tracking identifier are considered significant steps.
•
Warn. An abnormal condition was found. Processing will continue, but
special attention from an administrator is recommended.
•
Error. An unrecoverable error occurred. Depending on the error severity,
the adapter may continue with the next operation or may stop altogether.
•
Debug. A developer-defined tracing message. In normal operating
conditions, debug messages should not display.
When configuring the adapter you define what roles should or should not be
logged. For example, you may decide not to log Info roles to increase
performance.
TIBCO Adapter for Infranet User’s Guide
Trace Message Fields 221
|
Table 8 Tracing Fields
Field Name
Description
Category
One of the following:
Status Code
•
Adapter. The adapter is processing an event.
•
Application. The adapter is interacting with the Infranet system.
•
Configuration. The adapter is reading configuration information.
•
Database. The adapter is interacting with a database.
•
DTA. (Design-time adapter) The trace message if from the DTA.
•
Metadata. The adapter is retrieving metadata from the Infranet system.
•
Palette. The adapter is interacting with the palette.
•
Publisher Service. The Publication Service is reporting this trace message.
•
Request-Response Client Service. The Request-Response Invocation
Service is reporting this trace message.
•
Request-Response Server. The Request-Response Service is reporting this
trace message.
•
Shutdown. The adapter is shutting down.
•
Startup. The adapter is starting.
•
Subscription Service. The Subscription Service is reporting this trace
message.
•
System. This category is not linked to a specific event process. The trace
message may be related to a Microsoft Windows service related messages,
memory allocation, file system error, and so on.
•
TibRvComm. The adapter is communicating with TIBCO Rendezvous.
•
XML. The adapter is parsing XML documents.
Unique code for the message and description. Status codes are identified by a
unique number and description. If a trace message includes an error or warn
role, the status code documentation includes a resolution. See Status Messages
on page 223 for details.
TIBCO Adapter for Infranet User’s Guide
222
| Trace Messages
Table 8 Tracing Fields
Field Name
Description
Tracking
Identifier
A unique identifier that is "stamped" on each message by the originating
adapter. The tracking identifier remains in effect from a message’s beginning
to its completion as it is exchanged by TIBCO applications. If the adapter is the
termination point of the message, the tracking identifier is not displayed in the
trace message.
You cannot modify the tracking identifier format or configure what
information is displayed.
Application
Information
Application-specific information added to the tracking info to trace the
message back to its source. Set initially by the originating adapter and carried
forward. It is augmented by each intermediate component.
TIBCO Adapter for Infranet User’s Guide
Status Messages 223
|
Status Messages
Resolutions are provided wherever possible for error and warning messages. If
there is no resolution provided, or if you need additional help, contact TIBCO
Support at http://support.tibco.com.
Table 9 Error Messages
Message
Role
AEINFRA
-890001
Connection Info. No free connection available
Information
AEINFRA
-890002
Category
Adapter
Resolution
Indicates normal adapter operation. No action
necessary.
Connection Info. No context found
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-890003
Connection Info. Cannot release connection
AEINFRA
-890004
Stopping the Adapter due to persistent connection errors. Please check the Infranet
Application Server and restart adapter.
Information
Error
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Ensure that the Infranet Services are up.
AEINFRA
-890005
Adapter services suspended due to connection retry failure.
AEINFRA
-890006
Connection re-established; suspended services reactivated.
Information
Information
AEINFRA
-890007
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
Reconnect attempt %1.
Information
Application
Indicates normal adapter operation. No action
necessary.
TIBCO Adapter for Infranet User’s Guide
224
| Trace Messages
Message
Role
AEINFRA
-890008
Reconnect succeeded on attempt %1.
AEINFRA
-890009
The request received could not be processed due to connection errors. Error reply
sent back
Information
Error
AEINFRA
-890010
Category
Application
Adapter
Resolution
Indicates normal adapter operation. No action
necessary.
Ensure that the Infranet Services are up.
The request received could not be processed due to connection errors.
Error
Adapter
Ensure that the Infranet Services are up.
AEINFRA
-890011
Starting the connection retry mechanism in RETRY mode.....
AEINFRA
-890012
Starting the connection retry mechanism in POLLING mode.....
Information
Information
AEINFRA
-890013
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
An error occurred while closing the connections with Infranet. The error message is
%1.
Error
Adapter
Check whether Infranet is up and running.
AEINFRA
-890015
Error occurred. Infranet connection object %1 not found.
AEINFRA
-890016
Failed connecting to Infranet, Terminating the adapter...
Error
Error
AEINFRA
-900001
Adapter
Adapter
Check whether Infranet is up and running.
Ensure that Infranet services are up and running. Also
verify the connection parameters..
Infranet Error. %1
Error
Adapter
TIBCO Adapter for Infranet User’s Guide
Verify the message processed by the adapter. Also
ensure that Infranet services are up.
Status Messages 225
|
Message
Role
AEINFRA
-900002
FList received: %1
AEINFRA
-900004
FList received for the transaction is: %1
Information
Information
AEINFRA
-900005
Category
Adapter
Adapter
Resolution
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
Output Flist: %1
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-900010
Message processed successfully
AEINFRA
-900011
Message processing failed
Information
Information
AEINFRA
-900012
Adapter
Indicates normal adapter operation. No action
necessary.
Adapter
Indicates normal adapter operation. No action
necessary.
Invalid message received
Error
AEINFRA
-900015
Indicates normal adapter operation. No action
necessary.
Message processing failed with tracking info %1
Information
AEINFRA
-900014
Adapter
Indicates normal adapter operation. No action
necessary.
Message processed successfully with tracking info %1
Information
AEINFRA
-900013
Adapter
Adapter
Verify the message sent to the adapter.
Error while constructing Infranet FLIST from the message received
Error
Adapter
Verify whether the FLIST in the request sent to the
adapter is same as the FList configured in the adapter.
TIBCO Adapter for Infranet User’s Guide
226
| Trace Messages
Message
Role
AEINFRA
-910005
Startup Error. SDK Error %1 received on starting the adapter after initialization.
The Repository URL is %2 and the Configuration URL is %3.
Error
AEINFRA
-910010
Adapter
Resolution
Verify the adapter Repository URL and Configuration
URL given.
Startup Error. Failed to load properties file containing trace messages from path %1
for Application %2. Error Message %3
Error
AEINFRA
-910013
Category
Adapter
Verify the adapter configuration.
Started Initializing the Adapter..
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-910014
Adapter Started Successfully
AEINFRA
-910015
Registered Subscription Service %1
Information
Information
AEINFRA
-910016
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
Registered Publication Service %1 on event %2
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-910017
Registered EAIDMSubscriber
AEINFRA
-910018
Registered Request-Response Service %1
Information
Information
AEINFRA
-910021
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
%1 thread(s) created for the session %2
Information
Adapter
TIBCO Adapter for Infranet User’s Guide
Indicates normal adapter operation. No action
necessary.
Status Messages 227
|
Message
Role
AEINFRA
-910022
Attempting to connect to Infranet..
AEINFRA
-910023
Connection details: Hostname %1, Port %2, Login %3
Information
Information
AEINFRA
-910024
Category
Adapter
Adapter
Resolution
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
Opened %1 connection(s) with Infranet
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-910025
Adapter shutdown is in progress.....
AEINFRA
-910026
An error occurred while reading the value of %1 from repository. The error message
is %2.
Information
Error
AEINFRA
-910029
Check the repository for proper configuration. Also
please ensure that the repository is not corrupted.
Adapter
Check whether the adapter is configured properly. Also
please ensure whether Infranet is up and running.
Exception occurred while initializing RPC Client Components. The error message
is %1.
Error
AEINFRA
-910031
Adapter
Indicates normal adapter operation. No action
necessary.
Exception occurred while initializing the Adapter. The error message is %1.
Error
AEINFRA
-910030
Adapter
Adapter
Check whether the RPC Client service is configured
properly.
Exception occurred while initializing EAIDMSubscriber. The error message is %1.
Error
Adapter
Check the repository for proper configuration.Also
please ensure that the repository is not corrupted
TIBCO Adapter for Infranet User’s Guide
228
| Trace Messages
Message
Role
AEINFRA
-910032
Exception occurred while initializing Subscriber Components. The error message is
%1.
Error
AEINFRA
-920004
Verify whether the FLIST in the request sent to the
adapter is same as the FLIST configured in the adapter.
Adapter
Verify the message sent to the adapter.
Adapter
Check the input parameters specified.
Subscription error. Subscription service %1 listening on %2 could not send reply
for the Infranet application invocation.
Error
AEINFRA
-920020
Adapter
Subscription error. Subscription service %1 listening on subject %2. The input
FLIST for the query %3 is null due to invalid input parameters.
Error
AEINFRA
-920017
Ensure that the adapter Subscription Service is
configured properly.
Subscription error. Subscription service %1 listening on subject %2 failed due to
target application invocation error
Error
AEINFRA
-920016
Adapter
Resolution
Subscription error. Subscription service %1 listening on subject %2. Unable to map
incoming data to the Flist.
Error
AEINFRA
-920015
Category
Adapter
Check if Infranet is up and running.
The infranet connection object is null.
Error
Adapter
Check if Infranet is up and running.
AEINFRA
-920022
An error occurred while confirming the data event. The error message is %1.
AEINFRA
-920025
Subscription Service %1 received a message
Error
Information
Adapter
Adapter
TIBCO Adapter for Infranet User’s Guide
Check whether the sending application confirms to the
wire format.
Indicates normal adapter operation. No action
necessary.
Status Messages 229
|
Message
Role
AEINFRA
-930004
Publication error. Publication service %1 with publishing subject %2 received the
event from target application. It failed while converting event to MInstance.
Error
AEINFRA
-930014
Check whether the publisher service is configured
properly.
Adapter
Check the repository for proper configuration.
Adapter
Indicates normal adapter operation. No action
necessary.
Adapter
Check whether the Publication Service is configured
properly.
Publication service %1 with publishing subject %2 received the event. Publishing
Data: %3 Tracking Info: %4
Information
AEINFRA
-940001
Adapter
Publication error. An error occurred in Publisher constructor. The error message is
%1.
Error
AEINFRA
-930022
Verify whether the request sent is proper.
Event Processed. Waiting for the Next Event.
Information
AEINFRA
-930020
Adapter
Publication error. An error occurred in Publisher Event Dispatcher constructor. The
error message is %1.
Error
AEINFRA
-930019
Verify whether the event received by the adapter for
publication is same as the event for which the adapter
publisher is configured.
Publication error. An error occurred while publishing the event %1. The error
message is %2.
Error
AEINFRA
-930018
Adapter
Resolution
Publication error. Publication service %1 with publication subject %2 received error
while sending event over the wire. Error Message %3
Error
AEINFRA
-930015
Category
Adapter
Indicates normal adapter operation. No action
necessary.
Request Response error. Request Response Service %1 listening on %2 received
unexpected null data in incoming request. The Repository URL is %3 and the
Configuration URL is %4
Error
Adapter
Verify whether the request sent is proper.
TIBCO Adapter for Infranet User’s Guide
230
| Trace Messages
Message
Role
AEINFRA
-940005
Request Response error. Request-Response service %1 failed to deserialize the
received MServerRequest to MInstance: Received event on subject %2. The
Repository URL is %3 and the Configuration URL is %4
Error
AEINFRA
-940006
Verify whether the FLIST in the request sent to the
adapter is same as the FList configured in the adapter.
Adapter
Verify whether the request sent is proper.
Adapter
Indicates normal adapter operation. No action
necessary.
Request Response Service %1. About to open a new transaction
Information
AEINFRA
-940012
Adapter
Request Response Service %1. Received transaction information. Connection ID:
%2, Run in Transaction: %3, Transaction Type: %4
Information
AEINFRA
-940011
Verify whether the request sent is proper.
Request Response error. Request-Response Service %1 listening on subject %2
failed due to target application invocation error.
Error
AEINFRA
-940010
Adapter
Resolution
Request Response error. Error in incoming data for Request-Response Service: %1
on subject: %2. Unable to map incoming data to the FLIST.
Error
AEINFRA
-940009
Category
Adapter
Indicates normal adapter operation. No action
necessary.
Request Response Service %1. Opened a new transaction, and the connection id is:
%2
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-940013
Request-Response Service %1. Transaction committed successfully
AEINFRA
-940016
Attribute %1 cannot be mapped
Information
Error
Adapter
Adapter
TIBCO Adapter for Infranet User’s Guide
Indicates normal adapter operation. No action
necessary.
Verify whether the attribute mentioned is selected
while loading the schema during configuration.
Status Messages 231
|
Message
Role
AEINFRA
-940017
Input parameter in Request-Response Service Operation Schema has no values
AEINFRA
-940018
Request-Response Service Operation Schema has no input parameter
Error
Error
AEINFRA
-940020
Category
Adapter
Adapter
Resolution
Please make sure that input parameter of Request
-Response Service Operation Schema has a value.
Please make sure that Request-Response Service
Operation Schema has an input parameter.
Timeout occurred for the Connection %1. Transaction opened using this connection
is aborted.
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-940021
Request Response Server received a message for transaction.
AEINFRA
-940022
Connection Id not mentioned in the Transaction message.
Information
Error
AEINFRA
-940023
Adapter
Commit or rollback open transaction if any.
Adapter
Indicates normal adapter operation. No action
necessary.
Request Response Server Received a message.
Information
AEINFRA
-940026
Please ensure that c o n n e c t i o n _ i d field is mapped or
given correct value in the IM/BW process.
Transaction using the connection %1 is rolled back.
Information
AEINFRA
-940025
Adapter
Indicates normal adapter operation. No action
necessary.
Limit for the maximum number of transaction that can be opened is reached.
Error
AEINFRA
-940024
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Request-Response error. Request Response Service %1 listening on %2 failed to
invoke the operation %3.
Error
Adapter
Check the repository for proper configuration.
TIBCO Adapter for Infranet User’s Guide
232
| Trace Messages
Message
Role
AEINFRA
-940027
Request Response error. The error message is - %1.
AEINFRA
-940028
Request-Response error. An error occurred while trying to clone a connection for
Transaction.
Error
Error
AEINFRA
-940029
Check if Infranet is up and running.
Adapter
Check if Infranet is up and running.
Adapter
Check the repository for proper configuration.
Request-Response Service Error. Service: %1, Error: %2
Error
AEINFRA
-950002
Adapter
Check the repository for proper configuration.
Request-Response error. An error occurred in RPC Server constructor.The error
message is %1.
Error
AEINFRA
-950001
Adapter
Resolution
Request-Response error. An error occurred in portal context connection object.The
error message is - %1.
Error
AEINFRA
-940032
Category
Adapter
Verify whether the external application received the
message and sent the reply back to the adapter.
Registered RPC Client Service %1
Information
Adapter
Indicates normal adapter operation. No action
necessary.
AEINFRA
-950003
RPC Client Service %1, Message sent to external application
AEINFRA
-950004
RPC Client Service %1, Reply received from external application
Information
Information
AEINFRA
-950005
Adapter
Adapter
Indicates normal adapter operation. No action
necessary.
Indicates normal adapter operation. No action
necessary.
RPC Client Service %1, Reply received : %2
Information
Adapter
TIBCO Adapter for Infranet User’s Guide
Indicates normal adapter operation. No action
necessary.
Status Messages 233
|
Message
Role
AEINFRA
-950006
RPC Client Service %1, Message forwarded to Infranet
AEINFRA
-950007
RPC Client Service %1, Finished processing the message
Information
Information
AEINFRA
-950008
Check whether the proper reply schema is configured.
Adapter
Check whether the Request-Response Invocation
Service is configured properly.
Adapter
Check whether the Request-Response Invocation
Service is configured properly.
Adapter
Check whether the Request-Response Invocation
Service is configured properly.
RPC Client error. Request timed out before the reply arrived. The error message is
%1.
Error
AEINFRA
-950015
Adapter
RPC Client error. Error in setting the values for the MClientRequest parameters.
The error message is %1.
Error
AEINFRA
-950014
Indicates normal adapter operation. No action
necessary.
RPC Client Service error. The error message is - %1.
Error
AEINFRA
-950013
Adapter
Indicates normal adapter operation. No action
necessary.
RPC Client error. An error occurred in RPC Client constructor. The error message is
%1.
Error
AEINFRA
-950012
Adapter
Resolution
RPC Client error. An error occurred while creating the Error Reply MTree.
Request-Response Invocation Service error Service %1. Error Message is %2.
Error
AEINFRA
-950011
Category
Adapter
Check whether the external application is up and
running.
RPC Client error. Error due to missing class description or failure to
marshall/unmarshall data. The error message is %1.
Error
Adapter
Metadata class information of the repository and the
BW should be the same
TIBCO Adapter for Infranet User’s Guide
234
| Trace Messages
Message
Role
Category
AEINFRA
-950016
RPC Client error. Error in parsing the server reply and creating the reply RV
message. The error message is %1.
Error
AEINFRA
-950017
Adapter
Adapter
Check if Infranet is up and running.
RPC Client error. An error occurred while converting the FList to an MInstance.
Error
AEINFRA
-950020
Check whether the reply is in the required format.
RPC Client error. Request-Response Invocation Service error Service %1 with
subject %2 received error while requesting event over the wire. The
Request-Response Invocation Service error endpoint details are operationName
=%3 , className = %4.
Error
AEINFRA
-950018
Resolution
Adapter
Check whether there is a datatype mismatch.
RPC Client Service %1 received a message
Information
Adapter
Indicates normal adapter operation. No action
necessary.
Commonly Reported Infranet Errors
Message code a d i n f r a 0 0 0 7 5 5 indicates that a Infranet error has occurred. It may
refer to errors described in the next table.
TIBCO Adapter for Infranet User’s Guide
Status Messages 235
|
Table 10 Commonly Reported Infranet Errors
Message
Code
Description
Role
Category
Resolution
adinfra000755
An error has occurred
executing a Sql statement.
Please continue or ask your
systems administrator to
check your application
configuration if the
problem persists.
[Microsoft][ODBC SQL
Server Driver][SQL
Server]Line 3: Incorrect
syntax near ','.
[Microsoft][ODBC SQL
Server Driver][SQL
Server]The cursor was not
declared.
Error
Configuration
This error is thrown when
the adapter tries to update
fields having a '#' in them.
Check if the field has a base
column linked to it.
adinfra000755
The specified language
function is not defined.
Error
Configuration
Infranet Scripting issue.
Incase of Infranet 2000, open
the Infranet configuration
file. Under the [Infranet]
section, set
EnableScripting=False and
retry. If the adapter runs
successfully, it indicates that
the issue is with Infranet
Scripts that are being called
as part of this configuration.
TIBCO Adapter for Infranet User’s Guide
236
| Trace Messages
TIBCO Adapter for Infranet User’s Guide
| 237
Appendix C
Infranet Opcodes, Datatypes and FLISTs
This appendix lists Infranet opcodes and data types.
Topics
•
Opcode, page 238
•
Customizing HTML Specification Files, page 240
•
Data Types, page 244
•
FLists, page 246
•
Known Problems with Infranet HTML FLists, page 247
TIBCO Adapter for Infranet User’s Guide
238
| Infranet Opcodes, Datatypes and FLISTs
Opcode
An Opcode is an established protocol API published by Infranet. Any published
opcode has input and output specifications that are specified using Infranet
FLISTs. See Infranet Opcodes, Datatypes and FLISTs on page 237. The adapter
uses opcodes with its input/output FLISTs to execute any business function in the
Infranet system. Therefore, you must import the opcode description into the
repository using TIBCO Designer so the adapter will know about it.
When an opcode is imported, the opcode description is stored as
C o m m a n d I n s t a n c e and C o m m a n d S c h e m a in the repository. C o m m a n d I n s t a n c e
contains the opcode name, input class name, and output class name of the
opcode. C o m m a n d S c h e m a contains the input and output classes of the opcode. The
input class generates the input FLIST required for an opcode to execute. The
output class captures the output FLIST generated by the opcode.
For a list of FLIST specifications, see the Infranet documentation.
For each opcode, there are two HTML files, one each for the input and output
FLIST specifications. The input FLIST specification is contained in the file
< o p c o d e N a m e > . i n p u t . h t m l , and the output FLIST specification is contained in
the file < o p c o d e N a m e > . o u t p u t . h t m l . You must have access to these specification
files on the machine on which TIBCO Designer runs.
Infranet allows you to customize the input and output FLISTs of certain opcodes.
If you perform such customization in Infranet, FLIST specification files of these
opcodes must be modified using the procedure described in Customizing HTML
Specification Files on page 240.
Infranet allows you to add custom opcodes. A procedure to import custom
opcodes into the repository is described in Custom Opcode Configuration on
page 155.
It has been discovered that some of the FLIST specification files contain errors. on
page 246 lists the types of errors we have encountered. If you cannot import a
FLIST or if it does not give you the expected results, you may:
•
Contact Portal Software Support to get a corrected version of the file.
•
Contact the TIBCO Professional Services Group.
Before importing an HTML file, check that its name is formatted correctly. The
required HTML file name format is < o p c o d e > . i n p u t . h t m l . If the HTML file
name is not in the required format, you must rename the file.
TIBCO Adapter for Infranet User’s Guide
Opcode 239
|
There are two types of opcodes: system opcodes and policy opcodes. System
opcodes perform basic operations in the Infranet. Therefore, you cannot change
them. Policy opcodes perform higher-level operations and you can change their
default behavior. For example, you can modify a policy to rate IP-access usage by
bytes downloaded instead of access time.
Some PCM opcodes require I N D E X values to be specified for A R R A Y type of fields.
You can specify these values in TIBCO BusinessWorks process. If values are not
specified, incremental values are assigned to the I N D E X .
TIBCO Adapter for Infranet User’s Guide
240
| Infranet Opcodes, Datatypes and FLISTs
Customizing HTML Specification Files
To customize an opcode for your business need, you need to:
•
Know what opcode you want to use.
•
Know your input and output requirements.
•
Modify the HTML input and output specifications to meet your business
needs.
•
Validate your changes.
The following examples explain how to customize an HTML input/output
specification of an opcode to suit your specific business needs:
PCM_OP_BILL_PURCHASE_DEAL.input.html
In this input FList, there are two alternatives for purchasing an existing deal.
Alternative 1
The PIN_FLD_DEAL_INFO substructure contains the fields,
PIN_FLD_DEAL_OBJ and PIN_FLD_PLAN_OBJ only.
Alternative 2
The PIN_FLD_DEAL_INFO substructure contains the entire
PIN_FLD_DEAL_OBJ, which contains parameter info like Purchase discount,
start time, end time, etc. and Cycle fee details.
In the adapter schema class, service Purchase Deal uses Alternative 1. So, in the
file PCM_OP_BILL_PURCHASE_DEAL.input.html, Alternative 2 is commented.
If required, Alternative 2 can be used by changing the schema in the adapter.
PCM_OP_CUST_UPDATE_CUSTOMER.input.html
In this example, you need to modify the HTML input specifications to include the
attributes specific to the business needs which do not exist in the input HTML. In
this case, additional fields are added under P I N _ F L D _ I N H E R I T E D _ I N F O (according
to specific business needs).
Original FList:
array PIN_FLD_PAYINFO (
type
= PIN_FLDT_ARRAY,
perms = O,
);
! Payinfo poid - only uses the type.
TIBCO Adapter for Infranet User’s Guide
Customizing HTML Specification Files 241
|
field PIN_FLD_POID (
type =PIN_FLDT_POID,
perms = M,
);
! Type of billing for user
field
* PIN_FLD_BILL_TYPE (
type = PIN_FLDT_ENUM,
perms = M,
);
! All inherited fields for the payinfo object are included in
! this substruct.
substruct * PIN_FLD_INHERITED_INFO (
type = PIN_FLDT_SUBSTRUCT,
perms = O,
);
!end substruct PIN_FLD_INHERITED_INFO
!end arrray PIN_FLD_PAYINFO
Changed FList:
! All inherited fields for the payinfo object are included in
! this substruct.
substruct * PIN_FLD_INHERITED_INFO (
type =PIN_FLDT_SUBSTRUCT,
perms = O,
);
array * * PIN_FLD_INV_INFO (
type =PIN_FLDT_ARRAY,
perms = O,
);
field * * * PIN_FLD_NAME (
type = PIN_FLDT_STR(255),
perms = O,
);
field * * * PIN_FLD_ADDRESS (
type =PIN_FLDT_STR(255),
perms = O,
);
field * * * PIN_FLD_COUNTRY (
type = PIN_FLDT_STR(60),
perms = O,
);
field * * * PIN_FLD_STATE (
type = PIN_FLDT_STR(90),
perms = O,
);
field * * * PIN_FLD_CITY (
type =PIN_FLDT_STR(90),
perms = O,
);
field * * * PIN_FLD_ZIP (
type =PIN_FLDT_STR(12),
perms = O,
);
! end substruct PIN_FLD_INHERITED_INFO
TIBCO Adapter for Infranet User’s Guide
242
| Infranet Opcodes, Datatypes and FLISTs
! end array PIN_FLD_PAYINFO
PCM_OP_CUST_COMMIT_CUSTOMER.input.html
This structure was modified to include PIN_FLD_INV_INFO,
PIN_FLD_BILL_TYPE and PIN_FLD_POID. PIN_FLD_INV_INFO contains the
following fields:
PIN_FLD_NAME
PIN_FLD_ADDRESS
PIN_FLD_COUNTRY
PIN_FLD_STATE
PIN_FLD_CITY
PIN_FLD_ZIP
Original FList:
substruct * PIN_FLD_INHERITED_INFO (
type =PIN_FLDT_SUBSTRUCT,
perms = O,
);
Changed FLists:
array PIN_FLD_PAYINFO (
type=PIN_FLDT_ARRAY,
perms=O,
);
!payinfo object poid
field * PIN_FLD_POID (
type=PIN_FLDT_POID,
perms=O,
);
!invoice object - in case you are using invoice object type
field * PIN_FLD_BILL_TYPE (
type =PIN_FLDT_ENUM,
perms =O,
);
! All inherited fields for the payinfo object are included in
! this substruct.
substruct * PIN_FLD_INHERITED_INFO (
type = PIN_FLDT_SUBSTRUCT,
perms = O,
);
!invoice info array
array * * PIN_FLD_INV_INFO (
type =PIN_FLDT_ARRAY,
perms = O,
);
field * * * PIN_FLD_NAME (
type =PIN_FLDT_STR(255),
perms =O,
);
TIBCO Adapter for Infranet User’s Guide
Customizing HTML Specification Files 243
|
field * * * PIN_FLD_ADDRESS (
type =PIN_FLDT_STR(255),
perms =O,
);
field * * * PIN_FLD_COUNTRY (
type = PIN_FLDT_STR(60),
perms = O,
);
field * * * PIN_FLD_STATE (
type =PIN_FLDT_STR(90),
perms = O,
);
field * * * PIN_FLD_CITY (
type =PIN_FLDT_STR(90),
perms= O,
);
field * * * PIN_FLD_ZIP (
type =PIN_FLDT_STR(12),
perms = O,
);
TIBCO Adapter for Infranet User’s Guide
244
| Infranet Opcodes, Datatypes and FLISTs
Data Types
Infranet supports a set of data types that you use to define fields in a storable class
or in field lists.
The following table lists the data types supported by Infranet. Some of the
Infranet data types are simple, which map to data types in programming
languages such as C. The others hold more complex data and point to C structure
as their value.
Table 11
Data Types
Data Type
Description
C Value
PIN_FLDT_INT
Signed 32-bit integer. Contains four bytes
of data represented by a number.
int 32
PIN_FLDT_ENUM
Enumerated value. Contains a list of
well-known values.
enum
PIN_FLDT_DECIMA
L
Decimal data type, number of decimal
places determined by MAX.
pin_decimal_t
PIN_FLDT_STR(len)
ASCII character string terminated with a
\0 (NULL). len=max length in bytes, not
including \0. It uses UTF-8 encoding.
char *
PIN_FLDT_BINSTR(l
en)
A string of binary data. len=max length in
bytes.
pin_binstr_t
PIN_FLDT_TSTAMP
UNIX timestamp with 1 second accuracy.
Contains integer data. This number is
interpreted as the number of seconds past
January 1, 1970.
time_t
PIN_FLDT_POID
Portal Object Identifier. See Portal object
ID (POID).
poid_t *
PIN_FLDT_ARRAY
Array element. See Arrays.
pin_flist_t *
PIN_FLDT_SUBSTR
UCT
Embedded substructure. See
Substructure.
pin_flist_t *
PIN_FLDTBUF
Buffer with an arbitrary size of any large
data such as text, image, or any other
kind of data.
pin_buf_t
TIBCO Adapter for Infranet User’s Guide
Data Types 245
|
Table 11
Data Types
Data Type
Description
C Value
PIN_FLDT_ERRBUF
Structure for error holding error
information.
pin_errbuf_t
TIBCO Adapter for Infranet User’s Guide
246
| Infranet Opcodes, Datatypes and FLISTs
FLists
The adapter uses opcodes to execute any business function in the Infranet system.
The opcodes have input and output specifications represented using Infranet
FLists. For example, to change the address of an account, the opcode
PCM_OP_SET_NAMEINFO API function is used with the input FList listed next.
Table 12
Input FLists
S.
No
Field Name
Infranet Data type
Values
1.
PIN_FLD_POID
POID[0]
0.0.0.1 /account
1728222
2.
PIN_FLD_NAMEINFO
ARRAY[1]
3.
PIN_FLD_ADDRESS
STR[0]
“#3, Crescent Street”
4.
PIN_FLD_PROGRAM_N
AME
STR[0]
“testnap”
After execution, the following output FLists are returned.
Table 13
Output FLists
S.
No
Field Name
Infranet Data type
Values
1.
PIN_FLD_POID
POID[0]
0.0.0.1 /account 1728222
2.
PIN_FLD_RESULTS
ARRAY[0]
3.
PIN_FLD_POID
POID[0]
TIBCO Adapter for Infranet User’s Guide
/event/customer/name
info 18518 0
Known Problems with Infranet HTML FLists 247
|
Known Problems with Infranet HTML FLists
This section lists known problems encountered when importing FList
specification files.
•
Erroneous file names
The HTML file names must have the format < o p c o d e > . i n p u t . h t m l or
< o p c o d e > . o u t p u t . h t m l . If the file name does not conform to this standard,
you need to modify the file name. For example, some valid opcode names are:
PCM_OP_CUST_POL_GET_LOANS.input.html and
PCM_OP_CUST_FIND.output.html.
•
Syntax Errors
Some HTML files have syntax errors. For example, in
PCM_OP_CUST_POL_GET_LOANS.input.html the original source was:
PIN_FLD_POID
type = PIN_FLDT_POID, perms = M,
);
However, the correct source is:
field PIN_FLD_POID (
type = PIN_FLDT_POID, perms = M,
);
•
Missing Fields
Some FList files have missing fields. If the field is mandatory it is possible to
detect that the field is missing by running the opcode using the t e s t n a p
utility provided by the Infranet or by knowing the list of fields within a
storable object, which you can read using the t e s t n a p utility.
For example, at the t e s t n a p command line, type the following command line
argument: n a p > r o b j - 0 . 0 . 0 . 1 / a c c o u n t 4 5 6 7 8
See Infranet documentation for details.
•
Fields Specified at the Wrong Level
In some FList files, nested fields may not be specified at the correct level. For
example, in PCM_OP_CUST_FIND.output.html file, the original source is:
TIBCO Adapter for Infranet User’s Guide
248
| Infranet Opcodes, Datatypes and FLISTs
Original FList:
! Array of results information.array
PIN_FLD_RESULTS (
type = PIN_FLDT_ARRAY, perms = O,
);
! account object poid
field PIN_FLD_POID (
type = PIN_FLDT_POID, perms = M,
);
! account number that matched the account object
field PIN_FLD_ACCOUNT_NO (
type = PIN_FLDT_STR(255), perms = M,
);
! + other fields of interest from the account object are optional.
! specified from the PIN_FLD_RESULTS array of the input flist
! end of array PIN_FLD_RESULTS
However, this is not correct because both the fields PIN_FLD_POID and
PIN_FLD_ACCOUNT_NO are within the array PIN_FLD_RESULTS. That is,
the array is at level 0, and both the fields are at level 1. In such cases, you need
to add an asterisk ( * ) for fields at level 1 as shown below. If there is more than
one level of nesting, then you need to add two asterisks (**).
Changed FLIST:
! Array of results information
array PIN_FLD_RESULTS (
type = PIN_FLDT_ARRAY, perms = O,
);
! account object poid
field * PIN_FLD_POID (
type = PIN_FLDT_POID, perms = M,
TIBCO Adapter for Infranet User’s Guide
Known Problems with Infranet HTML FLists 249
|
);
! account number that matched the account object
field * PIN_FLD_ACCOUNT_NO (
type = PIN_FLDT_STR(255), perms = M,
);
! + other fields of interest from the account object are optional.
! specified from the PIN_FLD_RESULTS array of the input flist
! end of array PIN_FLD_RESULTS
•
SCCS ID Missing
The program that executes the opcode Importer checks for the version
number of the HTML file. For example, While importing
PCM_OP_CUST_READ_ACCT_ PRODUCTS.input.html, the adapter
prompts the error: S C C S I D i s M i s s i n g . While importing this input HTML,
it returns the error: P C M _ O P _ C U S T _ R E A D _ A C C T _ P R O D U C T S _ i n s t a n c e . x m l
n o t f o u n d . In this case, you need to add the SCCS ID: ! @ ( # )
PCM_OP_CUST_READ_ACCT_ PROCUCTS.input 1.1 97/03/26
TIBCO Adapter for Infranet User’s Guide
250
| Infranet Opcodes, Datatypes and FLISTs
TIBCO Adapter for Infranet User’s Guide
TIBCO Software Inc. End User License Agreement
| 251
TIBCO Software Inc. End User License Agreement
READ THIS END USER LICENSE AGREEMENT CAREFULLY. BY
DOWNLOADING OR INSTALLING THE SOFTWARE, YOU AGREE
TO BE BOUND BY THIS AGREEMENT. IF YOU DO NOT AGREE TO
THESE TERMS, DO NOT DOWNLOAD OR INSTALL THE
SOFTWARE AND RETURN IT TO THE VENDOR FROM WHICH IT
WAS PURCHASED.
Upon your acceptance as indicated above, the following shall govern
your use of the Software except to the extent all or any portion of the
Software (a) is subject to a separate written agreement, or (b) is
provided by a third party under the terms set forth in an Addenda at
the end of this Agreement, in which case the terms of such addenda
shall control over inconsistent terms with regard to such portion(s).
License Grant. The Software is the property of TIBCO or its licensors
and is protected by copyright and other laws. While TIBCO continues
to own the Software, TIBCO hereby grants to Customer a limited,
non-transferable, non-exclusive, license to use the Number of Units
set forth in the Ordering Document, in machine-readable, object code
form and solely for Customer's internal business use.
Restrictions. Customer agrees not to (a) make more copies than the
Number of Units plus a reasonable number of backups; (b) provide
access to the Software to anyone other than employees, contractors,
or consultants under written contract with Customer agreeing to be
bound by terms at least as protective of TIBCO as those in this End
User License Agreement ("Authorized Users"); (c) sublicense,
transfer, assign, distribute to any third party, pledge, lease, rent, or
commercially share the Software or any of Customer's rights under
this Agreement (for the purposes of the foregoing a change in control
of Customer is deemed to be an assignment); (d) use the Software for
purposes of providing a service bureau, including, without limitation,
providing third-party hosting, or third-party application integration or
application service provider-type services, or any similar services; (e)
use the Software in connection with ultrahazardous activities, or any
activity for which failure of the Software might result in death or serious
bodily injury to Customer or a third party; or (f) directly or indirectly, in
whole or in part, modify, translate, reverse engineer, decrypt,
decompile, disassemble, make error corrections to, create derivative
works based on, or otherwise attempt to discover the source code or
underlying ideas or algorithms of the Software. Customer may engage
in such conduct as is necessary to ensure the interoperability of the
Software as required by law, provided that prior to commencing any
decompilation or reverse engineering of any Software, Customer
agrees to it shall observe strict obligations of confidentiality and
provide TIBCO reasonable advance written notice and the opportunity
to assist with and/or conduct such activity on Customer's behalf and at
Customer's expense.
Beta and Evaluation Licenses. Notwithstanding the foregoing, if the
Software is being provided for demonstration, beta testing, or
evaluation purposes, then Customer agrees (a) to use the Software
solely for such purposes, (b) that the Software will not be used or
deployed in a production or development environment, and (c) that
such use shall automatically terminate upon the earlier of thirty days
from the date Customer receives the right to install the Software, or
Customer's receipt of notice of termination from TIBCO.
Maintenance. Provided Customer has paid applicable support fees
(not included with Software fees unless separately listed), TIBCO shall
provide support for generally available Software ("Maintenance") on
an annual basis commencing on the Purchase Date. Thereafter
Maintenance will be automatically renewed for successive one (1)
year terms at the then current rates. Customer shall designate at
TIBCO's support website
https://support.tibco.com/eSupport/newuser.html, the number of
authorized contacts as permitted by TIBCO based on the level of
Maintenance purchased (contacts are changeable upon 48-hours
prior written notice to TIBCO). Each contact may contact TIBCO for
problem resolution during TIBCO's published support hours
corresponding to the level of Maintenance purchased.
Upon notice from a contact of a Software problem which can be
reproduced at a TIBCO Maintenance facility, TIBCO shall use
reasonable efforts to correct or circumvent the problem according to
its published maintenance objectives. TIBCO reserves the right to
make changes only to the most currently available version. TIBCO will
use reasonable efforts to support the previously released version of
the Software for a maximum of six months.
TIBCO shall have no obligation to provide Maintenance for the
Software if (i) used on any computer system running other than the
operating system software for which the Software is approved (as set
forth in the Software documentation) and licensed hereunder, or (ii) if
Customer has modified or authorized a third party to modify the
Software. TIBCO shall have no obligation to modify any version of the
Software to run with any new versions of any operating system, or any
other third party software or hardware. If Customer purchases
Maintenance for any Software, Customer must purchase the same
level of Maintenance for all copies of the Software for which it is
licensed.
Maintenance Fees for lapsed Maintenance or the changing of the level
of Maintenance shall be mutually agreed upon between Customer and
TIBCO. Upgrades, patches, enhancements, bug fixes, new versions
and/or new releases of the Software provided from time to time under
Maintenance shall be used only as replacements to existing copies,
and shall not be deemed to increase the Number of Units, and use
thereof shall be governed by the terms of this Agreement, except for
the first paragraph of the Limited Warranty and any right of return or
refund.
Services. Customer may request additional services ("Services")
either in an Ordering Document, or by a separate mutually executed
work order, statement of work or other work-request document
incorporating the term of this End User License Agreement (each, a
"Work Order"). Unless otherwise expressly agreed to in a Work Order,
all Services and any work product therefrom shall be (a) performed on
a time and materials basis, plus meals, lodging, travel, and other
expenses reasonably incurred in connection therewith, (b) deemed
accepted upon delivery, and (c) exclusively owned by TIBCO (except
for Confidential Information of Customer), including all right, title and
intellectual property or other right or interest therein. Each Work Order
is intended to constitute an independent and distinct agreement of the
parties, notwithstanding that each shall be construed to incorporate all
applicable provisions of this End User License Agreement. Fees for
Services shall be due and payable in United States dollars net 30 from
the date of TIBCO's invoice.
Limited Warranty. If Customer obtained the Software directly from
TIBCO, then TIBCO warrants that for a period of thirty (30) days from
the Purchase Date: (i) the media on which the Software is furnished
will be free of defects in materials and workmanship under normal
use; and (ii) the Software will substantially conform to its
Documentation. This limited warranty extends only to the original
Customer hereunder. Customer's sole and exclusive remedy and the
entire liability of TIBCO and its licensors under this limited warranty
will be, at TIBCO's option, repair, replacement, or refund of the
TIBCO Adapter for Infranet User’s Guide
252
| TIBCO Software Inc. End User License Agreement
Software and applicable Maintenance fees, in which event this End
User License Agreement shall terminate upon refund thereof.
This warranty does not apply to any Software which (a) is licensed for
beta, evaluation, testing or demonstration purposes for which TIBCO
does not receive a license fee, (b) has been altered or modified,
except by TIBCO, (c) has not been installed, operated, repaired, or
maintained in accordance with instructions supplied by TIBCO, (d) has
been subjected to abnormal physical or electrical stress, misuse,
negligence, or accident, or (e) is used in violation of any other term of
this End User License Agreement. Customer agrees to pay TIBCO for
any Maintenance or Services provided by TIBCO related to a breach
of the foregoing on a time, materials, travel, lodging and other
reasonable expenses basis. If Customer obtained the Software from a
TIBCO reseller or distributor, the terms of any warranty shall be as
provided by such reseller or distributor, and TIBCO provides Customer
no warranty with respect to such Software.
EXCEPT AS SPECIFIED IN THIS LIMITED WARRANTY, THE
SOFTWARE, MAINTENANCE AND SERVICES ARE PROVIDED "AS
IS", ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS, AND WARRANTIES INCLUDING, WITHOUT
LIMITATION, ANY IMPLIED WARRANTY OR CONDITION OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
NONINFRINGEMENT, SATISFACTORY QUALITY OR ARISING
FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE,
ARE HEREBY EXCLUDED TO THE EXTENT ALLOWED BY
APPLICABLE LAW. CERTAIN THIRD PARTY SOFTWARE MAY BE
PROVIDED TO CUSTOMER ALONG WITH CERTAIN TIBCO
SOFTWARE AS AN ACCOMMODATION TO CUSTOMER. THIS
THIRD PARTY SOFTWARE IS PROVIDED "AS IS". CUSTOMER
MAY CHOOSE NOT TO USE THIRD PARTY SOFTWARE PROVIDED
AS AN ACCOMMODATION BY TIBCO. NO WARRANTY IS MADE
REGARDING THE RESULTS OF ANY SOFTWARE, MAINTENANCE
OR SERVICES OR THAT THE SOFTWARE WILL OPERATE
WITHOUT ERRORS, PROBLEMS OR INTERRUPTIONS, OR THAT
ERRORS OR BUGS IN THE SOFTWARE WILL BE CORRECTED,
OR THAT THE SOFTWARE'S FUNCTIONALITY, MAINTENANCE OR
SERVICES WILL MEET CUSTOMER'S REQUIREMENTS. NO
TIBCO DEALER, DISTRIBUTOR, AGENT OR EMPLOYEE IS
AUTHORIZED TO MAKE ANY MODIFICATIONS, EXTENSIONS OR
ADDITIONS TO THIS WARRANTY.
Indemnity. If Customer obtained the Software from TIBCO directly,
then TIBCO agrees at its own expense to defend or, at its option, to
settle, any claim or action brought against Customer to the extent it is
based on a claim that the unmodified Software infringes any patent
issued by the United States, Canada, Australia, Japan, or any member
of the European Union, or any copyright, or any trade secret of a third
party; and TIBCO will indemnify and hold Customer harmless from
and against any damages, costs and fees reasonably incurred
(including reasonable attorneys' fees) that are attributable to such
claim or action and which are assessed against Customer in a final
judgment; provided that TIBCO is promptly notified in writing of such
claim, TIBCO has the exclusive right to control such defense and/or
settlement, and Customer shall provide reasonable assistance (at
TIBCO's expense) in the defense thereof. In no event shall Customer
settle any claim, action or proceeding without TIBCO's prior written
approval. In the event of any such claim, litigation or threat thereof,
TIBCO, at its sole option and expense, shall (a) procure for Customer
the right to continue to use the Software or (b) replace or modify the
Software with functionally equivalent software. If such settlement or
modification is not commercially reasonable (in the reasonable opinion
of TIBCO), TIBCO may cancel this End User License Agreement upon
sixty days prior written notice to Customer, and refund to Customer
the unamortized portion of the license fees paid to TIBCO by
Customer based on a five-year straight-line depreciation. This Section
TIBCO Adapter for Infranet User’s Guide
states the entire liability of TIBCO with respect to the infringement of
any intellectual property rights, and Customer hereby expressly
waives any other liabilities or obligations of TIBCO with respect
thereto. The foregoing indemnity shall not apply to the extent any
infringement could have been avoided by use of the then-current
release.
Limitation of Liability. EXCEPT AS PROVIDED UNDER
INDEMNITY OR RESULTING FROM A BREACH OF
CONFIDENTIALITY (THE "EXCLUDED MATTERS"), IN NO EVENT
WILL EITHER PARTY OR TIBCO'S LICENSORS BE LIABLE FOR
ANY LOST DATA, LOST REVENUE, LOST PROFITS, DAMAGE TO
REPUTATION, BUSINESS INTERRUPTION, OR ANY OTHER
INDIRECT, INCIDENTAL, CONSEQUENTIAL, SPECIAL, PUNITIVE,
EXEMPLARY OR ANY SIMILAR TYPE DAMAGES ARISING OUT OF
THIS AGREEMENT, THE USE OR THE INABILITY TO USE THE
SOFTWARE, OR THE PROVISION OF ANY MAINTENANCE OR
SERVICES, EVEN IF A PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES. EXCEPT FOR THE EXCLUDED
MATTERS, IN NO EVENT SHALL A PARTY BE LIABLE TO THE
OTHER, WHETHER IN CONTRACT, TORT (INCLUDING ACTIVE OR
PASSIVE NEGLIGENCE), BREACH OF WARRANTY, CLAIMS BY
THIRD PARTIES OR OTHERWISE, EXCEED THE PRICE PAID BY
CUSTOMER UNDER THE APPLICABLE ORDERING DOCUMENT.
THE FOREGOING LIMITATIONS SHALL APPLY EVEN IF THE
ABOVE-STATED REMEDY OR LIMITED WARRANTY FAILS OF ITS
ESSENTIAL PURPOSE. BECAUSE SOME STATES OR
JURISDICTIONS DO NOT ALLOW LIMITATION OR EXCLUSION OF
CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE
LIMITATION MAY NOT APPLY TO CUSTOMER.
Confidentiality. "Confidential Information" means the terms of this
End User License Agreement; all information marked by the disclosing
party as proprietary or confidential; any provided software, related
documentation or related performance test results derived by
Customer; and any methods, concepts or processes utilized in
provided software or related documentation. Confidential Information
shall remain the sole property of the disclosing party and shall not be
disclosed to any non-Authorized User of either TIBCO or Customer
without the prior written consent of the disclosing party. If Confidential
Information is communicated orally, such communication shall be
confirmed as "Confidential" in writing within thirty days of such
disclosure. The parties agree to protect the Confidential Information of
the other in the same manner it protects the confidentiality of similar
information and data of its own (and at all times exercising at least a
reasonable degree of care). Except with respect to the Software, items
will not be deemed Confidential Information if (i) available to the public
other than by a breach of an agreement with TIBCO, (ii) rightfully
received from a third party not in breach of any obligation of
confidentiality, (iii) independently developed by one party without use
of the Confidential Information of the other; (iv) known to the recipient
at the time of disclosure (other than under a separate confidentiality
obligation); or (v) produced in compliance with applicable law or court
order, provided the other party is given reasonable notice of the same.
Both parties agree to indemnify the other for any damages the other
may sustain resulting from their unauthorized use and/or disclosure of
the other's Confidential Information. Such damages shall include
reasonable expenses incurred in seeking both legal and equitable
remedies. To the extent required by law, at Customer's request,
TIBCO shall provide Customer with the interface information needed
to achieve interoperability between the Software and another
independently created program, on payment of TIBCO's applicable
fee. Customer agrees to observe obligations of confidentiality with
respect to such information.
TIBCO Software Inc. End User License Agreement
Export. Software, including technical data, is subject to U.S. export
control laws, including the U.S. Export Administration Act and its
associated regulations, and may be subject to export or import
regulations in other countries. Customer agrees to comply strictly with
all such regulations and agrees to obtain all necessary licenses to
export, re-export, or import Software.
Government Use. If the Customer is an agency, department, or other
entity of the United States Government ("Government"), the use,
duplication, reproduction, release, modification, disclosure or transfer
of the Software, or any related documentation of any kind, including
technical data or manuals, is restricted in accordance with Federal
Acquisition Regulation ("FAR") 12.212 for civilian agencies and
Defense Federal Acquisition Regulation Supplement ("DFARS")
227.7202 for military agencies. The Software is commercial computer
software and commercial computer software documentation. Use of
the Software and related documentation by the Government is further
restricted in accordance with the terms of this Agreement, and any
modification thereto.
Orders. An Ordering Document shall be deemed accepted only by
issuance of a TIBCO invoice and solely for purposes of administrative
convenience. None of the terms of the Ordering Document (other than
the Software product name, Number of Units, level of Maintenance,
description of Services, and fees due in connection therewith) shall
apply for any reason or purpose whatsoever, regardless of any
statement on any Ordering Document to the contrary, unless
countersigned by an officer of TIBCO. This Agreement constitutes the
entire agreement between the parties with respect to the use of the
Software, Maintenance and Services, and supersedes all proposals,
oral or written, and all other representations, statements, negotiations
and undertakings relating to the subject matter hereof. All orders of
Software, Maintenance or Services by Customer to TIBCO shall be
deemed to occur with or without reference to, under the terms of this
End User License Agreement, unless expressly superseded by a
signed written agreement between the parties. Neither the license to
use the Software granted in this Agreement nor the obligation to pay
the license fees set forth above are dependent upon the performance
by any party of any Services or the supply of any other software
program or product. Software shall be delivered electronically, and
such delivery shall be deemed complete when the Software is made
available for download by Customer.
Term and Termination. Maintenance or Services may be terminated:
(a) by either party upon a default of the other, such default remaining
uncured for fifteen days from written notice from the non-defaulting
party; (b) upon the filing for bankruptcy or insolvency of the other
party, (c) by either party upon prior written notice at least ninety (90)
days prior to the end of any annual Maintenance term; or (d) by
Customer (for Services), upon ten days prior written notice.
Termination of Maintenance or Services shall not terminate this End
User License Agreement. Customer may terminate this End User
License Agreement in its entirety at any time by destroying all copies
of the Software. Upon termination of this End User License Agreement
in its entirety, for any reason, Customer must cease using and return
or destroy all copies of the Software. Customer's obligation to pay
accrued charges and any fees due as of the date of termination, as
well as the sections entitled "Confidentiality", "Limited Warranty" and
"Limitation of Liability" shall survive any such termination.
Authority. You hereby represent and warrant that you have full power
and authority to accept the terms of this End User License Agreement
on behalf of Customer, and that Customer agrees to be bound by this
End User License Agreement.
General. Fees on the Ordering Document (all to be paid on the latter
of thirty days from Invoice by TIBCO or the date set forth in the
| 253
Ordering Document) do not include sales, use, withholding,
value-added or similar taxes, and Customer agrees to pay all sales,
use, value-added, goods and services, consumption, withholding,
excise and any other similar taxes or government charges, exclusive
of TIBCO's income tax. Customer agree to pay all reasonable costs
incurred (including reasonable attorneys' fees) in collecting past due
amounts. Except as set forth in the Section entitled "Limited Warranty"
all fees paid under or in connection with this End User License
Agreement are non-refundable and no right of set-off exists. All
payments of fees due shall be made in U.S. dollars, net 30 from
Purchase Date, or, for any other amounts coming due hereafter, net
30 from TIBCO's invoice. A service charge of one and one-half
percent per month will be applied to all invoices that are not paid on
time. No delay in the performance of any obligation by either party,
excepting all obligations to make payment, shall constitute a breach of
this End User License Agreement to the extent caused by force
majeure. Customer hereby grants TIBCO and its independent auditors
the right to audit Customer's compliance with this End User License
Agreement. If any portion of this End User License Agreement is
found to be void or unenforceable, the remaining provisions shall
remain in full force and effect. This End User License Agreement shall
be governed by and construed in accordance with the laws of the
State of California, United States of America, as if performed wholly
within the state and without giving effect to the principles of conflict of
law. The United Nations Convention on Contracts for the International
Sale of Goods is excluded from application hereto. If any portion
hereof is found to be void or unenforceable, the remaining provisions
of this Agreement shall remain in full force and effect.
Definitions. In connection with this End User License Agreement the
following capitalized terms shall have the following meaning: "CICS
Region" means a subdivided mainframe address space managed by
CICS for resource allocation, resource sharing, and transaction
execution, of which the resource definitions include the TIBCO EMS
Client for z/OS; "Connection" means for TIBCO SmartSockets and
TIBCO SmartMQ, any network protocol link established with such
Software (directly or indirectly) to any other entity, including but not
limited to software, firmware or hardware; "Connected Processor"
means a Processor that produces information or messages consumed
by the relevant Software (excluding Processors on devices such as
routers, switches, proxies, HTTP or application servers configured to
substantially pass-through information or messages to TIBCO
Software); "Customer" means the original purchaser or licensee of the
Software and any permitted successors and assigns; "Developer"
means a Named User of a TIBCO Software product for use only in
Non-Production; "Documentation" means text material that
accompanies the TIBCO Software on delivery; "Enterprise" means an
unlimited Number of Units of the TIBCO Software set forth in an
Ordering Document, deployed by Customer for a period of one (1)
year (unless otherwise set forth in an Ordering Document) from the
Effective Date (the "Enterprise Term"), at which time, the Number of
Units then deployed in Production and Non-Production use by
Customer becomes fixed and Customer may not thereafter deploy
additional Units. During the Enterprise Term, Customer's right to
deploy an unlimited Number of Units does not extend to any entity
which acquires, is acquired by, merged into, or otherwise combined
with Customer. Customer hereby agrees to provide TIBCO, within
sixty (60) days after the end of the Enterprise Term, with written notice
of the Number of Units deployed at the end of the Enterprise Term by
License Type, Platform and Unit; "License Type" means the
environment in which the TIBCO Software may be used (including
without limitation, Production, Non-Production); "Managed Endpoints"
means the number of processors running instances of TIBCO
BusinessWorks™ that are being managed by TIBCO ActiveMatrix™
Policy Manager; "MSU" means Millions of Service Units per hour,
based on the then current MSU rating established by IBM for IBM and
IBM compatible hardware which is used for software pricing (not
TIBCO Adapter for Infranet User’s Guide
254
| TIBCO Software Inc. End User License Agreement
necessarily a direct indication of relative processor capacity) as set
forth in IBM's generally available Large System Performance
Reference; "Named User" means an identifiable individual, not
necessarily named at the time of a license grant, designated by
Customer to access the TIBCO Software, regardless of whether or not
the individual is actively using the TIBCO Software at any given time;
"Non-Production" means a non-operational environment into which
the TIBCO Software may be installed, which is not processing live
data, which is not running any operations of the Customer and which
has not been deployed to permit any users to access live data.
Non-Production environments include development, cold back-up,
high availability, hot standby, and test environments; "Number of Units"
means the cumulative number of copies of TIBCO Software licensed
for use by type of Unit as set forth in this Agreement, or in an Ordering
Document, and including, if applicable, as reported by Licensee upon
expiration of a Project or Enterprise Term; "Ordering Document"
means any purchase order or similar document or agreement
requesting Software, Maintenance or Services; "Platform" means the
operating system set forth in an Ordering Document; "Processor"
means a central processing unit ("CPU") on which the TIBCO
Software is licensed to run and which for the purposes of counting
Processors on multicore chips, the number of Processors is the
number of CPUs times the number of cores multiplied by .75.;
"Processor Source Locked" means the number of connections to a
single database made possible by (or licensed for) the relevant TIBCO
Software regardless of how many Processors are used by the system
or environment which is accessing the database; "Production" means
an operational environment into which the licensed TIBCO Software
has been installed, which is processing live data and which has been
deployed so that the intended users of the environment are able to
access the live data; "Project" means an unlimited Number of Units for
the License Type listed in this Agreement, to be deployed by Customer
solely in connection with the undertaking described under an Ordering
Document for a period of one (1) year (unless otherwise set forth in
this Agreement) from the Effective Date (the "Project Term"), at which
time, the Number of Units then deployed in Production and
Non-Production use by Customer becomes fixed and Customer may
not thereafter deploy additional Units. During the Project Term,
Customer's right to deploy an unlimited Number of Units does not
extend to any entity which acquires, is acquired by, merged into, or
otherwise combined with Customer. Customer hereby agrees to
provide TIBCO, within sixty (60) days after the end of the Project Term,
with written notice of the Number of Units deployed at the end of the
Project Term by Unit and License Type. "Purchase Date" means the
date of the Ordering Document is accepted by TIBCO; "Server
Instance" means a computer with 1 CPUs (unless otherwise specified
in the Agreement) performing common services for multiple other
machines; "Software" means the most current generally available
object code version (as of the Purchase Date) of the software products
listed in an Ordering Document (except as provided for beta or
evaluation licenses), in whole and in part, including its Documentation;
"Third Party Software" means third-party software identified by its
company and/or product name, the provision of which by TIBCO is
made solely as an accommodation and in lieu of Customer purchasing
a license to Third Party Software directly from the third party vendor;
"Trading Partner" means an entity or individual with which the
Licensee engages in electronic commerce by means of TIBCO
Software in accordance with this Agreement; "Unit" means a license
restriction describing the manner in which a copy (or multiple copies)
of the TIBCO Software may be deployed (including, without limitation,
Processor, Named User, Connected Processor, and Processor
Source Locked) and is the mechanism used to determine the Number
of Units licensed pursuant to an Ordering Document.
Special Product Provisions. TIBCO BusinessPartner: Customer
may sublicense to third parties ("Partners") up to the total Number of
Copies of TIBCO BusinessPartner, provided that for every such
TIBCO Adapter for Infranet User’s Guide
sublicense, the Number of Copies Customer is licensed to use shall
be reduced by the same number, and provided further that prior to
delivery of TIBCO BusinessPartner to a Partner, such Partner agrees
in writing (a) to be bound by terms and conditions at least as
protective of TIBCO as the terms of this Agreement, (b) that TIBCO
BusinessPartner be used solely to communicate with Customer's
implementation of TIBCO BusinessConnect, and (c) for such Partner
to direct all technical support and Maintenance questions directly to
Customer. Customer agrees to keep records of the Partners to which it
distributes TIBCO BusinessPartner, and to provide TIBCO the names
thereof (with an address and contact name) within sixty days of the
end of each quarter. Embedded/Bundled Products. Some TIBCO
Software embeds or bundles other TIBCO Software (e.g., TIBCO
InConcert bundles TIBCO Rendezvous). Use of such embedded or
bundled TIBCO Software is solely to enable the functionality of the
TIBCO Software licensed on the Cover Page, and may not be used or
accessed by any other TIBCO Software, or for any other purpose.
Open Source Software: If Customer uses Open Source software in
conjunction with the TIBCO Software, Customer must ensure that its
use does not: (i) create, or purport to create, obligations of use with
respect to the TIBCO Software; or (ii) grant, or purport to grant, to any
third party any rights to or immunities under TIBCO's intellectual
property or proprietary rights in the TIBCO Software. You also may not
combine the TIBCO Software with programs licensed under the GNU
General Public License ("GPL") in any manner that could cause, or
could be interpreted or asserted to cause, the TIBCO Software or any
modifications thereto to become subject to the terms of the GPL.
Version 5.5, April 2007
| 255
Index
A
acronyms xviii
adapter
component (operation) information through TIBCO
Hawk 185
agents 170
alerts 170
API xviii
global variables 128
using 128
H
Hawk methods
getHostInformation() 189
preRegisterListener() 197
C
L
clientvar property 163
COM xviii
command line arguments 186
command line options 169
commands
Connect 66, 68
Conditions when a generic schema is used to publish a
message 85, 96, 108, 117
configuration properties, retrieving through TIBCO
Hawk 186
conventions used in this manual xviii
customer support xx
ledger files
retrieving information through TIBCO Hawk 201
Log File field, adapter 73
Log Info field, adapter 74
Log to Standard field, adapter 73
M
microagent methods supported 176
Multithreading 6
D
N
documents, related xiv
Name 62
G
O
getHostInformation()
Hawk method 189
obfuscation 162
TIBCO Adapter for Infranet User’s Guide
256
| Index
P
password property 163
preRegisterListener()
Hawk method 197
Q
TIBCO Hawk methods
getComponents 185
getConfig 186
getRvConfig 191
getStatus 192
reviewLedger 201
TIBCO Rendezvous, retrieving configuration through
TIBCO Hawk 191
Tracing Levels and Fields 220
typical configuration session 60
QOS xviii
U
R
related documents xiv
Reset button 64
resetConnectionStatistics() 211
reviewLedger, TIBCO Hawk method 201
RV xviii
RVCM xix
RVDQ xix
S
Sample Publication Service Advanced Screen 85, 96,
108, 117
setting global variables 128
Startup Tab 128
substitution 128
support, contacting xx
T
technical support xx
TIBCO Hawk
enterprise monitor components 170
interrogating microagents 173
microagents available 175
TIBCO Adapter for Infranet User’s Guide
Use Advanced Logging field, adapter 72
username property 163
V
variable substitution 128
variables 128
variables, global 128