Tib Adsbl Configuration and Deployment PDF
Tib Adsbl Configuration and Deployment PDF
Tib Adsbl Configuration and Deployment PDF
Siebel
Configuration and Deployment
Software Release 6.1
March 2012
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR
BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY
OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,
OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT
WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS
DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR
CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF
THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR
USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part
of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.
TIBCO, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO
Designer, TIBCO Runtime Agent, TIBCO Hawk, TIBCO Enterprise Message Service, TIBCO Designer Add-in for TIBCO
Business Studio, TIBCO ActiveMatrix Service Grid, TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix
BusinessWorks Service Engine, TIBCO ActiveEnterprise, and TIBCO Business Studio are either registered trademarks or
trademarks of TIBCO Software Inc. in the United States and/or other countries.
EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems,
Inc. in the U.S. and other countries.
All other product and company names and marks mentioned in this document are the property of their respective owners and
are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README 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 1998-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi
TIBCO ActiveMatrix Adapter for Siebel Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi
Third-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii
Terminology and Acronyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvi
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxviii
iv
| Contents
Sending Account Information to an External Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Configuring an Adapter Instance with Publication Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Starting the Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting the Adapter with Adapter Tester . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Starting the Adapter from the Command Line with a Repository File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Sending a Publication Request and Receiving an Account Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
22
22
22
23
Other Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
27
27
29
31
35
40
42
42
45
46
47
Contents v
vi
| Contents
Setting Encoding Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Using the Adapter with a Revision Control System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Adding Customer ErrorCode and ErrorMessage to the Reply of Siebel Request. . . . . . . . . . . . . . . . . . . . . . . . 134
Setting Login Information in an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Adding Customer Attributes to Siebel Header Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Chapter 8 Using the EAI TIBCO HTTP Agent Business Service . . . . . . . . . . . . . . . . . . . . . . . 139
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Publishing Using EAI TIBCO HTTP Agent Business Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
EAI TIBCO HTTP Agent - Interface and Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Query Adapter Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publish Business Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publishing Business Event with Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
143
143
144
147
Chapter 9 Using the EAI TIBCO JMS Agent Business Service . . . . . . . . . . . . . . . . . . . . . . . . 169
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Siebel Side Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Publishing Using EAI TIBCO JMS Agent Business Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
EAI TIBCO JMS Agent - Interface and Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Publish Business Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Publishing Business Event with Reply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
Testing the EAI TIBCO JMS Agent Business Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Testing the Business Service in Siebel 8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Using EAI TIBCO JMS Agent Business Service in Event Script. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Using the EAI TIBCO JMS Agent Business Service in Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Status Codes for EAI TIBCO JMS Agent Business Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Contents vii
viii
| Contents
Unable to Start the Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
The Adapter Hangs When Deployed Using TIBCO Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Unable to invoke the Workflow with the Integration Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Unable to Provide a Literal Match Condition While Querying . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
The Adapter Is Unable to Receive an Event After Reconnection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
299
299
299
299
301
301
301
301
301
303
303
303
303
303
Contents ix
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .331
| Contents
Figures xi
Figures
Figure 1
Figure 2
Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 3
Save Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Figure 4
Figure 5
Figure 6
Publication Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Figure 7
Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 8
Business Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Figure 9
Figure 10
Figure 11
Figure 12
Figure 13
Figure 14
Figure 15
Figure 16
Figure 17
Figure 18
Figure 19
Figure 20
Figure 21
Figure 22
Figure 23
Figure 24
Figure 25
Figure 26
Figure 27
Figure 28
xii
| Figures
Figure 29
Figure 30
Figure 31
Figure 32
Figure 33
Figure 34
Figure 35
Figure 36
Figure 37
Figure 38
Figure 39
Figure 40
Figure 41
Figure 42
Figure 43
Warning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Figure 44
Figure 45
Figure 46
Figure 47
Figure 48
Figure 49
Figure 50
Figure 51
Figure 52
Figure 53
Figure 54
Figure 55
Figure 56
Figure 57
Figure 58
Figure 59
Figure 60
Figures xiii
Figure 61
Figure 62
Figure 63
Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Figure 64
Figure 65
Figure 66
Figure 67
Figure 68
Figure 69
Figure 70
Figure 71
Figure 72
Figure 73
Figure 74
Figure 75
Figure 76
Figure 77
Figure 78
Figure 79
Figure 80
Figure 81
Figure 82
Figure 83
Figure 84
Figure 85
Figure 86
Figure 87
Figure 88
Figure 89
Figure 90
xiv
| Figures
Tables xv
Tables
Table 1
Table 2
Table 3
Configuration Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Table 4
Table 5
Table 6
Table 7
Table 8
General Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 9
Logging Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table 10
Startup Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 11
Monitoring Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 12
Table 13
Table 14
Table 15
Table 16
Table 17
Table 18
Table 19
Table 20
Table 21
Table 22
Table 23
Table 24
Table 25
EAI TIBCO HTTP Agent Publish Business Event with Reply Arguments . . . . . . . . . . . . . . . . . . 147
Table 26
Table 27
Table 28
xvi
| Tables
Table 29
Table 30
Table 31
EAI TIBCO JMS Agent Publish Business Event with Reply Arguments . . . . . . . . . . . . . . . . . . . . 178
Table 32
Table 33
Table 34
Table 35
Table 36
Table 37
Table 38
Table 39
Table 40
Table 41
Table 42
Table 43
Table 44
Table 45
Table 46
Table 47
Table 48
Table 49
Table 50
Table 51
Table 52
Table 53
Table 54
Table 55
Table 56
Table 57
Table 58
Table 59
Table 60
Tables xvii
Table 61
Table 62
Table 63
Table 64
Table 65
Table 66
Table 67
Table 68
Table 69
Table 70
Table 71
Table 72
Table 73
Table 74
Table 75
Table 76
Table 77
xviii Tables
| xix
Preface
TIBCO ActiveMatrix Adapter for Siebel is a bi-directional gateway between the Siebel
application and applications configured for the TIBCO environment. It is assumed that
you are familiar with the basic concepts of the TIBCO environment and Siebel Enterprise
technology.
Topics
xx
Preface xxi
Related Documentation
This section lists documentation resources you may find useful.
TIBCO ActiveMatrix Adapter for Siebel Concepts Read this manual to gain a general
understanding of the adapter that you can apply to the various tasks you may
undertake.
TIBCO ActiveMatrix Adapter for Siebel Installation Read this manual to learn how to
install the adapter on your operating system.
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment Read this
manual for instructions on how to create, configure and deploy adapter projects.
TIBCO ActiveMatrix Adapter for Siebel Examples Read this manual to work through
the examples provided with the adapter.
TIBCO ActiveMatrix Adapter for Siebel Release Notes Read the release notes for a
list of new and changed features. This document also contains lists of known issues
and closed issues for this release.
TIBCO Designer
TIBCO Administrator
TIBCO Rendezvous
TIBCO Hawk
xxii
| Related Documentation
Third-Party Documentation
You may also find it useful to read Siebel Bookshelf, which is available from Siebel
Systems Inc.
Preface xxiii
Typographical Conventions
The following typographical conventions are used in this manual
Table 1 General Typographical Conventions
Convention
Use
ENV_HOME
TIBCO products are installed into an installation environment. A product installed into
an installation environment does not access components in other installation
environments. Incompatible products and multiple instances of the same product must be
installed into different installation environments.
TIBCO_HOME
name of Windows services created by the installer and is a component of the path to
the product shortcut in the Windows Start > All Programs menu.
ADSBL_HOME
code font
Path The folder into which the product is installed. This folder is referenced in
documentation as TIBCO_HOME.
TIBCO ActiveMatrix Adapter for Siebel installs into a directory within a TIBCO_HOME.
This directory is referenced in documentation as ADSBL_HOME. The default value of
ADSBL_HOME depends on the operating system. For example, on Windows systems, the
default value is C:\tibco\adapter\adsbl\version_number.
Code font identifies commands, code examples, filenames, pathnames, and output
displayed in a command window. For example:
Use MyCommand to start the foo process.
In large code samples, to indicate the parts of the sample that are of particular
interest.
In command syntax, to indicate the default parameter for a command. For example,
if no parameter is specified, MyCommand is enabled:
MyCommand [enable | disable]
Use
italic font
Key
combinations
To introduce new terms. For example: A portal page may contain several portlets.
Portlets are mini-applications that run in a portal.
To indicate a variable in a command or code syntax that you must replace. For
example: MyCommand pathname
Key name separated by a plus sign indicate keys pressed simultaneously. For example:
Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after the other.
For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance, for example,
an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to apply the
information provided in the current section to achieve a specific result.
The warning icon indicates the potential for a damaging situation, for example, data loss
or corruption if certain steps are taken or not taken.
Use
[]
A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
Preface xxv
Use
{}
A logical group of items in a command. Other syntax notations may appear within each
logical group.
For example, the following command requires two parameters, which can be either the
pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter can be
either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters. The first
parameter must be param1. You can optionally include param2 as the second parameter. And
the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
Meaning
API
AE
TIBCO ActiveEnterprise
GUI
COM
MVF
MVL
QOS
RPC
RV
RVCM
RVCMQ
W3C
UAN
Inbound
Events coming into the adapter. It refers to the inflow of data into the Siebel
application. It is applicable to Subscription and Request-Response services.
Outbound
Events going out from the adapter. It refers to data being captured from the
Siebel application and being sent out. It is applicable to the Publication
Service.
JMS
VPD
Object Manager
Preface xxvii
Acronym/Terminology
Meaning
Siebel Workflow
HTTP Listener
For an overview of TIBCO Support, and information about getting started with
TIBCO Support, visit this site:
http://www.tibco.com/services/support
If you already have a valid maintenance or support contract, visit this site:
https://support.tibco.com
Entry to this site requires a user name and password. If you do not have a user name,
you can request one.
|1
Chapter 1
This chapter introduces how to create a project, define a business process, and execute the
process in TIBCO ActiveMatrix BusinessWorks.
Topics
| Chapter 1
On Microsoft Windows
From the Start menu, select All Programs > TIBCO > TIBCO Designer n.n >
Designer n.n.
or
From the command line, run TIBCO_HOME\designer\n.n\bin\designer.exe
On UNIX
TIBCO_HOME/designer/n.n/bin/designer.sh
| Chapter 1
Creating a Project
To create a project in TIBCO Designer, follow these steps:
1. Start TIBCO Designer.
2. Click the New Empty Project button in the TIBCO Designer dialog.
Figure 2 Create a Project
3. Select the Multi-File Project tab in the Save Project dialog. Click the Browse button
to save the newly created project in the desired location or type the path in the Project
Directory field.
For example, type D:\project\siebel\ADSBL_DEMO in the Project Directory field, as shown
in Figure 3.
Figure 3 Save Project
| Chapter 1
Creating a Process 7
Creating a Process
After creating the adapter instance with adapter services, you may need to create a process
to deal with workflow.
Make sure you have added services into the adapter instance before configuring a process.
For detailed information about creating and configuring a process, refer to TIBCO
Designer Users Guide.
To create a process, follow these steps:
1. Select your project in the Project panel.
2. Expand the Process palette in the Palettes panel and drag a Process Definition icon
into the Design panel.
3. Double-click the Process Definition button in the Design panel to open the
ActiveEnterprise Adapter Palette under the Project panel.
4. Drag one or more of the following activities into the Process Definition Design panel,
and configure the activities under the Configuration panel:
Publish to Adapter, page 7
Adapter Subscriber, page 8
Adapter Request-Response Server, page 8
Invoke an Adapter Request-Response Service, page 8
Respond to Adapter Request, page 9
For detailed information about configuring the above activities, refer to the TIBCO
ActiveMatrix BusinessWorks documentation.
5. Click the Apply button to save the configuration.
Publish to Adapter
The Publish to Adapter activity publishes a message that can be received by an adapter
subscription service.
Subscription service is configured during the adapter configuration. The Publish to
Adapter activity uses the information configured in the adapter configuration to fill in
most of the required fields.
| Chapter 1
Adapter Subscriber
The Adapter Subscriber activity starts a process based on the receipt of a message from
the publication service of the specified adapter.
Publication service is configured during adapter configuration. The Adapter Subscriber
activity uses the information configured in the adapter configuration to fill in most of the
required fields.
Publication Service is available in TIBCO ActiveMatrix Adapter for Siebel. Refer to
Publication Service on page 55 for detailed information.
Creating a Process 9
10
| Chapter 1
| 11
Chapter 2
Getting Started
This chapter provides a short exercise that shows you how to configure the adapter with a
Publication Service. Details for each step described here are provided later in the manual.
Topics
Overview, page 12
Prerequisites, page 14
12
| Chapter 2
Getting Started
Overview
TIBCO ActiveMatrix Adapter for Siebel is integrated with various components on Siebel,
so there are certain prerequisites that must be met before you can configure basic settings
for the adapter. The prerequisites are listed under section Prerequisites on page 14 and the
configuration steps are listed under section Configuring a Siebel Adapter Instance on
page 15.
The scenario presented in this chapter is a simple one which is intended to demonstrate the
application of the adapter in a Siebel environment. It gives a step-by-step solution using a
sample scenario, where an adapter can be configured using TIBCO Designer.
You should be familiar with dragging and dropping icons and saving projects using
TIBCO Designer. If you are not familiar with these topics, read the documentation for
TIBCO Designer. It can be accessed from the Help > Designer Help menu option within
TIBCO Designer.
14
| Chapter 2
Getting Started
Prerequisites
Before starting the procedure to implement the solution for a scenario, complete the
prerequisites described in this section. See TIBCO ActiveMatrix Adapter for Siebel
Installation for details.
Verify that the repository server is up and running (see the TIBCO Designer Help
menu: Help > Help For > Repository).
Import the Custom Siebel Business Services, EAI TIBCO HTTP Agent and EAI
TIBCO JMS Agent, into your Siebel System using Siebel Tools. See Chapter 8, Using
the EAI TIBCO HTTP Agent Business Service on page 137 and Chapter 9, Using the
EAI TIBCO JMS Agent Business Service on page 165 for details.
You have a Siebel install path and valid credentials (username and password) to access
the Siebel system.
For HTTPS support, you need a valid certificate keystore path, keystore password,
and key password.
On Microsoft Windows
From the Start menu, select All Programs > TIBCO > TIBCO Designer n.n >
Designer n.n.
or
From the command line, run TIBCO_HOME\designer\n.n\bin\designer.exe
On UNIX
TIBCO_HOME/designer/n.n/bin/designer.sh
For detailed information about starting TIBCO Designer, refer to Starting TIBCO
Designer on page 3.
Task B Creating a Project
To create a project in TIBCO Designer, follow these steps:
1. Start TIBCO Designer.
2. Click the New Empty Project button in the TIBCO Designer dialog.
3. Select the Multi-File Project tab in the Save Project dialog. Type
D:\project\siebel\ADSBL_DEMO in the Project Directory field.
4. Click the OK button to open the TIBCO Designer window.
For detailed information about creating a new project, refer to Creating a Project on
page 4.
Task C Configuring a Siebel Adapter Instance
A typical configuration session entails the following steps:
1. In the Project panel, select the ADSBL_DEMO folder.
16
| Chapter 2
Getting Started
2. Expand the Palettes panel, and drag the SiebelAdapterConfiguration icon to the
Design panel.
If the Siebel Adapter palette does not appear in the Palette panel, select Palettes >
Adapters > Siebel Adapter from the menu.
Figure 4 Create a Siebel Adapter Configuration
3. Click the SiebelAdapterConfiguration icon in the Design panel to open the Siebel
Adapter Configuration panel.
4. In the Configuration tab, specify the instance name and click the Apply button. The
default name is SiebelAdapterConfiguration.
5. In the Design-time Connection tab, specify access information for accessing the
Siebel system. Then click the Apply button to save the configuration.
For a successful connection, you must enter valid values in the following mandatory
fields:
Host
Enterprise Server
Object Manager
Username
Password
Make sure that the selected language is consistent with the language used in the server.
6. Click the Connect... button to establish the connection. Once the connection is
established, all fields except for the Use Design-time Connection For Runtime
checkbox will be grayed out.
Figure 5 Design-time Connection Tab
7. Click the Runtime Connection tab to set the runtime connection parameters. For
details on runtime connection parameters refer to Runtime Connection Tab on
page 31.
18
| Chapter 2
Getting Started
4. In the Primary Business Component panel, click the Fetch button beside the Business
Object field to access a list of available Siebel Business Objects. The Business Object
dialog appears.
5. Select the Account item, and click the OK button, as shown in Figure 7.
Figure 7 Business Object
6. Click the Fetch button beside the Business Component field in order to access a list of
available Siebel Business Components. The Business Component dialog appears,
select the Account item and click the OK button, as shown in Figure 8. The adapter
takes some time to fetch the Account information from the Siebel repository.
Figure 8 Business Component
20
| Chapter 2
Getting Started
7. Click the Apply button in the Configuration tab. The design-time connection will
retrieve the list of available Siebel fields that can be used to construct the publication
business event schema. The retrieved fields are populated in the Siebel Fields BusinessComponentName tab.
8. Click the Siebel Fields - BusinessComponentName tab. In the Use column, select the
Name, Location, Industry, and Type fields by checking the appropriate checkbox, as
shown in Figure 9. These fields will be included in the Business Event schema. Click
the Apply button.
Use the Filter Siebel Fields For Selection drop-down list to filter the field displayed in the
Siebel field table, as shwon in Figure 9. For example, select the Show Used item to
display all fields that have been selected, or type A to display all Siebel fields that start
with the letter A.
Figure 9 Siebel Fields-Account Sample Screen
9. Click the
button. The Publication Service configuration tabs are displayed. Click
the Business Event Schema tab to view the Business Event schema generated, as
shown in Figure 10.
10. To save the configuration, select Project > Save from the main menu.
The sample adapter configuration is now ready to publish your account information.
22
| Chapter 2
Getting Started
Starting the Adapter from the Command Line with a Repository File
To start the adapter from the command line with a repository file, the project must be run
as a local repository and saved in DAT (repository) format.
Task A Convert the Project to a Repository File
To export the project to a local repository, complete the following steps:
1. Start TIBCO Designer.
2. Select Project > Export Full Project from the menu. The Export Project dialog
appears.
3. In the Local Repository tab, enter the project name, for example, ADSBL_DEMO,
and the output directory, for example, D:\work\Siebel. Click the OK button.
4. In the Create Project dialog, select File Type and TIBCO Messaging Encoding. Click
the Yes button.
For example:
tibco.repourl D:/work/Siebel/ADSBL_DEMO.dat
tibco.configurl SiebelAdapterConfiguration
24
| Chapter 2
Getting Started
Other Examples
The adapter software includes an examples folder (in the location, ADSBL_HOME\examples)
provided to help familiarize you with adapter functionality and usage. Detailed
information on running the examples can be found in the TIBCO ActiveMatrix Adapter for
Siebel Examples.
| 25
Chapter 3
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 runtime adapter.
Topics
26
| Chapter 3
6. If the Siebel server contains multiple repositories, you need to select the appropriate
Siebel Repository Name. In this step it is critical for you to select the correct Siebel
Data Model Repository to work with. If you are uncertain, please consult your Siebel
Administrator.
The Siebel Repository select pop-up dialog appears only if there is more than one Siebel
Repository available.
Siebels data model repository is often customized. There might be different
repository names in the system. Make sure the correct one is selected.
Once the design-time connection is established, you are ready to configure the adapter
services.
Multithreading, page 40
Configuration Tab
Figure 11 shows a sample screen of the Configuration tab with the default values.
Figure 11 Sample Screen of the Configuration Tab
28
| Chapter 3
Description
Instance Name
The name of the adapter instance. Use the default name or replace it with a name of your
choice. See Guidelines for Choosing an Instance Name on page 28 for more information.
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.x, the
version string is set to AE Version 5.3.
To change versions, click the Change Version... button.
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 TIBCO Adapter SDK Programmers Guide for information
about writing a message filter.
Check this checkbox to display additional tabs for configuring advanced options.
An instance name must use alphanumeric characters. An underscore (_) character can
be used. The entire instance name must be less than 80 characters. The space character
cannot be used in an instance name.
An instance name must be unique with respect to other adapter instances belonging to
the same adapter in the same project. The same instance name can be used to name an
adapter instance for a different adapter in the same project. For example, an R/3
adapter instance named TEST and a Siebel adapter instance named TEST can coexist in
the same project.
Each instance name must be unique for each adapter within a project even if each
instance is defined in a different folder. That is, configuring same-named adapter
instances in different folders will not make their names unique.
When you create an adapter instance, the palette automatically creates several resources
for it. The names of these resources are derived from the name of the instance they belong
to. Changing the adapter instance name results in an automatic regeneration of the
resources names. If you manually modify any resource name, that particular name will not
be automatically regenerated the next time your rename the adapter instance.
Description
Host
The name of the machine on which the Siebel server is installed along
with the Connection Broker. If the Connection Broker is running on a
non-default (2321) port, then the parameter, Host should have a value
following the hostname:Port format. For example: mySiebelserverHost:7666.
Enterprise Server
30
| Chapter 3
Description
Siebel Server
The Siebel Server to connect to. Specify this field for Siebel 7.7.x, and
leave it blank for Siebel 7.8.x and above.
Object Manager
The name of the Application Object Manager that you want to access.
This can be a user-defined component or one of the predefined
components, SCCObjMgr_enu, SSEObjMgr, ISSObjMgr, SSVObjMgr. (For more
information, see Siebel Server Administration Guide).
Language
Transport
Compression
Username
Specify the username for the account used by the design-time connection
to access the application. Sample value: sadmin.
Password
Specify the password for the account used by the design-time connection
to access the application. Sample value: sadmin.
Remember Password
If this field is not selected, the password must be entered each time the
project is opened. If it is selected, the password will be stored in the
project repository.
32
| Chapter 3
Description
Host
The name of the machine on which the Siebel server is installed along
with the Connection Broker. If the Connection Broker is running on a
non-default (2321) port, then the parameter, Host should have a value
following the hostname:Port format. For example: mySiebelserverHost:7666.
Enterprise Server
Siebel Server
The Siebel Server to connect to. Specify this field for Siebel 7.7.x, and
leave it blank for Siebel 7.8.x and above.
Object Manager
The name of the Application Object Manager that you want to access.
This can be a user-defined component or one of the predefined
components, SCCObjMgr_enu, SSEObjMgr, ISSObjMgr, or SSVObjMgr. (For more
information, see Siebel Server Administration Guide).
Language
Transport
Compression
Username
Specify the username for the account used by the design-time connection
to access the application. Sample value: sadmin.
Password
Specify the password for the account used by the design-time connection
to access the application. Sample value: sadmin.
Remember Password
If this field is not selected, the password must be entered each time the
project is opened. If it is selected, the password will be stored in the
project repository.
Description
Trace File
If you have checked the Enable Siebel Trace checkbox, specify the file to
be logged in this field. The Trace File is generated on the Siebel server.
Trace Type
If you have checked the Enable Siebel Trace checkbox, specify the type
of Siebel tracing to be used. Currently, only SQL is available.
When Any Service Is Suspended this stops the adapter if any single service has
been unable to re-establish connection after the specified number reconnection
attempts.
When All Services Are Suspended this stops the adapter only when all services
have been suspended. That is, only the adapter service that cannot reconnect is
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment
34
| Chapter 3
stopped. Other adapter services that are connected continue to function normally.
If you do not find the encoding used by Siebel Deployment in the list provided by the
TIBCO Designer palette, find the Java Alias of that encoding and enter it in the list from
TIBCO Designer.
Figure 15 shows a sample screen of the Adapter Services tab with default values when the
Use SSL checkbox is checked.
Figure 15 Sample Screen of the Adapter Services Tab (Use SSL)
Description
Use SSL
36
| Chapter 3
Description
Number of Connections to
Siebel
Number of Threads
The number of the port on which the adapter will listen for outbound
requests. The port number can range from 5000 to 65000.
Note: The Http Port to Listen to Siebel Events and Number of Threads to
Process Siebel Events tabs are not valid for 4.x configuration.
Http Encoding
Specify the language encoding being used by the Siebel deployment. This
parameter will be used by the adapter in outbound scenarios only. The
default value is UTF8. The adapter uses this value for processing the HTTP
requests from the Siebel application.
Note: Values in the Encoding Value column are the ones stored in the
repository, as shown in Table 7.
The number of the port on which the adapter will listen for outbound
requests. The port number can range from 5000 to 65000. By default, the
port number is 9100.
Description
Https Encoding
Specify the language encoding being used by the Siebel deployment. This
parameter will be used by the adapter in outbound scenarios only. The
default value is UTF8. The adapter uses this value for processing the HTTP
requests from the Siebel application.
The encoding options for HTTP and HTTPS are the same. Refer to
Table 7 for more details.
Note: When you start your client, if you have generated the Certificate
Path using the Keytool utility, you can install the Certificate on the client by
accessing https://host_name:HTTPS_Port_Number.
Certificate Path
Specify the path of the Keystore where the certificate is available. You
can use the keytool utility to create a certificate.
Note: A Certificate can be generated using the Keytool utility. The
following command is used to create a certificate:
keytool -genkey -keystore KeyStore_Name -keyalg rsa -alias Alias_Name -storepass
KeyStore_Password -keypass Key_Password
Where:
KeyStore_Name: The name of the keystore where the Certificate will be
generated.
Alias_Name: The alias name given to a public and private key pair in the
Keystore.
KeyStore_Password: The password to access the Keystore.
Key_Password: The password to access the alias.
While generating a Certificate, the first name and the last name should be
the IP address of the machine on which the Siebel adapter is running.
Key Password
Specify the password to access a public and private key pair in a keystore.
Keystore Password
38
| Chapter 3
Language
Encoding Value
Big5
Chinese (Traditional)
Big5
Cp936
Chinese (Simplified)
CP936
GBK
Chinese (Simplified)
GBK
IBM-1148
CP1148
KSC-5601
Korean
KSC5601
SHIFT_JIS (CP943)
Japanese
CP943
SHIFT_JIS (TIBCO)
Japanese
SHIFT_JIS
Windows Arabic
Arabic
CP1256
Windows Cyrillic
Russian
CP1251
Windows Greek
Greek
CP1253
Windows Hebrew
Hebrew
CP1255
Windows Latin-1
Latin - 1
CP1252
Windows Latin-2
Latin - 2
CP1250
Windows Turkish
Turkish
CP1254
UTF16_BigEndian
Any
UniCodeBig
UTF16_LittleEndian
Any
UniCodeLittle
UTF8
Any
UTF-8
ZHT16MSWIN950
Chinese (Traditional)
CP950
General Tab
The General Tab is visible only when the Show All Tabs checkbox is checked in the
Configuration tab.
Figure 16 shows a sample screen of the General tab with default values.
Figure 16 Sample Screen of the General Tab
Description
Use this field to provide the User Exit JAR file for the 5.x adapter
configuration.
Note: The User Exit feature is now deprecated.
Check this checkbox to generate the scripts for running the adapter.
40
| Chapter 3
Multithreading
You can specify the thread count for each session in the adapter instance.
Figure 17 shows a sample screen of the Multithreading tab with default values.
Figure 17 Sample Screen of the Multithreading Tab
You can drag global variables to the Multithreading parameters. When working with
global variables:
1. Click the No. Of Threads column where the global variable needs to be added.
2. Click the global variables, then drag them to the Multithreading parameters.
3. Values held by the global variables are numeric.
Logging Tab
Figure 18 shows a sample screen of the Logging tab with default values.
Figure 18 Sample Screen of the Logging Tab
Description
If the checkbox is not checked (by default), you can set two standard output
destinations (sinks) for trace messages and set the tracing level for the roles
selected.
If the checkbox is checked, you have complete control on selecting the
destinations and associating desired roles with each of the destinations.
To create and configure sinks, refer to Guideline for Creating and Configuring the
Sinks on page 42.
(STDIO Sink) If the checkbox is checked, trace messages are displayed in the
command prompt window where the adapter is started. If the checkbox is not
checked, 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. Refer to Using
Global Variables on page 124 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.
The messages 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.
Trace messages of the selected level 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 message, 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.
42
| Chapter 3
For the File sink, the file limit, file count, and the option to append or overwrite can be
specified. When created by default, this sink is set to 30000 bytes, 3, and append mode
respectively.
For the STDIO sink, the option to write to stdout or stderr can be selected. When created
by default, stdout 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, refer to Using Global Variables on page 124. The
configuration for the Hawk sink involves specifying the MicroAgent Name that must be
specified in the configuration panel.
The Network sink is used to publish tracing messages on TIBCO Rendezvous. The
configuration for the network sink involves specifying the session and the subject on
which the trace messages needs to be published.
Startup Tab
Figure 19 shows a sample screen of the Startup tab with default values.
Figure 19 Sample Screen of the Startup Tab
Description
Show Startup
Banner
If the checkbox is checked (by default), the startup banner displays the runtime adapter
version, the infrastructure version on which the adapter is built, and copyright information
in the console window when the adapter is started.
The content of the start banner is predefined and cannot be changed.
Metadata Search
URL
Specifies the location where the adapter searches for base schemas. The adapter searches
for any schema that has been defined and saved at this location, and that should be loaded
at startup.
This field is predefined and cannot be changed.
44
| Chapter 3
Monitoring Tab
Figure 20 shows a sample screen of the Monitoring tab with default values.
Figure 20 Sample Screen of the Monitoring Tab
Description
Enable Standard
Microagent
Standard
Microagent
Name
The name for the standard microagent that will be registered with the TIBCO Hawk
system.
Standard
MicroAgent
Timout (ms)
Enable Class
Microagent
Allows you to turn the instance- or class-specific standard TIBCO Hawk Microagent on or
off.
In most cases the default value is used. The InstanceId variable need not be set because it is
automatically set at run time by the runtime adapter.
Click the
button, to switch the way of configuration between a standard checkbox and
text value (true or false).
Description
Class
Microagent
Name
The name for the class microagent that will be registered with the TIBCO Hawk system.
Class
MicroAgent
Timeout (ms)
Default
Microagent
Session
Specify the name of the TIBCO Rendezvous session that will be used by the standard,
class, and custom microagents.
The session name and the corresponding session are automatically generated by TIBCO
Designer. Do not change the session name or the session. However, you can modify the
session parameters if required. Navigate to the Sessions folder under the Advanced folder
to modify the session parameters.
Make sure you have set the correct parameter value for the global variables that
correspond to the TIBCO Hawk configuration. If the session parameters are not set
properly, the microagents will not display in TIBCO Hawk Display.
For a list of all supported microagents, refer to Chapter 10, Monitoring the Adapter Using
TIBCO Hawk on page 183.
46
| Chapter 3
Description
UseJMSIntegration
Check this checkbox to use EAI TIBCO JMS Agent for the exchange of data
between Siebel and other external systems using the adapter.
When this checkbox is checked, a session named JmsIntegrationDefaultSession will be
created. Navigate to its configuration panel. Enter values in the Provider URL
and Provider Context Factory fields, as shown in Figure 22.
queueListenFromSiebel
queueReplyToSiebel
Figure 22 shows a sample screen of the JMS Integration Default Session configuration.
Figure 22 JMS Integration Default Session
48
| Chapter 3
50
| Chapter 3
| 51
Chapter 4
This chapter explains how to create and configure adapter services for an adapter instance.
All configuration tasks are performed in TIBCO Designer.
Topics
52
| Chapter 4
Subscription Service
The adapter inserts or updates Siebel Business Components or Integration Components, or
invokes the Siebel Workflow or Business Service when it receives a message on a subject.
The adapter supports subscription of:
Request-Response Service
The adapter allows an external application to:
When you choose to send and receive Integration Objects, the response is always an
Integration Object. However, when you choose other options on the list, such as Query
Siebel Business Components, the response will be in the schema selected by you in the
data section of the Advisory Document.
Details on how to configure each type of adapter service is discussed in the following
sections.
54
| Chapter 4
Publication Service 55
Publication Service
The adapter queries the Siebel Business Component or Siebel Integration Component data
objects from the Siebel System through the Siebel Object Interface and publishes the data
on the specified subject with the desired quality of service.
The Publication Service requires the custom Business Service, EAI TIBCO HTTP Agent
or EAI TIBCO JMS Agent, to be imported into Siebel to forward the publication request
from Siebel to the adapter.
The following sections show the Publication Service configuration options and the task
sequence:
Configuration Options
After you drag the Publication Service icon from the Palettes panel to the Design panel,
the Configuration tab appears. Select one of the following publication types from the
Publication Type drop-down list:
After selecting a publication type, another panel appears and presents additional
configuration options. See Chapter 5, Configuration Options on page 83 for details.
The following sections describe the general options available in the Publication Service
Configuration panel:
56
| Chapter 4
Configuration Tab
The Configuration tab contains the following fields.
Table 13 Publication Service Configuration - Configuration Tab (Sheet 1 of 2)
Field
Description
Name
Specify a unique name among all services defined for this adapter instance.
Business Event
Transport Type
JMS
Connection Factory
Type
Available only for the JMS transport. It can be Topic or Queue. Refer to Connection
Factory Type on page 80 for details.
Delivery Mode
Available only for the JMS transport. It can be Persistent or Non-Persistent. See
Delivery Mode on page 80 for details.
Wire Format
Services must use the same wire format to exchange data. It is XML Message. Refer
to Wire Format on page 79 for details.
Publication Service 57
Description
Rendezvous
Quality of Service
Available only for the Rendezvous transport. It can be Certified or Reliable. Refer to
Quality of Service on page 79 for details.
Wire Format
Services must use the same wire format to exchange data. It can be XML Message or
ActiveEnterprise Message. Refer to Wire Format on page 79 for details.
If you select this field, the reply schema will be in XML format.
If you select this field, the reply schema will be in XML format.
Request Integration
Object Name
Request Schema
Reference
Select a Siebel adapter schema for integration objects from the repository.
Publish as XML
Default NameSpace
Specify the default namespace for the published XML string in this field.
58
| Chapter 4
Description
Message Subject
Destination
Publication Service 59
Description
Endpoint Reference
Class Reference
The schema class reference points to the class created for this component.
Click the Browse Resources... button to change the class reference.
Click the Go To Referenced Resource... button to reconfigure the existing reference.
Click the Clear Reference button to clear the field.
Class reference objects are explained in TIBCO Designer Schema Management
Guide. You can access help by selecting Help > Help For > Adapter Schemas from
the menu.
60
| Chapter 4
You need to configure the custom Business Service parameters for sending the publication
request from the Siebel application to the adapter. Refer to Using the EAI TIBCO HTTP
Agent Business Service on page 137 for more information.
Subscription Service 61
Subscription Service
The adapter inserts, updates, and deletes Siebel Business Component data objects in the
Siebel system through the Siebel object interface. The adapter does this when an incoming
message is received on a specified subject name and the subscription type is set to insert,
update, or delete Business Components. An incoming message need not contain data for
all selected Siebel fields defined in each level of the Business Event schema. The adapter
checks the repository for attributes defined in the Business Event schema. If the incoming
message does not contain data for a specifically defined field in the Business Event
schema, the adapter will ignore it and Siebel will assign the appropriate default, if
applicable. For example, the ID field is typically generated by the Siebel system on
insertion and then used in inserting or updating the child Business Components.
The adapter invokes a Siebel Workflow through the Siebel Workflow Process Manager
when an incoming Business Event message is received on the specified subject and the
subscription type is set to invoke Siebel Workflow. Refer to Configuring an Adapter
Service to Invoke Siebel Workflow on page 99 for details on how to configure a
Subscription Service to invoke Siebel Workflow and convert external TIBCO Rendezvous
messages into a Siebel Property Set. (The Siebel Property Set is the input property for the
Siebel Workflow).
The following sections show the Subscription Service configuration options and the task
sequence:
Configuration Options
After you drag the Subscription Service icon from the Palettes panel to the Design panel,
the Configuration tab appears. Select one of the following subscription types from the
Subscription Type drop-down list:
After selecting a subscription type, another panel appears and presents additional
configuration options. See Chapter 5, Configuration Options on page 83 for details.
The following sections describe the general options available in the Subscription Service
Configuration panel:
62
| Chapter 4
Configuration Tab
The Configuration tab contains the following fields.
Table 15 Subscription Service Configuration - Configuration Tab (Sheet 1 of 3)
Field
Description
Name
Specify a unique name among all services defined for this adapter instance.
Business Event
Transport Type
JMS
Connection Factory
Type
Available only for the JMS transport. It can be Topic or Queue. Refer to Connection
Factory Type on page 80 for details.
Delivery Mode
Available only for the JMS transport. It can be Persistent or Non-Persistent. See
Delivery Mode on page 80 for details.
Subscription Service 63
Description
Wire Format
Services must use the same wire format to exchange data. It is XML Message. Refer
to Wire Format on page 79 for details.
Rendezvous
Quality of Service
Available only for the Rendezvous transport. It can be Certified or Reliable. Reform
to Quality of Service on page 79 for details.
Wire Format
Services must use the same wire format to exchange data. It can be XML Message or
ActiveEnterprise Message. Refer to Wire Format on page 79 for details.
Select the type of operation to be performed on Siebel data. The operation types
available are:
Insert or Update Inserts a record if the record does not exist, and updates a record
if one exists.
Insert Inserts a new record.
Update Updates the existing record in the Siebel database.
Delete Deletes an existing record from Siebel database.
If you select this field, the reply schema will be in XML format.
Workflow Process
Server Request
When checked, the workflow process runs in the Siebel Server process space. If it is
unselected, it runs within the Object Manager process space. By default this option is
unchecked.
Asynchronous
Workflow Request
Check this checkbox if you want to invoke the workflow asynchronously. If you
check this checkbox, the adapter will not wait for the reply from the Siebel workflow.
The adapter will reply with the Asynchronous Workflow Request ID.
Integration Object
Select the Yes item from this drop-down list if the Siebel workflow is using an
integration object.
64
| Chapter 4
Description
Integration Object
Name
Refer to Configuring an Adapter Service to Invoke Siebel Workflow on page 99 for details.
Siebel Integration Components
UAN Schema
Support
If you select this field, the reply schema will be in XML format.
Operation Type
Select the type of operation to be performed on Siebel data. The operation types
available are:
Insert or Update Inserts a record if the record does not exist, and updates the
record if one exists.
Delete Deletes an existing record from Siebel database.
If you select this field, the reply schema will be in XML format.
Business Service
The name of the Business Service. Click the Fetch button to select Business Services
from the Siebel repository.
Method Name
Integration Object
Name
Request Schema
Reference
Select a Siebel adapter schema for integration objects from the repository.
Refer to Configuring Adapter Services for Siebel Universal Application Network on page 103 for details.
Business Event Schema Tab
For the Querying Siebel Business Component request type, refer to Business Event
Schema Options on page 89.
For the Querying Siebel Integration Component request type, refer to Business Event
Schema Tab on page 102.
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment
Subscription Service 65
For Sending and Receiving Integration Objects, refer to Configuring Adapter Services for
Siebel Universal Application Network on page 103.
The Business Event Schema tab is available only for a subscriber where Siebel Business
Component, Siebel Workflow, or Siebel Integration Components are configured.
Information in the Advanced tab becomes available after you complete and apply the
requested information in the Configuration tab.
Advanced Tab
Refer to Table 14 in Advanced Tab on page 58 for details.
66
| Chapter 4
Request-Response Service
When running as a Request-Response Service or server, the adapter allows a TIBCO
Rendezvous or TIBCO JMS application to query, insert, update, or delete Siebel Business
or Integration Component data, or to invoke a Siebel Workflow process. In the case of a
Request-Response Service querying Siebel Business Components, the adapter returns one
or more results, and upon completion, it sends a result code to the requesting application.
In the case of a Request-Response Service inserting or updating a Siebel Business
Component, the adapter returns an advisory document and a result code to the requesting
application upon completion. Refer to Appendix B, Troubleshooting on page 267 for
details on the operations supported by the Request-Response Service. See Configuring an
Adapter Service to Invoke Siebel Workflow on page 99 for details on requests to invoke a
Siebel Workflow.
The following sections show the Request-Response Service configuration options and the
task sequence:
Configuration Options
After you drag the Request-Response Service icon from the Palettes panel to the Design
panel, the Configuration tab appears. Select one of the following request-response types
from the Request-Response Server Type drop-down list:
After selecting a request-response server type, another panel appears and presents
additional configuration options. See Chapter 5, Configuration Options on page 83 for
details.
Request-Response Service 67
The following sections describe the general options available in the Request-Response
Service Configuration panel:
Configuration Tab
The Configuration tab contains the following fields.
Table 16 Request-Response Service Configuration - Configuration Tab (Sheet 1 of 4)
Field
Description
Name
Specify a unique name among all services defined for this adapter instance.
Business Event
Transport Type
68
| Chapter 4
Description
JMS
Connection Factory
Type
Available only for the JMS transport. It can be Topic or Queue. Refer to Connection
Factory Type on page 80 for details.
Delivery Mode
Available only for the JMS transport. It can be Persistent or Non-Persistent. See
Delivery Mode on page 80 for details.
Wire Format
Services must use the same wire format to exchange data. It is XML Message. Refer
to Wire Format on page 79 for details.
Rendezvous
Quality of Service
Available only for the Rendezvous transport. It can be Certified or Reliable. Reform
to Quality of Service on page 79 for details.
Wire Format
Services must use the same wire format to exchange data. It can be XML Message or
ActiveEnterprise Message. Refer to Wire Format on page 79 for details.
Select the type of operation to be performed on Siebel data. The operation types
available are:
Insert or Update Inserts a record if the record does not exist, and updates a record if
one exists.
Insert Inserts a new record.
Update Updates the existing record in the Siebel database.
Delete Deletes an existing record from Siebel database.
Request-Response Service 69
Description
If you select this field, the reply schema will be in XML format.
Workflow Process
The workflow process that is to be invoked when the adapter receives a message for a
Business Event. Click the Fetch button to select a workflow process.
Server Request
When checked, the workflow process runs in the Siebel Server process space. If it is
unselected, it runs within the Object Manager process space. By default this option is
unchecked.
Asynchronous
Workflow Request
Check the checkbox if you want to invoke the workflow asynchronously. If you
check this checkbox, the adapter will not wait for the reply from the Siebel workflow.
The adapter will reply with the Asynchronous Workflow Request ID.
Integration Object
Select the Yes item from this drop-down list if the Siebel workflow is using an
integration object.
Integration Object
Name
Refer to Configuring an Adapter Service to Invoke Siebel Workflow on page 99 for details.
Query Siebel Integration Components
UAN Schema
Support
If you select this field, the reply schema will be in XML format.
If you select this field, the reply schema will be in XML format.
Operation Type
Select the type of operation to be performed on Siebel data. The operation types
available are:
Insert or Update Inserts a record if the record does not exist, and updates a record
if one exists.
Delete Deletes an existing record from Siebel database.
70
| Chapter 4
Description
If you select this field, the reply schema will be in XML format.
Business Service
The name of the Business Service. Click the Fetch button to select Business Services
from the Siebel repository.
Method Name
Integration Object
Name
Reply Schema
Reference
Select a schema from the drop-down list. This is the schema that will be used by the
reply data.
Request Schema
Reference
Select a Siebel adapter schema for integration objects from any location in the
repository.
Refer to Configuring Adapter Services for Siebel Universal Application Network on page 103 for details.
Business Event Schema Tab
For the Querying Siebel Business Component request type or for the Insert or Update
Siebel Business Component request types, refer to Business Event Schema Options on
page 89.
For the Siebel Workflow Invocation request type, refer to Configuring an Adapter Service
to Invoke Siebel Workflow on page 99.
For the Querying Siebel Integration Component request type or for the Insert or Update
Siebel Integration Component request type, refer to Business Event Schema Tab on
page 102.
For Invoking Business Service, refer to Configuring Adapter Services for Siebel Universal
Application Network on page 103.
Advanced Tab
Refer to Table 14 in Advanced Tab on page 58 for details.
Request-Response Service 71
72
| Chapter 4
Configuration Options
After you drag the Request-Response Invocation Service icon from the Palettes panel to
the Design panel, the Configuration tab appears. Select one of the following
Request-Response Invocation types from the Request-Response Invocation Type
drop-down list:
After selecting a Request-Response Invocation type, another panel appears and presents
additional configuration options. See Chapter 5, Configuration Options on page 83 for
details.
The following sections describe the general options available in the Request-Response
Invocation Service Configuration panel:
Configuration Tab
The Configuration tab contains the following fields.
Table 17 Request-Response Invocation Service Configuration - Configuration Tab (Sheet 1 of 4)
Field
Description
Name
Specify a unique name among all services defined for this adapter instance.
74
| Chapter 4
Description
Business Event
Transport Type
JMS
Connection Factory
Type
Available only for the JMS transport. It can be Topic or Queue. Refer to Connection
Factory Type on page 80 for details.
Delivery Mode
Available only for the JMS transport. It can be Persistent or Non-Persistent. See
Delivery Mode on page 80 for details.
Wire Format
Services must use the same wire format to exchange data. It is XML Message. Refer
to Wire Format on page 79 for details.
Rendezvous
Quality of Service
Available only for the Rendezvous transport. It can be Certified or Reliable. Refer to
Quality of Service on page 79 for details.
Wire Format
Services must use the same wire format to exchange data. It can be XML Message or
ActiveEnterprise Message. Refer to Wire Format on page 79 for details.
Select the Yes item if the reply contains an Integration Object schema.
If you select the Yes item, the schema in the data section of the Advisory document
should match the schema of the Integration Object.
If you select the No item, the reply will either be in XML or AE format, depending on
the UAN schema Support field. If you selected UAN schema Support, the reply will
be in XML format. Otherwise, it will be in AE format.
Integration Object
Name
Description
Select the Yes item if the reply contains an Integration Object schema.
If you select the Yes item, the schema in the data section of the Advisory document
should match the schema of the Integration Object.
If you select the No item, the reply will either be in XML or AE format, depending on
the UAN schema Support field. If you selected UAN schema Support, the reply will
be in XML format. Otherwise, it will be in AE format.
Integration Object
Name
If you select this field, the reply schema will be in XML format.
Integration Object
Select the Yes item if the reply contains an Integration Object schema.
If you select the Yes item, the schema in the data section of the Advisory document
should match the schema of the Integration Object.
If you select the No item, the reply will either be in XML or AE format, depending on
the UAN schema Support field. If you selected UAN schema Support, the reply will
be in XML format. Otherwise, it will be in AE format.
Integration Object
Name
If you select this field, the reply schema will be in XML format.
Request Integration
Object Name
The name of the integration object to be used. This field appears only for the
SendReceive Integration Objects configuration.
Reply Integration
Object Name
The name of the integration object, which is returned as part of the reply schema.
76
| Chapter 4
Description
Request Schema
Reference
Select a schema from the drop-down list. This is the schema that will be used by the
reply data.
Publish as XML
Default NameSpace
Specify the default namespace for the published XML string in this field.
Refer to Configuring Adapter Services for Siebel Universal Application Network on page 103 for details.
The Integration Object and Integration Object Name fields appear only when the reply
contains a integration object schema.
Business Event Schema Tab
For the Querying Siebel Business Component request type, refer to Business Event
Schema Options on page 89.
For the Querying Siebel Integration Component request type, refer to Business Event
Schema Tab on page 102.
For Sending and Receiving Integration Objects, refer to Configuring Adapter Services for
Siebel Universal Application Network on page 103.
For Send Receive Integration Object, SiebelHeader options can be used for customized
reply message. It contains KeyName and KeyValue fields. For KeyName, it will work as
the attribute name of an XML message to reply. You should use the XML attribute name
format to define a KeyName string in which Special characters is not allowed.
Advanced Tab
Refer to Table 14 in Advanced Tab on page 58 for details.
78
| Chapter 4
The transport type (Rendezvous or JMS) you select for the runtime adapter determines
transport-specific service options. Only options that are compatible with a services
transport type will be available in the Configuration Panel.
Transport Type
There are two transport types available for the runtime adapter, namely JMS and
Rendezvous. After selecting the transport type, you can configure the transport-specific
options. Only options that are compatible with the services transport type appear in the
Configuration Panel.
The JMS transport type is supported for TIBCO ActiveMatrix Adapter for Siebel version
5.x or above.
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 that uses a dialog to perform SSL configuration.
To enable and configure SSL:
1. In the Project panel, select the adapter instance.
2. Expand the Advanced > Sessions folder, and then select the TIBCO Rendezvous
session or JMS session.
3. Check the Use SSL? checkbox in the Configuration panel.
4. Click the Configure SSL... button to do further configuration.
The SSL configuration options are explained in the online help associated with the session
dialog.
Quality of Service
If you have selected Rendezvous as the transport type, then select Quality of Service.
Certified
Certified Message Delivery guarantees that every certified message reaches its intended
recipient in the order sent. A 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 guaranteed delivery. When this quality of service is
chosen, an RVCM session will be used.
Reliable
Reliable Message Delivery ensures that each multicast or broadcast message is received as
long as the physical network and packet recipients are working. It also ensures that the
loss of a message is detected.
Reliable Message Delivery can compensate for brief network failures because it can
retransmit a message on request if the first attempt fails. This option is appropriate when
message delivery is expected but some loss can be tolerated. When this quality of service
is chosen, an RV session will be used.
Distributed Queue
Distributed Queue delivers a message to one-of-many service listeners (workers). It
contains features of both Certified Messaging and Fault Tolerance.
The Distributed Queue option is only available for the Subscription Service and the
Request-Response Service.
Wire Format
ActiveEnterprise Message
ActiveEnterprise Message (default) is an externally described XML message format
supported by the TIBCO Adapter SDK.
XML Message
XML Message allows you to retrieve data as XML documents and metadata as XML
Schemas (XSD).
80
| Chapter 4
Rendezvous Message
Rendezvous Message is a self-describing message format used by TIBCO Rendezvous
applications.
The wire format for both publisher and subscriber must be the same.
Delivery Mode
For JMS transport, there are two groups of delivery modes.
Publication Service and Request-Response Invocation Service
For the Publication Service and the Request-Response Invocation Service, the following
delivery modes are supported:
Persistent indicates that the message will be available to a JMS client even if the JMS
server goes down.
Non-persistent indicates that the message will not be available to a JMS client if the
JMS server goes down.
See TIBCO Enterprise Message Service Users Guide for more information.
Durable indicates that the service is registered with the JMS server. The JMS server
holds messages sent to a durable Subscription Service until they are consumed by the
service. The service may be down and expect to receive its messages when it starts
working.
Non-durable indicates that the service is not registered with the JMS server. The JMS
server does not hold messages sent to a non-durable Subscription Service. If the
service is down, it will not receive the messages that arrived at the JMS server while
the service was down.
See TIBCO Enterprise Message Service Users Guide for more information about the
semantics for this field.
82
| Chapter 4
| 83
Chapter 5
Configuration Options
Topics
Configuring Adapter Services for Siebel Universal Application Network, page 103
84
| Chapter 5
Configuration Options
86
| Chapter 5
Configuration Options
4. Select the fields to be included in the Business Event schema using columns in the
Siebel Fields tab. Refer to Siebel Fields Tab on page 88 for details.
Figure 30 shows the Business Component hierarchy in the Project panel, where the
secondary Business Component of a Publication Service is using Account as the primary
Business Component and Contact as the secondary component.
Figure 30 Secondary Business Component
88
| Chapter 5
Configuration Options
Business Object Enter the Business Object or click the Fetch button to select the
name of the Business Object.
Business Component Enter the name of the Business Component or click Fetch to
select the name of the Component for the Business Object specified above.
Use When selected, the Siebel field is to be included in the Business Event schema
for the parent adapter service.
Read Only The Siebel field is designated as a Read Only in the Siebel repository.
Read Only fields cannot be subscribed.
Required The Siebel field is designated as a Required field in the Siebel repository.
Calculated The Siebel field is computed based on other Siebel fields. A calculated
field cannot be subscribed.
MVL Field Name of the Siebel Multi Value Link for the field in the above Multi
Value Group. A Multi Value field cannot be subscribed. To subscribe to a MVL field,
a child MVL Business Component is required.
Pick List Name of the Pick List if the field is controlled by a Siebel Pick List
component.
Hidden This is selected if the Siebel field is designated as a Hidden field in the
Siebel repository.
Inactive This is selected if the Siebel field is inactive in the Siebel repository.
Inactive fields are unavailable for users. Users cannot change the configuration.
Use the drop-down list at the right top corner to filter the display list, using Show Required
Only or Show Read Only parameters to select the fields. For example, selecting Show Used
Only in the drop-down list will filter the list to show only fields that had been selected.
You can also enter a search expression to filter the Siebel Field list. For example, entering
A in the drop-down list will filter the list to show only fields that start with A.
MVL Configuration Tab
Multi Value Link Enter the name of the MVL or click Fetch to select the name of
the MVL.
You can enter an expression before clicking Fetch to filter the list of Siebel Business
Objects returned. For example, entering A in the Business Object field retrieves all
available Siebel Business Objects that start with A.
90
| Chapter 5
Configuration Options
Key Check the checkbox next to a Siebel Business Component or field to define it
as a user key. All fields that you select as user keys combine to uniquely define a
Siebel record for a Business Component.
For example, the Account Name and Location in the above example are selected as
user keys to uniquely define an Account in the Siebel system. The Contact Last Name
and First Name are selected as user keys to uniquely define a Contact in the Siebel
system. For the receiver of the published message, the selection of key fields provides
a guideline on which fields are to be used to represent a unique record in the Siebel
system.
Match Field The name of the parent Business Component field. This parent name
defines the parent of the parent-child relationship for all its secondary Business
Components. The value you specify in the Match Field column, for a primary
Business Component, is used as the default search criteria to retrieve a Business Event
for publication. Only one is allowed. Typically, the Match Field for the primary
Business Component is the ID field and is used in the Key parameter of the Agent
Send method.
In the case of secondary Business Components, it establishes the relationship with the
parent Business Component to allow the adapter to retrieve a subset of the Siebel
records related to the parent for publication. In the above example, the match field for
the Account ID field of Contact is set to match the value for the ID field of the parent
Account to retrieve the list of contacts related to the Account. It is possible to select
multiple match fields when one source or destination field pair is inadequate to define
the parent-child relationship. By selecting literal from the dynamic drop-down list,
you can further filter the result set in the secondary component by entering the literal
match expression in the Literal Match column.
If no value is provided in any Match Field and the Validate for Deployment button is
clicked. An error message will be displayed.
Literal Match Enter the literal match expression to add filtering criterion for the
retrieval of secondary Business Components. You can enter a character string as the
matching string or all acceptable Siebel search specifications when using the reserved
_Eval syntax. In the above example, the literal match expression is specified as
'_Eval("*@tibco.com")'. Here, only contacts of the parent account that have an email
address that ends with '@tibco.com' will be published. Refer to the Siebel
documentation for the syntax to specify a valid Siebel search expression.
AE Message Field Enter an alternate message field name for the Siebel field name
to be used while publishing.
Default Enter the default value of the Siebel field to be published when data is
either empty or null in the Siebel system.
92
| Chapter 5
Configuration Options
Publication Service
Although data with multiple parent or child records can be received, it is not possible to
send data in such a structure. Data that is published or used to make a request on an
external application must be a Flat Siebel Property Set. Effectively, it can have Name
Value pairs that are at the same level.
The Business Service accepts data as a Single Key Property Set or a Multiple Key
Property Set. Data to be published is sent as a Siebel Property set. You must create this
property set.
For example, you may need to request data from or publish data to an external database
using a single Name Value pair. In this case the Key is sent as part of the property set as
shown below.
Property sets are created in Siebel, either using a Business Service, Business Component
scripts, or in the form of an XML file as shown in the sample below. The XML file can
then be converted into a property set using appropriate Business Service. For details on
converting a property set using Business Services, refer to your Siebel documentation.
<?Siebel-Property-Set EscapeNames="true" ?>
<PropertySet OperationType="upsert"
EventName="MyEvent"
KeyName = "Name"
KeyValue = "A. K.*"
</PropertySet>
If you need to use more than one Name Value pair, you need to send the Property Set in
the format shown below:
<?Siebel-Property-Set EscapeNames="true" ?>
<PropertySet OperationType="upsert"
EventName="MyEvent"
NumInputKeySets="2">
<InputKeySets
Name="A. K.*"
Location="HQ*">
</InputKeySets>
</PropertySet>
The parent Property Set in the example contains the event name MyEvent and needs to send
data that is not in the Siebel database. This data could be hard coded or extracted from the
Siebel GUI.
The parent contains:
Event Name
Operation Type
EAI TIBCO HTTP Agent Business Service parses the XML and generates an Output
Property Set, which is sent to the adapter.
94
| Chapter 5
Configuration Options
The XML tag used to update the integration object must be specified in the Siebel
repository.
1. Drag the SiebelAdapterConfiguration icon to the Design panel or select the template
in the Project panel.
2. Set the required adapter configuration parameters.
Refer to Configuring an Adapter Instance on page 27 for details about configuring an
adapter.
3. Establish the design-time connection.
4. Drag the required Siebel adapter service icon from the Palettes panel to the Design
panel.
5. Select the Siebel Integration Components service type.
For details on setting configuration parameters for the various services, see:
Publication Service, page 55.
Subscription Service, page 61.
Request-Response Service, page 66.
Request-Response Invocation Service, page 72.
6. Click the Apply button to generate the adapter service.
The Primary Integration Component is added to the Project panel and automatically
selected.
7. Specify the parameters in the Configuration tab of the Primary Integration
Component.
You can enter an expression before clicking the Fetch button to filter the list of Siebel
Integration Objects returned. For example, entering A in the Integration Object field
retrieves all available Integration Objects that start with A.
Refer to Primary Integration Component Configuration Tab on page 96 for details.
8. Click the Apply button. The available Siebel fields are retrieved from the Siebel
repository through the design-time connection. The Siebel Integration Fields tab is
then displayed with the list of available fields populated.
9. Select the fields to be included in the Business Event schema using the columns in the
Siebel Integration Fields Tab. Refer to Siebel Integration Fields Tab on page 96 for
details. Then click the Apply button.
Configuring a Secondary Integration Component
To configure a secondary Integration Component, complete the following steps:
96
| Chapter 5
Configuration Options
1. You can add secondary integration components only if child schema has been
predefined for that particular Siebel Integration Component. To add secondary
integration components as children, ensure that the primary or integration component
is selected in the Project panel and drag the Integration Component icon to the
Design panel.
2. Select the required Integration Object and Component by entering the fields or use the
Fetch button.
3. Click the Apply button. The available Siebel fields are retrieved from the Siebel
repository. The Siebel Integration Fields tab is then displayed with the list of available
fields populated.
4. Select the fields to be included in the Business Event schema using columns in the
Siebel Integration Fields tab. Refer to Siebel Integration Fields Tab on page 96 for
details.
Primary Integration Component Configuration Tab
Integration Object Enter the name of the Integration Object or click Fetch to select
the name of the Integration Object.
XML tag The XML name of the integration field in the Siebel Repository. This is a
display field.
Inactive If already selected it indicates that the integration field is inactive in the
Siebel repository. Inactive fields are unavailable for users. Users cannot change the
configuration.
Use the drop-down list at the right top corner to filter the display list. Choose from Show
Required, Show Used, Show Inactive and Show All parameters to select the fields. For
example, selecting Show Used in the drop-down list will filter the list to show fields that
had been selected. You can also enter a search expression to filter the Siebel Field list. For
example, entering A in the drop-down list will filter the list to show only fields that start
with A.
User key Displays the name of the user key field in the Siebel repository of which
this field is a part.
In Siebel, integration components fields are grouped together as user keys. This helps to
identify a single record in an integration component for an integration object. There may
be multiple user keys for a single integration component. Each field may be present in
multiple user keys. The palette does not display all the information required for user keys.
Please verify with Siebel Tools to ensure you select the proper user key.
98
| Chapter 5
Configuration Options
1. Select the adapter configuration in the Project panel. Click the Business Event
Schema tab.
2. Specify the parameters in the Business Event Schema tab. See Business Event Schema
Tab on page 98 for details.
3. Click the Apply button. The adapter service is now ready to carry out operations using
the appropriate Siebel Integration Components.
Business Event Schema Tab
AE Message Field Enter an alternate message field name for the Siebel field name
to be used while publishing.
Sub-processes
Decision points
Tasks
Predefined tasks These tasks include updates to the Siebel databases,
notifications (such as e-mail or page), integration messages to external systems,
and calls to invoke server tasks.
Custom tasks These are tasks defined by the customers using Siebel VB or
Siebel eScript.
Siebel workflow processes can be triggered or started by events in the Siebel application
or external systems. Within the Siebel application, a process can be triggered from a
workflow policy, an insert or update operation on a Business Component, a user interface
event (such as a button click), or a server component.
By using the Siebel Object Interfaces, workflow processes can be triggered from
anywhere in the Siebel application or from external programs.
Refer to Siebel Workflow Guide in your Siebel documentation for details.
Figure 32 shows a sample screen of the Siebel Workflow Process.
100
| Chapter 5
Configuration Options
Once you have configured the adapter and set the required configuration parameters (see
Configuring an Adapter Instance on page 27), use the following steps to configure a
service to invoke the Siebel Work flow:
1. Select the adapter configuration in the Project panel then drag the required adapter
service icon to the design panel.
2. In the Configuration tab that is displayed, enter the parameters for the selected service
type to generate an adapter service. Select the Invoke Siebel Workflow service type,
then click the Apply button.
For details on setting configuration parameters for the various services, see:
Subscription Service, page 61
Request-Response Service, page 66
3. Specify the required fields in the Configuration tab. Then click the Apply button.
If you have specified an integration object to be used by the service, a pop-up window
opens asking you whether you want to generate the integration object schema. If you
click the Yes button, a Configuration tab for the schema generation is displayed. For
details on selecting an integration object, integration component and the schema
required for that particular adapter service see Configuring a Service for Integration
Components on page 94.
102
| Chapter 5
Configuration Options
AE Message Field Enter an alternate message field name for the Siebel field name
while subscribing.
Formatted Check this checkbox to subscribe messages in the Siebel format. The
adapter is instructed to set a value for the Siebel field in the formatted form for
subscriptions.
Figure 34 shows the schema selected for a Subscription Service that is configured to
invoke a Siebel workflow and is also associated with an integration object.
Figure 34 Business Event Schema for Workflow
Publication Service
Subscription Service
Request-Response Service
104
| Chapter 5
Configuration Options
1. After specifying a name in the Request Integration Object Name field (for example,
Sample Account), click the Apply button.
2. In the Generate Schema dialog, click the Yes button to generate the Integration Object
Schema, as shown in Figure 35.
Figure 35 Generate Schema Dialog
3. In the Configuration tab of the Primary Integration Component, click the Fetch button
to select the names in the Integration Object and Integration Component fields. Then
click the Apply button.
If you have specified the Integration Component name as Account, then in the Siebel
Integration Fields - Account tab, click the Select All button or select the required
fields, then click the Apply button, as shown in Figure 36.
Figure 36 Select Integration Fields - Account
4. Select Project > Save to save the Publication Service in the adapter configuration.
To Publish Integration Object data as XML
1. After specifying a name in Request Integration Object Name, check the Publish As
XML checkbox and click the Apply button, as shown in Figure 37.
106
| Chapter 5
Configuration Options
2. Select Project > Save to save the Publication Service in the adapter configuration.
108
| Chapter 5
Configuration Options
If you have specified the Integration Component name as Account, then in the Siebel
Integration Fields - Account tab, click the Select All button or select required fields by
checking the relevant checkboxes in the Use column, and click the Apply button.
4. Select Project > Save to save the Request-Response Service in the adapter
configuration.
After an INSERT, UPDATE, UPSERT or DELETE operation of Integration Objects, the
Status Keys are returned to the calling application in the Data Section of the Reply
Advisory Document. The calling application receives the Reply Advisory Document by
configuring the Reply Address in the request to subscribe.
110
| Chapter 5
Configuration Options
1. In the Configuration tab, after specifying names in the Business Service, Method
Name, and Integration Object Name fields, click the Apply button.
2. In the Generate Schema dialog, click the Yes button to generate the Integration Object
Schema.
3. Click the Fetch button to select the names in the Integration Object and Integration
Component fields. Then click the Apply button.
If you have specified the Integration Component name as Account, then in the Siebel
Integration Fields - Account tab, click the Select All button or select required fields by
checking the relevant checkboxes in the Use column, and click the Apply button.
4. Select Project > Save to save the Request-Response Invocation Service in the adapter
configuration.
The value specified in the No. Of Threads field will be the default thread count for all
sessions. If you do not want to use the default value, use the Multithreading tab to specify
the number of threads for each session. If you have entered values in the Multithreading
tab, those values will take precedence over the Number Of Threads field in the Adapter
Services tab. By default, the sessions thread values are blank.
The thread count is applicable at the session level and not at the service level. Two adapter
services can use the same session.
For outbound services (Publication and Request-Response Invocation service), the thread
count is not provided at the session level. It is provided at the adapter instance level using
the No. Of Threads parameter to process Siebel Events in the Adapter Services tab of the
adapter instance.
The thread value provided here is completely independent from the thread count provided
at the session level in the above section. The session level threads cannot be used for
outbound services.
Starting the adapter in a single threaded mode
If you want to run the adapter in a single threaded mode, it is possible only if you have
configured all the services as inbound services or outbound services. The adapter has to
use at least a single thread for both types of services.
112
| Chapter 5
Configuration Options
Recovery Mechanism
An inbound adapter configuration detects and handles transient network glitches or
application-down situations dynamically and gracefully to ensure messages bound for the
Siebel system from other TIBCO components are not lost.
The ability to handle such situations assumes importance in cases where message transfer
is unidirectional and based on the Certified Messaging protocol. In such cases, the sending
system is unaware of connection losses that are entirely internal to the adapter-to-Siebel
subsystem.
When an inbound configuration receives a message, the adapter double-checks the
validity of the connection before posting the message into the Siebel system. In case the
Siebel system is unavailable because of network glitches or due to the application server
going down, the message is not processed and is not confirmed to the sending application.
When a connection failure is detected during posting of data into the Siebel Application,
the adapter will synchronously try to re-establish the connection with Siebel for the
configured retries before suspend. If the connectivity is restored in this duration, the
adapter processes the message and sends the confirmation to the sending application.
If the retry subsystem fails, an error will be reported and the message will not be
confirmed to the sending application. All the Subscribers in the adapter instance will be
suspended and adapter will not serve any messages. The adapter starts polling the Siebel
system periodically for connection availability and re-establishes connection and activates
all the Listeners once the cause of the connectivity-loss is rectified.
114
| Chapter 5
Configuration Options
| 115
Chapter 6
Topics
116
| Chapter 6
118
| Chapter 6
Specify alerts and TIBCO Hawk rulebases for each machine in the domain.
See Also
See TIBCO Administrator Users Guide for information about configuring the above
monitoring options.
120
| Chapter 6
| 121
Chapter 7
Topics
122
| Chapter 7
The followings are the steps for creating a custom TIBCO Hawk session:
1. Open the Advanced folder for the adapter instance. Select the Sessions folder.
2. Drag the GenericSession icon from the Palettes panel to the Design panel.
3. In the Session Type drop-down list, select the RV item. Click the Apply button.
4. In the Name field, enter the name previously assigned in the Default MicroAgent
Session field under the Monitoring tab.
5. In the Service field, enter 7474 (the default used by TIBCO Hawk).
6. In the Daemon field, enter tcp:7474 (the default used by TIBCO Hawk).
7. Click the Apply button and save the project.
To modify the parameters of the preconfigured session, select HawkSession_RV from the
Advanced folder in the Project panel and modify parameters as required.
8. Save it as a local repository.
For information about saving a project, refer to TIBCO Designer Users Guide.
See Predefined Global Variables on page 126 for a reference description of each
monitoring field.
124
| Chapter 7
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 a properties file. This overrides the project
repository.
Enforce the predefined variables listed in Predefined Global Variables on page 126.
Global variables can be used anywhere in the configuration and will be replaced by
the values specified in the Global Variables tab.
Define a variable using TIBCO Designer, then override the value for individual
applications at deployment time using TIBCO Administrator. You can also override
values for predefined variables, unless the GUI does not allow you to set them later.
Predefine a variable using TIBCO Designer, then override the value for individual
services (for example, publication service or TIBCO BusinessWorks process) at
deployment time using TIBCO Administrator. The values you specify are then used at
runtime. You can also override values for predefined variables, unless the GUI does
not allow you to set them later.
For example, you could assign the value 7474 to the predefined global variable RvDaemon.
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 command line.
To use global variables in your project, follow these steps:
1. In the Project panel, select the Global Variables tab.
The Project panel is updated to display all currently defined global variables. Click the
Open Advanced Editor button (the pencil button at the top left corner). You now
have these choices:
To assign or change a variable value, select that region and triple-click 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 leftmost button at the bottom of the
dialog box. Specify the name of the group, then press Enter. With the group icon
selected, click the Abc button to add variables to the group.
To add a global variable, click the Abc button. 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 running, 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 126 for information. You may add definitions of any variables you need to the
predefined variables.
where variablePathAndName is the name of the variable you wish to set (including the path
to the variable if it is contained in a folder), and value is the value you wish to set the
variable to. For example, if you have a global variable named item1 contained in a folder
named myGroup and you wish to set its value to 500, add the following argument to the
command line when starting the process engine:
-tibco.clientVar.myGroup/item1 500
126
| Chapter 7
Description
Deployment
Defaults to the TIBCO Designer project name. This global variable is used by the
system to partially define the subject name defined for a service.
DirLedger
Specifies the path name of the TIBCO Rendezvous certified messaging ledger file. The
default is the root installation directory.
DirTrace
Specifies the path name for log file used by the adapter. The default is the root
installation directory.
HawkEnabled
Indicates whether TIBCO Hawk is used to monitor the adapter. True indicates that a
TIBCO Hawk microagent is defined for the adapter. False indicates the microagent is
not to be used.
JmsProviderUrl
Specifies where the JMS server is located. Setting this value mostly makes sense in
early stages of a project, when only one JMS server is used.
JmsSslProviderUrl
RemoteRvDaemon
TIBCO Rendezvous routing daemon (rvrd) to be used. See TIBCO Administrator Server
Configuration Guide for details about setting up a domain using rvrd.
RvDaemon
RvNetwork
TIBCO Rendezvous network. This variable need only be set on computers with more
than one network interface. If specified, the TIBCO Rendezvous daemon uses that
network for all outbound messages.
In most cases, you can leave the default.
RvService
TIBCO Rendezvous service. The Rendezvous daemon divides the network into logical
partitions. Each transport communicates on a single service. A transport can
communicate only on the same service with other transports.
Unless you are using a non-default TIBCO Rendezvous configuration, you should leave
the default (7500).
Description
RvaHost
Computer on which the TIBCO Rendezvous agent runs. This variable is only relevant if
you are using the TIBCO Rendezvous Agent (rva) instead of the TIBCO Rendezvous
daemon, and if you have configured a non-default setup. See TIBCO Rendezvous
Administration for details about specifying the rva parameters.
RvaPort
TCP port where the TIBCO Rendezvous agent (rva) listens for client connection
requests. See TIBCO Rendezvous Administration for details about specifying the rva
parameters. Defaults to 7501.
TIBHawkDaemon
TIBCO Rendezvous daemon used in the TIBCO Hawk session. See TIBCO Hawk
Installation and Configuration for details about this parameter.
TIBHawkNetwork
TIBCO Rendezvous network used by the TIBCO Hawk session. See TIBCO Hawk
Installation and Configuration for details about this parameter.
TIBHawkService
TIBCO Rendezvous service used by the TIBCO Hawk session. See TIBCO Hawk
Installation and Configuration for details about this parameter.
128
| Chapter 7
The following figures show the above mentioned folders in a Revision Control System:
Figure 40 Visual SourceSafe Explorer (Siebel Folder)
130
| Chapter 7
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
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment
For information about how to use the Multi-User feature in TIBCO Designer, refer to
TIBCO Designer Users 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 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.
132
| Chapter 7
134
| Chapter 7
4. Configure the Invoke An Adapter Request-Response Service activity. In the Input tab,
add the following five items in the eventKeys, as shown in Table 19.
Table 19 Login Information
Name
Value Type/Format
Description
_TIBCO_Reserved_01
String
Login name
_TIBCO_Reserved_01
String
Login password.
_TIBCO_Reserved_01
int
View mode
_TIBCO_Reserved_01
int
_TIBCO_Reserved_01
5. Run the adapter. The adapter will receive a message with the username DIPPER,
password DIPPER, and the other two parameters set, as shown in Figure 46, and use
these parameters to connect to the Siebel Server. If the items mentioned in Figure 46
are not set, the adapter will use the parameters that are configured in the Runtime
Connection tab of the adapter configuration to connect to the Siebel Server.
Figure 46 Input Sample
will
be sent to Siebel.
Figure 47 Customer Attribute
136
| Chapter 7
| 137
Chapter 8
This chapter describes how a Custom Siebel Business Service, EAI TIBCO HTTP Agent,
facilitates exchange of data between Siebel and other external systems using the adapter.
Topics
Publishing Using EAI TIBCO HTTP Agent Business Service, page 139
Importing the EAI TIBCO HTTP Agent Business Service, page 147
Testing the EAI TIBCO HTTP Agent Business Service, page 155
Using EAI TIBCO HTTP Agent Business Service in Event Script, page 161
Using the EAI TIBCO HTTP Agent Business Service in Workflow, page 163
138
| Chapter 8
Overview
The EAI TIBCO HTTP Agent Business Service enables the Siebel Object Manager to
generate outbound requests to the adapter. The publication requests can be triggered or
invoked from various contexts within the Siebel environment such as Siebel event scripts
or Siebel workflow processes.
The Business Service encapsulates the HTTP Transport interface provided by Siebel that
generates the outbound requests to the adapter.
Description
140
| Chapter 8
Description
Table 21 categorizes the recommended EAI TIBCO HTTP Agent deployment strategies
by the type of Siebel Clients employed. It presents the method of invocation for generating
the publication request.
Table 21 Different Siebel Client Types and Methods of Invocation
Siebel Client Type
Mobile Clients
Type
Description
AgentHTTPServer
Input
ErrorCode
Output
ErrorMessage
Output
ServerPublisherState
Output
IsSecureConn
Input
142
| Chapter 8
Type
Description
AgentHTTPServer
Input
ErrorCode
Output
ErrorMessage
Output
EventName
Input
KeyName
Input
KeyValue
Input
OperationType
Input
insert
update
delete
upsert
NumInputKeySets
Input
Table 23 EAI TIBCO HTTP Agent Publish Business Event Arguments (Sheet 2 of 2)
Argument
Type
Description
InputKeySets
Input
TIBErrorCode
Output
CharSetConversion
Input
HTTPRequestTimeout
Input
IsSecureConn
Input
CheckAdapterAvailability
Input
SiebelMessage
Input
Description
KeyValue only
The default top-level match field specified in the Business Event specification is
used as the matching criterion for generating one publication event.
The top-level match field is set using the KeyName input argument (overwriting the
default top-level match field) and is used as the match criterion for generating one
publication request.
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment
144
| Chapter 8
Description
The top-level match fields are set using the name or value pairs specified in the
InputKeySets as Siebel Property Sets and are used as the match criteria for generating
one publication request.
Type
Description
AgentHTTPServer
Input
ErrorCode
Output
ErrorMessage
Output
EventName
Input
KeyName
Input
(Optional) Name of the Siebel field as the key for setting up the
top-level matching criterion for the adapter to process the
publication request. If this is not given, the default top-level match
field in the Business Event specifications is used.
KeyValue
Input
Table 25 EAI TIBCO HTTP Agent Publish Business Event with Reply Arguments (Sheet 2 of 3)
Argument
Type
Description
OperationType
Input
insert
update
delete
upsert
NumInputKeySets
Input
ReplyNumeric
Output
ReplyString
Output
ReplyMessage
Output
ReplyTimeout
Input
CharSetConversion
Input
CheckAdapterAvailability
Input
The Business Service checks for adapter availability when this flag
is set to Y. By default, this field is set to N.
SiebelMessage
Input
146
| Chapter 8
Table 25 EAI TIBCO HTTP Agent Publish Business Event with Reply Arguments (Sheet 3 of 3)
Argument
Type
Description
HTTPRequestTimeout
Input
Is the timeout interval required to login, send, and log off requests.
The value is in milliseconds. The default value is 120000 ms.
TIBErrorCode
Output
IsSecureConn
Input
Description
KeyValue only
The default top-level match field specified in the Business Event specification is
used as the matching criterion for generating one publication event.
The top-level match field is set using the KeyName input argument (overwriting the
default top-level match field) and is used as the match criterion for generating one
publication request.
NumInputKeySets,
InputKeySets
The top-level match fields are set using the name or value pairs specified in the
InputKeySets as Siebel Property Sets and are used as the match criteria for generating
one publication request.
If you are using service type as SendReceive Integration Objects in the Request-Response
Invocation service, SiebelMessage should be entered as KeyName and the KeyValue should
contain the whole integration object instance. Refer to Siebel Integration Objects on
page 317 for more information.
Location:
ADSBL_HOME/siebel/77TIBSiebelAdapterHTTPAgentBusinessService_escript.sif
Location:
ADSBL_HOME/siebel/8TIBSiebelAdapterHTTPAgentBusinessService_escript.sif
148
| Chapter 8
2. Lock the project EAI Business Service by selecting the project and checking the
locked field, as shown in Figure 48.
Figure 48 Lock the EAI Business Service Project
3. Select Business Service from the Object Explorer in the left-hand panel of Siebel
Tools and search for all Business Services starting with EAI. Figure 49 shows the list
of Business Services that start with EAI.
4. From the Tools menu, select the Import From Archive item to import the custom
Business Service supplied with the adapter installation, as shown in Figure 50.
Figure 50 Tool Menu
5. Select the appropriate archive, based on the version of Siebel and the scripting
language you are using, from the ADSBL_HOME\siebel directory.
150
| Chapter 8
6. Preview the contents included in the Siebel archive as shown in the screen sample that
contains the EAI TIBCO HTTP Agent Business Service. Click the Next button to
continue. Select the overwrite option if you want to remove an existing version of the
Business Service in the Siebel Repository, as shown in Figure 51.
Figure 51 Import Wizard (Preview)
7. Review the details of the Business Service object included in the Siebel archive, as
shown in Figure 52. It describes the detail object definitions of the EAI TIBCO HTTP
Agent Business Service in a hierarchy tree view. Click the Next button to continue.
8. Acknowledge the confirmation to modify the current Siebel Repository. Click the Yes
button to start the import.
Figure 53 Siebel Confirmation Dialog
9. Examine the summary of the import log after the import is done. Click the Finish
button to complete the import wizard, as shown in Figure 54.
152
| Chapter 8
10. Verify that the list of Business Services that starts with EAI is updated with the newly
imported EAI TIBCO HTTP Agent Business Service, as shown in Figure 55.
Figure 55 EAI TIBCO HTTP Agent Business Service
11. The newly imported business service EAI TIBCO HTTP Agent Business Service has
to be compiled, as shown in Figure 56.
The Siebel server should be stopped to complete this operation.
12. Select the Selected Projects radio button. Select the EAI Business Services item, as
shown in Figure 57. Select the Siebel Server repository (.srf) file and start compile.
Similarly, compile the Web Client repository (.srf) file.
154
| Chapter 8
156
| Chapter 8
3. On the Service Methods applet, click the Load From File... button to import a sample
invocation for the service method GetState. The Load XML File window is displayed.
4. Click the Browse button. Go to the ADSBL_HOME/examples/service directory and select
7HTTPAgentSimulateMethodInvokeGetState.xml. Click the Open button, as shown in Figure 60.
Click the Load button.
Figure 60 Choose File
You can also manually add a new record and select EAI TIBCO HTTP Agent from the
drop-down list and choose the corresponding service method to simulate.
5. To import Input Parameters for the GetState method, click the Load From File button
on the Input Property Set applet, then go to the ../examples/service directory and select
HTTPAgentSimulateMethodInvokeGetStateInput.xml, as shown in
Figure 60. The file is loaded into the Input Property Set applet.
6. In the Input Property Set applet, click the name in the Property Name column, as
shown in Figure 61, then click the
button that appears.
7. The Property Set Properties window is displayed. Change the AgentHTTPServer argument
with the name of the machine on which the adapter will be started along with the port
number, as shown in Figure 62.
For example: if the adapter is started on myMachine on port 9191, change AgentHTTPServer
from localhost to myMachine:9191.
Figure 62 Property Set Properties
8. Repeat the previous steps for sample invocation for the Send service method. Select
7HTTPAgentSimulateMethodInvokeSend.xml from the same folder, as shown in Figure 60.
The top applet now shows the two service methods available for simulation. The
Iteration column indicates the number of iterations for the simulating service method
that will execute when you click the Run button. This value is set to 1 in both cases, as
shown in Figure 63.
Figure 63 Simulator
9. Select the GetState item from the Method Name column on the top applet and click
the Run button. Examine the Output Property Set applet and the Output Arguments
applet to verify the error code and error message, as shown in Figure 64.
158
| Chapter 8
10. In the Property Name column, double-click the property name to check the error code
and error message, as shown in Figure 65.
Figure 65 Error Code
Figure 66 indicates that the Send service method simulation will generate a publication
request for Business Event PubAccountTest using KeyName of Name and KeyValue of A* with
OperationType of insert. The value can easily be altered to simulate different parameters in
generating the publication request.
Figure 66 Update Property Value
15. In the Property Name column, double-click the property name to check the KeyValue, as
shown in Figure 67.
Change the AgentHTTPServer argument with the name of the machine on which the
adapter will be started along with the port number. For example: if the adapter is
started on myMachine on port 9191, change AgentHTTPServer from localhost to myMachine:9191.
Figure 67 Property Set Properties (KeyValue)
16. Start a message listener for data published from the adapter before submitting the
publication request. At a command prompt, enter the following:
c:\ > tibrvlisten domain.pubservices.adsbl.pubtest.PublicationService
17. Select the Send method on the top applet to start the simulation, then click the Run
button and watch for a message received on subject
'domain.pubservices.adsbl.pubtest.PublicationService'.
18. Verify that the Output Property Set applet and the Output Arguments applet display
the iteration and error code of 0 indicating the publication request is successfully
160
| Chapter 8
processed by the adapter. In the Property Name column, double-click the property
name to check the error message and error code, as shown in Figure 68.
Figure 68 Property Set Properties Error Message
19. Repeat the simulation for Send service method using different key values and watch the
output messages captured on subject 'domain.pubservices.adsbl.pubtest.PublicationService'.
20. Stop the adapter by issuing the following command:
tibrvsend _LOCAL.ADSBL.SHUTDOWN.ALL STOP
Using EAI TIBCO HTTP Agent Business Service in Event Script 161
Create an input property set to be used as input argument in the service method
invocation.
Create an output property set to be used as output argument in the service method
invocation.
Populate the input property set with the necessary input arguments of the service
method to invoke.
The following example code segment written in Siebel escript for the BusComp_WriteRecord
event script illustrates how to use the EAI TIBCO HTTP Agent Business Service to
generate a publication request to the adapter to export Siebel data into the TIBCO
environment.
function BusComp_WriteRecord ()
{
// Get Id field value for invoking business event
var sId = GetFieldValue("Id");
// Create TIBCO Siebel Adapter business service
var oTIBService = TheApplication().GetService("EAI TIBCO HTTP
Agent");
Enter the name of the machine where the adapter is running as adaptermachine. For port, enter
the number of the port, which has been configured to listen to HTTP requests in the
adapter configuration
162
| Chapter 8
oOutput);
The example event scripts can be located in the following examples directory:
Siebel eScript ADSBL_HOME\examples\eScript
Using the EAI TIBCO HTTP Agent Business Service in Workflow 163
164
| Chapter 8
Error Description
1001
No running adapter instance found. Adapter not running or listening on a different port.
1002
1003
Invalid option for Check Adapter Availability. The value should be either TRUE or FALSE.
1005
1006
1008
1010
| 165
Chapter 9
This chapter describes how to use JMS messaging for communication between Siebel
server and the adapter for Request-Response Invocation and Publication services.
Topics
Publishing Using EAI TIBCO JMS Agent Business Service, page 170
Testing the EAI TIBCO JMS Agent Business Service, page 176
Using EAI TIBCO JMS Agent Business Service in Event Script, page 179
Using the EAI TIBCO JMS Agent Business Service in Workflow, page 181
Status Codes for EAI TIBCO JMS Agent Business Service, page 182
166
| Chapter 9
Overview
The EAI TIBCO JMS Agent Business Service enables the Siebel Object Manager to
generate outbound requests to the adapter. The publication requests can be triggered or
invoked from various contexts within the Siebel environment such as Siebel event scripts
or Siebel workflow processes.
The Business Service encapsulates the JMS Transport interface provided by Siebel that
generates the outbound requests to the adapter.
168
| Chapter 9
into the
JVM Classpath.
170
| Chapter 9
Description
Description
Table 29 categorizes the recommended EAI TIBCO JMS Agent deployment strategies by
the type of Siebel Clients employed. It presents the method of invocation for generating
the publication request.
Table 29 Different Siebel Client Types and Methods of Invocation
Siebel Client Type
Mobile Clients
172
| Chapter 9
Type
Description
ConnectionFactory
Input
ErrorCode
Output
ErrorMessage
Output
EventName
Input
KeyName
Input
Name of the Siebel field as the key for setting up the top-level
matching criterion for the adapter to process the publication request.
If this is not given, the default top-level match field in the Business
Event specifications is used.
KeyValue
Input
OperationType
Input
insert
update
delete
upsert
Table 30 EAI TIBCO JMS Agent Publish Business Event Arguments (Contd)
Argument
Type
Description
InputKeySets
Input
(Optional) Input key name or value pairs in the Siebel Property Set
hierarchy form.
TIBErrorCode
Output
SiebelMessage
Input
ReceiveTimeout
Input
The interval that JMS Transport will wait to receive the reply from
reply queue before timing out. The value is in seconds. The default
value is 30.
SendQueue
Input
ReplyQueue
Input
Refer to Table 24, Invoking the Publish Business Event Service Method, on page 143 for
the ways to invoke this service method.
Type
Description
ConnectionFactory
Input
ErrorCode
Output
ErrorMessage
Output
174
| Chapter 9
Table 31 EAI TIBCO JMS Agent Publish Business Event with Reply Arguments (Contd)
Argument
Type
Description
EventName
Input
KeyName
Input
Name of the Siebel field used as the key for setting up the top-level
matching criterion for the adapter to process the publication
request. If this is not given, the default top-level match field in the
Business Event specifications is used.
KeyValue
Input
OperationType
Input
insert
update
delete
upsert
TIBErrorCode
Output
InputKeySets
Input
SiebelMessage
Input
ReceiveTimeout
Input
The interval that JMS Transport will wait to receive the reply from
reply queue before timing out. The value is in second. The default
value is 30.
ReplyTimeout
Input
SendQueue
Input
ReplyQueue
Input
Table 31 EAI TIBCO JMS Agent Publish Business Event with Reply Arguments (Contd)
Argument
Type
Description
ReplyNumeric
Output
ReplyString
Output
ReplyMessage
Output
Refer to Table 26, Invoking the Publish Business Event Method with Reply, on page 146
for the ways to invoke this service method.
176
| Chapter 9
You can also manually add a new record and select EAI TIBCO JMS Agent from the
drop-down list and choose the corresponding service method to simulate.
5. To import Input Parameters for the Send method, click Load From File on the Input
Property Set applet, then go to the ../examples/service directory and select
JMSAgentSimulateMethodInvokeSendInput.xml, as shown in Figure 72. The file is loaded into
the Input Property Set applet.
6. In the Input Property Set applet, click the name in the Property Name column, as
button that appears.
shown in Figure 73, then click the
Figure 73 Input Arguments (JMS)
7. Double-click the Property Name to check the Keyvalue, as shown in Figure 74.
Figure 74 Property Set Properties (JMS)
8. Configure and start the adapter on your machine. Make sure that the EMS Server has
started. Select the Send method on the top applet to start the simulation, click the Run
178
| Chapter 9
10. In the Property Name column, double-click the property name to check the error
message and error code, as shown in Figure 76.
Figure 76 Property Set Properties Error Message (JMS)
11. Repeat the simulation for Send service method using different key values and watch the
output messages captured on the subject 'domain.pubservices.adsbl.pubtest.PublicationService'.
12. Stop the adapter by issuing the following command:
tibrvsend _LOCAL.ADSBL.SHUTDOWN.ALL STOP
Using EAI TIBCO JMS Agent Business Service in Event Script 179
Create an input property set to be used as input argument in the service method
invocation.
Create an output property set to be used as output argument in the service method
invocation.
Populate the input property set with the necessary input arguments of the service
method to invoke.
The following example code segment written in Siebel escript for the BusComp_WriteRecord
event script illustrates how to use the EAI TIBCO JMS Agent Business Service to
generate a publication request to the adapter to export Siebel data into the TIBCO
environment.
function BusComp_WriteRecord ()
{
// Get Id field value for invoking business event
var sId = GetFieldValue("Id");
// Create TIBCO Siebel Adapter business service
var oTIBService = TheApplication().GetService("EAI TIBCO JMS
Agent");
180
| Chapter 9
Using the EAI TIBCO JMS Agent Business Service in Workflow 181
182
| Chapter 9
Error Description
1001
No running adapter instance found. Adapter not running or listening on a different port.
1002
1005
440
Execute error.
| 183
Chapter 10
This chapter explains how to use TIBCO Hawk microagents to monitor and manage the
adapter.
Topics
184
| Chapter 10
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 TIBCO Hawk Display, sending
email, paging, running executables, or modifying the behavior of a managed adapter.
Unlike other monitoring applications, TIBCO Hawk relies on a purely distributed
intelligent agent architecture using Publication or Subscription to distribute alerts. TIBCO
Hawk uses TIBCO Rendezvous for all messaging and thus gains the benefits and
scalability from the TIBCO Rendezvous features of Publication or Subscription, 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.
TIBCO Hawk Enterprise Monitor consists of the following components:
The TIBCO Hawk Enterprise Monitor consists of following components:
Display 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.
Microagents Feed information back to TIBCO Hawk and expose action methods to
rulebases.
186
| Chapter 10
This dialog has two modes, Invoke and Subscribe. 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.
3. Click a microagent name, such as Self, to display a list of associated methods and text
descriptions in the panels below.
188
| Chapter 10
4. Click the name of the method to invoke, such as getMicroAgentInfo, as shown in Figure
79.
Figure 79 Select Microagent and Method
If the method accepts arguments, fields for each argument display in the upper right
panel. Detailed help text is displayed in the lower panel.
5. Specify any arguments for the method invocation.
6. Verify that the Invoke radio button is selected.
7. Click the Invoke button to invoke the selected method. The Invocation Results dialog
displays the results returned by the method, as shown in
Figure 80.
190
| Chapter 10
Available Microagents
Each adapter has two microagents, a standard TIBCO Hawk microagent named
COM.TIBCO.ADAPTER.xyz where xyz is the adapter configuration name and a custom
microagent.
The microagents provide:
Business level statistics, statistics that report the progress of the adapter as it interacts
with Siebel. 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.
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.
You can disallow adding custom methods to the class microagent when deploying the
adapter by changing the addCustomHawkMethodstoClassMAgent property value in the adapters
property file. If this property is set to on, custom methods are added to the class
microagents. If set to off, these methods are not visible.
Description
activateTraceRole()
deactivateTraceRole()
getAdapterServiceInformation()
getComponents()
getConfig()
getConfigProperties()
getRvConfig()
getStatus()
getTraceSinks()
getVersion()
_onUnsolictedMsg()
preRegisterListener()
resetConnectionStatistics( )
resetThreadStatistics()
reviewLedger()
192
| Chapter 10
Description (Contd)
setTraceSinks()
stopApplicationInstance()
unRegisterListener()
Description
getActivityStatisticsBySchemaName()
getActivityStatistics()
getActivityStatisticsByOperation()
getActivityStatisticsByService()
getConnectionStatistics()
getPerfMonSetting()
getQueueStatistics()
getThreadStatistics()
getPollingInterval()
setPollingInterval()
activateTraceRole() 193
activateTraceRole()
Purpose
Parameters
Type
Description
roleName
string
sinkName
string
194
| Chapter 10
deactivateTraceRole()
Purpose
Parameters
Type
Description
roleName
string
sinkName
string
getActivityStatistics() 195
getActivityStatistics()
Purpose
Returns the total number of objects processed for all the schemas, based on the request
type. Also, returns the number of success and error objects.
Parameters
Type
GetSubTotalBy
string
Description
Indicates how to group the subtotals, by Service or
Operation.
Returns
Type
Description
Name
string
Total
integer
Success
integer
Failure
integer
MeasurementInterval
integer
196
| Chapter 10
getActivityStatisticsByOperation()
Purpose
Parameters
Type
Description
Operation
string
Returns
Type
Description
Operation
string
Service Name
string
Total
integer
Success
integer
Failure
integer
MeasurementInterval
integer
LineIndex
string
getActivityStatisticsByService() 197
getActivityStatisticsByService()
Purpose
Returns statistics about the data handled by a given adapter service or all adapter services
since the time the adapter was started.
Parameters
Type
Description
Service Name
string
Returns
Type
Description
Service Name
string
Service name.
Schema Name
string
Operation
string
Total
integer
Success
integer
Failure
integer
MeasurementInterval
integer
LineIndex
string
198
| Chapter 10
getAdapterServiceInformation()
Purpose
Returns information about the services implemented by this adapter. The information is a
summary of available adapter services.
Parameters
Type
Description
serviceName
string
Returns
Type
Description
Line
integer
ServiceName
string
EndpointName
string
Type
string
Quality of Service
string
Subject
string
Class
string
Number of Messages
integer
getComponents() 199
getComponents()
Purpose
Returns information about the currently active TIBCO Hawk components such as
publishers, subscribers, or timers.
Parameters
Type
Description
Component Name
string
Component Type
string
Returns
Type
Description
Instance ID
string
Adapter Name
string
Component Name
string
Component Type
string
Session Name
string
Description
string
200
| Chapter 10
getConfig()
Purpose
Returns
Type
Description
Instance ID
string
Adapter Name
string
Repository
Connection
string
Configuration URL
string
Command
string
getConfigProperties() 201
getConfigProperties()
Purpose
Returns all attributes and elements for the given repository object.
Parameters
Type
Description
Property
string
Returns
Type
Description
Element Name
string
Attribute Name
string
Attribute Value
string
Line
integer
202
| Chapter 10
getConnectionStatistics()
Purpose
Returns the state and statistics for all the current connections used by the adapter.
Returns
Type
Description
Connection ID
string
Connection Type
string
State
string
NumRetries
integer
TotalNumOperations
integer
CurrentNumOperatio
ns
integer
NumLostConnections
integer
MeasurementInterval
integer
getQueueStatistics() 203
getQueueStatistics()
Purpose
Returns the current count of elements in any internal queue used by the adapter. This
includes the TIBCO Rendezvous event queues automatically spawned by Rendezvous for
each adapter.
Returns
Type
Description
QueueID
string
QueueType
string
QueueCount
integer
MaxQueueSize
integer
MeasurementInterval
integer
Returns the current count of elements in any internal queue used by the adapter. This
includes the TIBCO Rendezvous event queues automatically spawned by Rendezvous for
each adapter.
204
| Chapter 10
getRvConfig()
Purpose
Returns information about the TIBCO Rendezvous session defined by this adapter.
Parameters
Type
Description
Session Name
string
Returns
Type
Description
Instance ID
string
Adapter Name
string
Session Name
string
Service
string
Daemon
string
Network
string
Synchronous
boolean
Session Type
string
Certified Name
string
Ledger File
string
CM Timeout
string
getStatus() 205
getStatus()
Purpose
Returns
Type
Description
Instance ID
string
Adapter Name
string
Uptime
integer
Messages Received
integer
Messages Sent
integer
New Errors
integer
Total Errors
integer
Process ID
integer
Host
string
206
| Chapter 10
getThreadStatistics()
Purpose
Returns
Type
Description
ThreadID
string
ThreadType
string
TaskType
string
TaskCount
integer
MeasurementInterval
integer
getTraceSinks() 207
getTraceSinks()
Purpose
Parameters
Type
Description
Sink Name
string
Role Name
string
Returns
Type
Description
Instance ID
string
Adapter Name
string
Sink Name
string
Sink Type
string
Roles
string
208
| Chapter 10
getVersion()
Purpose
Retrieves version information for the current application. Two lines may be returned, one
for the TIBCO Adapter SDK, one for the adapter.
Returns
Type
Description
Instance ID
string
Adapter Name
string
Version
string
_onUnsolictedMsg() 209
_onUnsolictedMsg()
Purpose
Displays all alert messages sent from the adapter or an error if not successful.
210
| Chapter 10
preRegisterListener()
Purpose
Preregisters an anticipated listener. Some sending applications can anticipate requests for
certified delivery even before the listening applications start running. In such situations,
the sender can preregister listeners, so TIBCO Rendezvous software begins storing
outbound messages in the senders ledger. If the listening correspondent requires old
messages, it receives the backlogged messages when it requests certified delivery.
Parameters
Returns
Input Parameters
Type
Description
Session Name
string
Publisher Name
string
string
OK
resetConnectionStatistics( ) 211
resetConnectionStatistics( )
Purpose
212
| Chapter 10
resetThreadStatistics()
Purpose
reviewLedger() 213
reviewLedger()
Purpose
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.
Parameters
Type
Description
Session Name
string
Subject
string
Returns
Type
Description
Session Name
string
Subject
string
integer
Total Messages
string
Total Size
integer
string
214
| Chapter 10
Type
Description
Last Confirmed
string
Line
integer
UnacknowledgedMessa
ges
integer
setTraceSinks() 215
setTraceSinks()
Purpose
Parameters
Type
Description
Sink Name
string
Role Name
string
File Size
integer
Returns
OK
216
| Chapter 10
stopApplicationInstance()
Purpose
Returns
OK
unRegisterListener() 217
unRegisterListener()
Purpose
Parameters
Returns
Input Parameters
Type
Description
Session Name
string
Publisher Name
string
string
True
218
| Chapter 10
getActivityStatisticsBySchemaName()
Purpose
Returns the total number of objects processed for the given schema by each service that
uses the schema. Also, returns the number of success and error objects.
Parameters
Type
Description
Schema Name
string
Returns
Type
Description
Service Name
string
Total
string
Success
string
Failure
string
getPerfMonSetting() 219
getPerfMonSetting()
Purpose
Returns
Type
Description
Setting
string
220
| Chapter 10
getPollingInterval()
Purpose
Returns
Type
Description
PollingInterval
integer
setPollingInterval() 221
setPollingInterval()
Purpose
Parameters
Type
Description
PollingInterval
integer
ServiceName
string
222
| Chapter 10
| 223
Appendix A
Trace Messages
This appendix explains the trace messages that are logged to a location specified at
configuration time.
Topics
224
| Appendix A
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 226. 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
SiebelAdapter.SiebelAdapterConfiguration Info [Adapter]
Status Code
AESEBL-000067 Message containing class /tibco/public/class/ae/Customer received on subject
FROM.SAP
Tracking Identifier
tracking=#MU3oTJ/WWCV1MU96J0zzwA9kzzw#
The next set of trace messages indicates the adapter received an object that was sent on the
TIBCO Rendezvous subject, FROM.SAP. The #MU3oTJ/WWCV1MU96J0zzwA9kzzw# 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.
2003 Apr 07 16:14:53:943 GMT +5
SiebelAdapterConfiguration Info [Adapter]
Overview 225
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
SiebelAdapterConfiguration 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.
226
| Appendix A
Trace Messages
Description
Timestamp
Adapter Identifier
Role
Warn. An abnormal condition was found. Processing will continue, but special
attention from an administrator is recommended.
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.
Description
Category
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.
Status Code
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 229 for
details.
Tracking Identifier
A unique identifier that is stamped on each message by the originating adapter. The
tracking identifier remains in effect from a messages 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.
228
| Appendix A
Trace Messages
Description
Application
Information
Status Messages
In environments where multiple applications are used simultaneously, the possible status
messages increase as well. This chapter lists the various messages in numerical order.
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.
Role
AEADSBL-400001
Adapter Rename Warning/The schema folder for this adapter configuration will
be changed from [%1] to [%2] as a result of this rename. Are you sure you want
to proceed?
Warning
AEADSBL-400002
Configuration
JMS Service Configuration Warning/This adapter version does not support JMS
services but one was found.'
Warning
AEADSBL-400004
Configuration
Resolution
AEADSBL-400003
Category
Configuration
XML Wire Format Warning/This adapter version does not support XML Wire
Format.
Warning
Configuration
230
| Appendix A
Trace Messages
Role
AEADSBL-400005
AEADSBL-400006
Design-time
Connection
Design-time
Connection
Configuration
AEADSBL-400012
AEADSBL-400011
Design-time
Connection
AEADSBL-400009
AEADSBL-400008
Design-time
Connection
Resolution
AEADSBL-400007
Category
Configuration
Configuration
Role
AEADSBL-400014
AEADSBL-400015
Configuration
Configuration
Configuration
AEADSBL-400021
Configuration
Generate Schema/Do you wish to generate the Integration Object schema also.
Warning
AEADSBL-400020
AEADSBL-400019
Configuration
AEADSBL-400018
AEADSBL-400017
Configuration
Resolution
AEADSBL-400016
Category
Configuration
Configuration
232
| Appendix A
Trace Messages
Role
AEADSBL-400022
AEADSBL-400023
Configuration
Configuration
Configuration
AEADSBL-400029
Invalid Event Class/Invalid Event Class Selection for Reply Schema Reference.
Warning
AEADSBL-400028
Configuration
Invalid Event Class/Invalid Event Class Selection for Request Schema Reference.
Warning
AEADSBL-400026
AEADSBL-400025
Configuration
Resolution
Missing Match Condition/Match condition not specified for [%1] Please specify
at least one match condition.
Error
AEADSBL-400024
Category
Configuration
Error/Multi Value Fields from parent Business Component not retrieved. Please
reload list of Siebel Fields from Siebel Repository before proceeding.
Error
Configuration
Role
AEADSBL-400030
AEADSBL-400032
Design-time
Connection
Design-time
Connection
Design-time
Connection
AEADSBL-400040
Design-time
Connection
Fields could not be fetched/Please fetch the Integration Object and Component.
Error
AEADSBL-400039
Regenerate Field List/Do you want to regenerate Siebel field list for [%1]?
Information
AEADSBL-400038
Configuration
AEADSBL-400037
AEADSBL-400036
Configuration
Resolution
Password Error/Password not set for User [%1]. Please check the Connection
settings of the Adapter Configuration.
Error
AEADSBL-400035
Category
Design-time
Connection
Design-time
Connection
234
| Appendix A
Trace Messages
Role
AEADSBL-400041
AEADSBL-400042
Configuration
Configuration
Configuration
Configuration
AEADSBL-400049
AEADSBL-400048
Configuration
AEADSBL-400047
AEADSBL-400046
Configuration
AEADSBL-400045
AEADSBL-400044
Design-time
Connection
Resolution
AEADSBL-400043
Category
Configuration
Configuration
Role
AEADSBL-400050
Value Range Error/Palette error. The [%1] must be greater than or equal to
[%2], and less than or equal to [%3].
Error
AEADSBL-400051
Configuration
Configuration
Configuration
Configuration
AEADSBL-400058
File Not Found/Unable to find the specified file specified in [%1]. Please ensure
that you specified an absolute path and the file exists.
Error
AEADSBL-400057
Configuration
Illegal First Character/Illegal first character, The name of [%1] must start with
an alphabet.
Error
AEADSBL-400056
AEADSBL-400055
Configuration
Duplicate Service Name/Another service with same name [%1] exists in the
project. Please specify a unique service name.
Error
AEADSBL-400054
Duplicate Instance Name/Another instance with same name [%1] exists in the
project. Please specify a unique instance name.
Error
AEADSBL-400053
Configuration
Resolution
AEADSBL-400052
Category
Configuration
Configuration
236
| Appendix A
Trace Messages
Role
AEADSBL-400059
AEADSBL-400060
Configuration
Configuration
Configuration
AEADSBL-400073
AEADSBL-400072
Configuration
Server Type Error/Specified server type [%1] does not match the actual server
type [%2]. Please enter the correct server type.
Error
AEADSBL-400071
Invalid Session Name/Invalid session name specified for [%1]. Please make sure
the session name contains only alphanumeric characters only.
Error
AEADSBL-400062
Configuration
Resolution
Invalid Selection/Invalid selection for [%1]. The selected endpoint must contain
alphanumeric characters only. Please select an endpoint with a valid name.
Error
AEADSBL-400061
Category
Configuration
Error During Delete: Read-Only File/The resource [%1] could not be deleted.
Delete requires that [%2] must be checked out. Please checkout the resource and
try deleting again. You can select the resource to be checked out by clicking the
Go To Resource button.
Error
Configuration
Role
AEADSBL-400074
Error During Paste: Read-Only File/The resource [%1] could not be pasted.
Paste requires that [%2] must be checked out. Please checkout the resource and
try copy/paste again. You can select the resource to be checked out by clicking the
Go To Resource button.
Error
AEADSBL-400075
Configuration
Configuration
Configuration
%1
Information
AESEBL-990014
Configuration
Warning: Add File to RCS/[%1] was created during schema generation. Please
ensure that this resource is added to RCS and checked in. You can select the
resource to be checked out by clicking the Go To Resource button.
Warning
AESEBL-990006
Error During Rename: Read-Only File/The resource [%1] could not be renamed.
Rename requires that [%2] must be checked out. Please checkout the resource
and try renaming again.You can select the resource to be checked out by clicking
the Go To Resource button.
Error
AEADSBL-400077
Configuration
Resolution
Error During Move: Read-Only File/The resource [%1] could not be moved.
Move requires that [%2] must be checked out. Please checkout the resource and
try moving again.You can select the resource to be checked out by clicking the Go
To Resource button.
Error
AEADSBL-400076
Category
Configuration
238
| Appendix A
Trace Messages
Role
AESEBL-990015
AESEBL-990016
Adapter
System
System
Configuration
AESEBL-990035
AESEBL-990034
System
AESEBL-990031
AESEBL-990030
System
AESEBL-990029
AESEBL-990018
Adapter
Resolution
AESEBL-990017
Category
Adapter
Adapter
Role
AESEBL-990036
AESEBL-990037
System
Adapter
Configuration
Adapter
Field %1 is %2.
Warning
AESEBL-990066
AESEBL-990065
Configuration
AESEBL-990064
AESEBL-990062
Adapter
AESEBL-990059
Application Ready.
Information
AESEBL-990039
Adapter
Resolution
AESEBL-990038
Category
Adapter
Adapter
240
| Appendix A
Trace Messages
Role
AESEBL-990068
%1.
Error
AESEBL-990069
Configuration
System
Configuration
Configuration
AESEBL-990075
AESEBL-990074
System
AESEBL-990073
AESEBL-990072
Adapter
AESEBL-990071
Resolution
AESEBL-990070
Category
Configuration
Siebel Business Event tag %1 not defined for event %2. No message published
for this event.
Error
Configuration
Role
AESEBL-990076
AESEBL-990077
Configuration
Configuration
Adapter
Two instances of the adapter have been started with the same CM session name.
Error
AESEBL-990083
System
Error in initializing the configured HTTP Port. Outbound scenarios will fail to
work.
Error
AESEBL-990082
AESEBL-990081
Configuration
AESEBL-990080
Out of memory
Error
AESEBL-990079
Configuration
Resolution
AESEBL-990078
Category
Configuration
Error in initializing the configured HTTP Port. Outbound scenarios will fail to
work.
Error
Adapter
242
| Appendix A
Trace Messages
Role
AESEBL-990089
AESEBL-990090
Adapter
Adapter
Configuration
Adapter
AESEBL-990098
AESEBL-990097
Adapter
AESEBL-990096
AESEBL-990095
Configuration
AESEBL-990094
AESEBL-990092
Adapter
Resolution
AESEBL-990091
Category
Adapter
Adapter
Role
AESEBL-990099
AESEBL-990100
Adapter
Adapter
Adapter
Adapter
AESEBL-990107
AESEBL-990106
Adapter
AESEBL-990105
AESEBL-990104
Adapter
AESEBL-990103
AESEBL-990102
Adapter
Resolution
AESEBL-990101
Category
Adapter
Adapter
244
| Appendix A
Trace Messages
Role
AESEBL-990108
AESEBL-990109
Application
Adapter
Configuration
AESEBL-990119
Application
Siebel Business Event tree nesting hierarchy too deep. Not supported.
Error
AESEBL-990118
AESEBL-990117
Application
AESEBL-990116
AESEBL-990115
Adapter
Resolution
AESEBL-990110
Category
Configuration
Configuration
Role
AESEBL-990120
AESEBL-990121
Configuration
Adapter
Adapter
Adapter
AESEBL-990128
AESEBL-990127
Adapter
AESEBL-990126
AESEBL-990125
Adapter
The activation (like match condition) for %1 is not specified in the configuration.
Error
AESEBL-990124
AESEBL-990123
Adapter
Resolution
AESEBL-990122
Category
Adapter
Configuration
246
| Appendix A
Trace Messages
Role
AESEBL-990129
AESEBL-990130
Adapter
Adapter
Please check that all the key fields have been given
valid values in the message.
Configuration
Adapter
AESEBL-990137
AESEBL-990136
Adapter
AESEBL-990135
AESEBL-990134
Adapter
AESEBL-990133
AESEBL-990132
Adapter
Resolution
AESEBL-990131
Category
Adapter
Adapter
Role
AESEBL-990138
Filter criteria for %1 is empty or contains wild card(s). Attribute %2 with value
%3 is empty or contains wild card(s).
Error
AESEBL-990139
Adapter
Adapter
AESEBL-990143
Adapter
Delete is not allowed for %1 event. %2 property for event %3 is set to true.
Error
AESEBL-990142
Update is not allowed for %1 event. %2 property for event %3 is set to true.
Error
AESEBL-990141
Adapter
Resolution
Insert is not allowed for %1 event. %2 property for event %3 is set to true.
Error
AESEBL-990140
Category
Adapter
Possible conflicting configuration detected for %1. Retrieval of child object may
have reset the %2 objects recordset. The parent child relationship defined in the
configuration could be in reverse to the relationship semantics as defined in
Siebel.'
Error
Adapter
248
| Appendix A
Trace Messages
Role
AESEBL-990144
Failed to retrieve value for match property field %1. Source field %2 for %3 not
found in the incoming message.
Error
AESEBL-990145
Adapter
Adapter
Application
Incoming request does not contain business object and/or Business Component
name.
Error
AESEBL-990150
AESEBL-990149
Adapter
AESEBL-990148
AESEBL-990147
Adapter
Resolution
AESEBL-990146
Category
Adapter
Adapter
Role
AESEBL-990151
AESEBL-990152
Adapter
Adapter
AESEBL-990156
Adapter
AESEBL-990155
AESEBL-990154
Adapter
Resolution
AESEBL-990153
Category
Adapter
Adapter
250
| Appendix A
Trace Messages
Role
AESEBL-990157
AESEBL-990159
Configuration
Adapter
Configuration
AESEBL-910005
Adapter
AESEBL-910004
AESEBL-910003
Application
AESEBL-990165
AESEBL-990161
Adapter
Resolution
AESEBL-990160
Category
Configuration
Configuration
Role
AESEBL-990168
AESEBL-990173
Configuration
Configuration
Adapter
AESEBL-990182
AESEBL-990181
Adapter
AESEBL-990178
AESEBL-990176
Adapter
Resolution
AESEBL-990175
Category
Configuration
Configuration
252
| Appendix A
Trace Messages
Role
AESEBL-990183
AESEBL-990184
System
System
Adapter
Adapter
AESEBL-990192
AESEBL-990191
Configuration
AESEBL-990190
AESEBL-990189
Configuration
AESEBL-990188
AESEBL-990186
Configuration
Resolution
AESEBL-990185
Category
Adapter
Adapter
Role
AESEBL-990193
AESEBL-990194
Adapter
Adapter
Adapter
Adapter
AESEBL-990202
Unsupported object type %1 for %2. Match property value not added for this
rule.
Warning
AESEBL-990199
Adapter
AESEBL-990198
AESEBL-990197
Adapter
AESEBL-990196
Resolution
%1
Warning
AESEBL-990195
Category
Adapter
Configuration
254
| Appendix A
Trace Messages
Role
AESEBL-920001
AESEBL-920003
Adapter
Resolution
AESEBL-920004
Category
Adapter
Adapter
Role
AESEBL-920002
AESEBL-920007
Adapter
AESEBL-920013
Adapter
Resolution
AESEBL-920012
Category
Adapter
Adapter
256
| Appendix A
Trace Messages
Role
AESEBL-920017
AESEBL-920018
System
Adapter
AESEBL-990002
Adapter
AESEBL-990206
[Adapter specific context = %1] Running out of memory when trying to create a
new object. Shutting down...
Error
AESEBL-990205
Adapter
Resolution
AESEBL-990204
Category
Adapter
Adapter
Role
AESEBL-940001
AESEBL-940004
Adapter
AESEBL-940009
Adapter
Resolution
AESEBL-940006
Category
Adapter
Adapter
258
| Appendix A
Trace Messages
Role
AESEBL-940010
AESEBL-940011
Adapter
AESEBL-930007
Adapter
Resolution
AESEBL-930004
Category
Adapter
Adapter
Role
AESEBL-930014
AESEBL-930008
Adapter
Resolution
AESEBL-950001
Category
Adapter
Adapter
260
| Appendix A
Trace Messages
Role
AESEBL-950002
AESEBL-950003
Adapter
AESEBL-910007
Adapter
Resolution
AESEBL-950004
Category
Adapter
Adapter
Role
AESEBL-910008
Unable to create required number of connections with the target application %1,
Connection pool size is %2. Created connections is %3.
Error
AESEBL-990005
Adapter
Adapter
Adapter
AESEBL-990208
Adapter
AESEBL-910015
AESEBL-910014
Adapter
AESEBL-910013
AESEBL-910006
Adapter
Resolution
AESEBL-990207
Category
Adapter
Adapter
262
| Appendix A
Trace Messages
Role
AESEBL-990209
AESEBL-990210
Adapter
Adapter
Adapter
AESEBL-920014
AESEBL-940008
Adapter
AESEBL-990213
Failed to reconnect to the target application. Please check the Siebel Server and
database connectivity and restart the adapter. Application Stopped...
Error
AESEBL-990212
Adapter
Resolution
AESEBL-990211
Category
Adapter
Adapter
Role
AESEBL-940003
AESEBL-940002
Adapter
Adapter
Error in initializing the configured HTTPS Port. Outbound scenarios will fail to
work.
Information
AESEBL-990224
AESBL-990083
Adapter
Resolution
AESEBL-950011
Category
Adapter
Adapter
264
| Appendix A
Trace Messages
Role
AESEBL-990225
AESEBL-990825
Adapter
Adapter
AESEBL-910007
Adapter
AESEBL-990825
AESEBL-990225
Adapter
Resolution
AESEBL-990224
Category
Adapter
Startup Error. Unable to create a connection with the target application Siebel
Server using connection parameters: userid = sadmin, Connect String =
siebel.tcpip.none.zlib://kangchenjunga/entr/SCCObjMgr_enu/, Language
parameter = enu, application error: Could not open a session in 4 attempts. {1}.
Error
Adapter
Description
Role
Category
Resolution
ADSBL000755
Error
Configuration
ADSBL000755
Error
Configuration
ADSBL000755
Error
Configuration
266
| Appendix A
Trace Messages
| 267
Appendix B
Troubleshooting
Topics
Improper Results While Querying for a Child Integration Component, page 269
Unable to Pass Input Data Through Application Context While Using Siebel
Workflow, page 271
Unable to Detect the Query Condition Added to the Sublevels, page 272
The Adapter Hangs When Deployed Using TIBCO Administrator, page 274
Unable to invoke the Workflow with the Integration Object, page 275
268
| Appendix B
Troubleshooting
270
| Appendix B
Troubleshooting
Unable to Pass Input Data Through Application Context While Using Siebel Workflow 271
272
| Appendix B
Troubleshooting
The same error is displayed after deleting the adapter configuration and recreating it.
Probable Cause
This problem occurs when the repository is corrupt due to an improper deletion or change.
The error is thrown when the delivery node entry for the services configured is deleted.
Solution
Create the adapter service once again.
274
| Appendix B
Troubleshooting
Probable Cause
The reply is named SiebelMessage. If you look for a different property set name in the reply,
the particular error might be thrown.
Solution
Look for the appropriate property set.
276
| Appendix B
Troubleshooting
Solution
It is recommended that filtering of data must use other TIBCO products like TIBCO
BusinessWorks. However, filtering can be achieved using the adapter by configuring the
search specifications for a Business Component field. It should be done in the same way
as while using a Siebel Client. For example, if you have a simple query with an OR
condition, you can add this string in the literal match for the Business Component field.
_Eval(" [C1] = "xxx" or C2 = "yyy" ")
where C2 is the Business Component field for which the search parameter is added and C1
is another Business Component field.
Refer Siebel documentation for more details.
Go to Adapter_Instance\Advanced\Sessions\RVCMQSessionName.
Change the Complete Time value to a value greater than 0, for example 15 or 20,
depending on the requirement. Note that this parameter should not be negative.
Use any one of the following combinations for successful processing on reconnection:
Subscribers of type Distributed Queue, Complete Time parameter set to a value other
than 0. The Publisher can be configured to use any kind of transport.
Subscribers of type Reliable, Publisher can be configured to use any kind of transport.
278
| Appendix B
Troubleshooting
| 279
Appendix C
Siebel Workflow
Siebel Workflow is an interactive software tool that allows you to automate the Workflow
Processes in your organization. This appendix explains how to use Siebel Workflow.
Topics
280
| Appendix C
Siebel Workflow
Overview
Siebel Workflow is an interactive software tool that allows you to automate the workflow
process in your organization. Siebel Workflow allows you to define various business
processes in your company. Using Workflow processes, you can define a process that
consists of one or more process steps such as start steps, decision points, business services,
sub-processes, and tasks.
A task can be a Predefined Business Service or a Custom Business Service. Predefined
tasks include updates to the Siebel database, notifications (such as an E-mail or page),
integration messages to external systems, and calls to invoke server tasks. Custom tasks
can be defined by using Siebel VB or Siebel eScript.
The Workflow Process module consists of a series of views to design the flow of a process
and to design each step in the process, as shown in Figure 81.
Figure 81 Sample Screen of a Workflow Process
Workflow processes can vary from a simple process such as entering a product order to a
complex process such as managing call center workflow. Complex processes can
comprise multiple smaller processes.
A Workflow process can be created and maintained using the Siebel Workflow Designer, a
graphical tool which can be accessed using the Siebel Web Client.
A single Workflow process can be used with different Business Components and
Integration Objects.
282
| Appendix C
Siebel Workflow
Get State
This method checks the availability of the adapter and reports the result. This
method can be used before invoking the adapter for actual processing.
Send
The Send method is used to send the Publication request to the adapter.
Get State
This method checks the availability of the adapter and reports the result. This
method can be used before invoking the adapter for actual processing.
SendReceive
The SendReceive method can be used to send the Publication request to the
adapter and get a reply.
TIBCO Send Business Event Publication Request with Reply - This sample workflow
invokes the Request-Response Invocation service methods GetState and SendReceive of
the EAI TIBCO HTTP Agent Business service to generate a Publication request on
the Siebel Server and receive reply in the form of Siebel property set. The reply
property set is then written to an XML file.
TIBCO Send Business Event Publication Request - This sample workflow is used to
invoke the Publication Service methods such as GetState and Send of the EAI TIBCO
HTTP Agent Business Service to generate a Publication request on the Siebel Server.
Server request
Client Request
284
| Appendix C
Siebel Workflow
2. Right-click the Workflow Process View panel, and from the drop-down menu, select
Import Workflow, as shown in Figure 83.
Figure 83 Import Workflow Process
286
| Appendix C
Siebel Workflow
3. Select the required file, as shown in Figure 84. Then click the Open button to import
the workflow.
Figure 84 Selecting the Required File
4. In the Select Project dialog, select the required project (in this example, Siebel
Workflows-Sample project is selected from the drop-down list), as shown in Figure
85, then click the OK button.
The project Siebel Workflows-Sample should be locked before the import of the
Workflow Process starts.
5. Make necessary changes in the imported workflow, then click the Deploy button, as
shown in Figure 86.
Figure 86 Deploy the Workflow Process
288
| Appendix C
Siebel Workflow
6. The status of the newly imported workflow process, TIBCO Sample Workflow
Invocation from Subscriber, indicates Completed.
7. The newly imported workflow process, TIBCO Sample Worfklow Invocation from
Subscriber, has to be compiled, as shown in Figure 87.
The Siebel server should be stopped to complete this operation.
8. Select the Selected Projects radio button. Select the Siebel Worklow - Sample
project, as shown in Figure 88. Select the Siebel Server repository (.srf) file and start
the compile process.
Figure 88 Compile the Siebel Workflow - Sample Project
10. In the Active Workflow Processes view, query for the imported workflow. The
Deployment Status column is shown as Active for the imported workflow processes.
Figure 90 Active Workflow Processes
290
| Appendix C
Siebel Workflow
| 291
Appendix D
Request-Response Operations
Topics
292
| Appendix D
Request-Response Operations
Introduction
The adapter supports Request-Response operations commonly referred to as RPCs.
Request-response operations allow client applications to perform operation invocations.
The following operations are available:
getEvent()
setEvent()
processEvent()
The client applications that wish to perform Request-Response must make sure they are
configured with the right subject in order to communicate with the right server.
Each operation is discussed in the following sections.
Purpose
The getEvent() operation is used to retrieve data related to the occurrence of a Business
Event. This is basically the same as a publication request from the Business Service
component. However, the resulting Business Document is not published, but it is returned
to the requestor.
Declaration
i4 getEvent(businessEvent businessDoc,
aeAdvisoryDocument advisoryDoc)
Parameters
Table 72 getEvent() Operation
Parameter
Direction
Description
businessDoc
In Out
advisoryDoc
Out
Remarks
The businessDoc parameter is a class instance derived from the businessEvent class, which is
defined under the
/tibco/public/class/ae/siebel/tdschema/businessDocument directory.
294
| Appendix D
Request-Response Operations
Each business event class in an adapter configuration supports the AE Operation getEvent
and the businessDoc parameter is a class instance of the business event class.
For example:
If the business event class in adapter configuration is called PubAccountTest, then the
parameter would be defined under
businessDoc
/tibco/public/class/ae/siebel/<adapter instance>/businessDocument/PubAccountTest
under
An exception will be raised on error and an instance of aeAdvisoryDocument that contains the
error information will be returned. When the operation is successful aeAdvisoryDocument is
not set.
This operation is supported by the adapter. Client applications that wish to invoke this
operation must make sure it is configured to communicate with the adapter. The adapter
service ServerGetAccountContact in rpcservices.dat provided with the installation demonstrates this
method.
When the adapter cannot be reached or the subject name of the adapter is incorrectly
configured, a timeout occurs.
Purpose
The setEvent() operation is used to apply data contained in a Business Document to the
Siebel System. This is basically the same as the adapter receiving an incoming business
document and applying the contents to Siebel. However, a processing result is returned to
indicate whether the supplied business document was applied successfully or not.
Declaration
i4 setEvent( businessEvent businessDoc,
aeAdvisoryDocument advisoryDoc)
Parameters
Table 73 setEvent() Operations
Parameter
Direction
Description
businessDoc
In
advisoryDoc
Out
Remarks
The businessDoc parameter must be a class instance derived from class businessEvent, which is
defined under /tibco/public/class/ae/siebel/tdschema/businessDocument. An exception will be returned,
if it is any other class type.
Each business event class in adapter configuration supports the AE Operation setEvent and
the businessDoc parameter is a class instance of the business event class.
For example:
If the business event class in adapter configuration is called SubAccountTest then the
parameter would be defined under
businessDoc
296
| Appendix D
Request-Response Operations
/tibco/public/class/ae/siebel/<adapter instance>/businessDocument/SubAccountTest
And the operation definition for setEvent AE Operation would be defined under
/tibco/public/class/ae/siebel/<adapter instance>/businessDocument/operation/SubAccountTest
An exception will be raised on error and an instance of aeAdvisoryDocument that contains the
error information will be returned. When the operation is successful aeAdvisoryDocument is
not set.
This operation is supported by the adapter. Client applications that wish to invoke this
operation must make sure it is configured to communicate with the adapter. The adapter
service ServerSetAccountContact in rpcservices.dat provided with the installation demonstrates this
method.
When the adapter cannot be reached or the subject name of the adapter is incorrectly
configured a timeout occurs.
Purpose
The processEvent() operation is used to get data from any external AE Operation server that
has implemented the processEvent() AE Operation and return the data to the SendReceive()
Business Service. This operation is not implemented by the adapter but it invokes
processEvent() AE Operation as a client.
Declaration
i4 processEvent(businessEvent businessDoc,
aeAdvisoryDocument advisoryDoc)
Parameters
Table 74 processEvent() Client Parameters
Parameter
Direction
Description
businessDoc
In
The adapter sets this parameter with the business document that was fetched
on the SendReceive() request from the Business Service. The parameter type is
the business event class instance derived from class businessEvent.
advisoryDoc
Out
An advisory document that contains the data returned from the external
source in its Data attribute or describes the error condition when an
exception is raised.
Remarks
The businessDoc parameter is the class instance derived from class businessEvent, which is
defined under
/tibco/public/class/ae/siebel/tdschema/businessDocument.
298
| Appendix D
Request-Response Operations
This class instance business document is fetched by the adapter upon request from the
SendReceive() method of the Business Service.
Each business event class in adapter configuration contains the definition of AE Operation
and the businessDoc parameter is a class instance of the business event class.
processEvent
For example:
If the business event class in adapter configuration is called PubAccountTest then the
parameter would be defined under
businessDoc
/tibco/public/class/ae/siebel/<adapter instance>/businessDocument/PubAccountTest
And the operation definition for processEvent AE Operation would be defined under
/tibco/public/class/ae/siebel/<adapter instance>/businessDocument/operation/PubAccountTest
An exception will be raised on error and an instance of aeAdvisoryDocument that contains the
error information will be returned. When the operation is successful aeAdvisoryDocument will
be set with the data returned from the external source in its Data attribute.
The processEvent() AE Operation should not be invoked on the adapter since the adapter has
not implemented this operation, rather it acts as AE Operation client and invokes the
processEvent() and expects data from any external AE Operation server that has implemented
processEvent().
Error Description
-1
-2
-3
-4
-5
-6
-7
-8
-10
-11
-12
-19
-20
-21
-22
-25
-26
300
| Appendix D
Request-Response Operations
Error Description
-27
-28
No reply received.
-30
-31
-32
-33
-34
-35
-36
-37
-38
Value entered in the field exceeds 100, which is the maximum size.
-39
-40
-42
-43
-44
-45
-46
-49
-51
-52
Unknown event.
-55
Error Description
-65
-70
-71
-73
-74
-75
-76
-77
-78
-79
-100
-101
-102
-103
302
| Appendix D
Request-Response Operations
| 303
Appendix E
Message Formats
This appendix describes message formats for TIBCO Adapter for Siebel.
Topics
304
| Appendix E
Message Formats
ActiveEnterprise Message, TIBCO Rendezvous Message, and TIBCO JMS Message 305
306
| Appendix E
Message Formats
Type
Description
ApplicationContext
any
ApplicationId
string
ApplicationInstanceId
string
ComponentId
string
ConfirmCode
i4
DateTimeStamp
dateTime
Encrypted
boolean
ErrorAddress
string
LotId
string
Name
string
ReferenceId
string
Type
Description
ReplyAddress
string
VerbCode
i4
string
Version
308
| Appendix E
Message Formats
</assoc>
<string name="family" value="ae"/>
<string name="objectType" value="class"/>
</object>
RVMSG_INT
2 ^encoding^ 1
RVMSG_RVMSG 229 ^prefixList^
{
RVMSG_STRING 74 default "/tibco/public/class/ae/siebel/SiebelAdapterConf
RVMSG_STRING 69 1
"/tibco/public/sequence/ae/class/ae/siebel/Siebe
RVMSG_STRING 57 2
"/tibco/public/class/ae/siebel/SiebelAdapterConf
}
RVMSG_RVMSG 44 ^tracking^
{
RVMSG_STRING 28 ^id^ "2Cmzo35fPSFeVk7uPPzzw7pUzzw"
}
RVMSG_RVMSG 2361 ^data^
{
RVMSG_STRING 16 ^class^
"BusCompPubEvent"
RVMSG_RVMSG 2089 BusCompPubEvent^Account
{
RVMSG_INT
4 ^idx^ 1
RVMSG_STRING 34 ^class^ "sequence[BusCompPubEvent^Account]"
RVMSG_RVMSG 81 ^1^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 3 Name
"a*"
RVMSG_STRING 2 Location "*"
}
RVMSG_RVMSG 84 ^2^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 4 Name
"abc"
RVMSG_STRING 4 Location "abc"
}
RVMSG_RVMSG 86 ^3^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 5 Name
"abcd"
RVMSG_STRING 5 Location "abcd"
}
RVMSG_RVMSG 87 ^4^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 5 Name
"abcd"
RVMSG_STRING 6 Location "india"
}
RVMSG_RVMSG 93 ^5^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 7 Name
"ABCXYZ"
RVMSG_STRING 10 Location "Bangalore"
}
RVMSG_RVMSG 88 ^6^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
310
| Appendix E
Message Formats
RVMSG_STRING 5 Name
"ABHI"
RVMSG_STRING 7 Location "ABXBBX"
}
RVMSG_RVMSG 89 ^7^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 10 Name
"abhi12232"
RVMSG_STRING 3 Location "sd"
}
RVMSG_RVMSG 93 ^8^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 8 Name
"ABhi123"
RVMSG_STRING 9 Location "Banglore"
}
RVMSG_RVMSG 93 ^9^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 8 Name
"abhinew"
RVMSG_STRING 9 Location "Banglore"
}
RVMSG_RVMSG 87 ^10^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 7 Name
"alalal"
RVMSG_STRING 4 Location "ggg"
}
RVMSG_RVMSG 87 ^11^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 6 Name
"alksl"
RVMSG_STRING 5 Location "ajsh"
}
RVMSG_RVMSG 93 ^12^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 6 Name
"Amit1"
RVMSG_STRING 11 Location "Bangalore1"
}
RVMSG_RVMSG 84 ^13^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 7 Name
"aparna"
RVMSG_STRING 1 Location ""
}
RVMSG_RVMSG 89 ^14^
{
RVMSG_INT 4 ^idx^ 2
RVMSG_STRING 24 ^class^ "BusCompPubEvent^Account"
RVMSG_STRING 7 Name
"aparna"
VerbCode
4
27 ApplicationInstanceId "SiebelAdapterConfiguration"
28 ReferenceId
"0D01aMs/PSFeVkl4kMzzw7t-zzw"
27 ComponentId
"SiebelAdapterConfiguration"
16 Name
"BusCompPubEvent"
312
| Appendix E
Message Formats
RVMSG_INT
4 Version
3
RVMSG_STRING 1 ApplicationId
""
}
}
Type
Description
Analysis
string
ApplicationContext
any
ApplicationId
string
ApplicationInstanceId
string
Class
string
Data
any
DateTimeStamp
dateTime
The date and time of this message. This is in the following format:
DDD MMM DD HH:MM:SS YYYY.
Description
string
Name
string
ReferenceId
string
Severity
i4
Information.
2:
Warning.
3:
Error.
4:
Fatal.
314
| Appendix E
Message Formats
Type
Description
SiebelHeader
sequence
A set of key and value pairs which can be passed to the adapter and
used as the attributes of Siebel Header element. Refer to Adding
Customer Attributes to Siebel Header Element on page 135 for
details.
TibcoAppError
MClass
Subject
string
The subject name of the original data that triggered the advisory.
Version
i4
The following is an example message output captured with the utility aelisten.
ALERT.SERVER.PUBLISHER
{
RVMSG_INT
2 ^type^
1
RVMSG_INT
2 ^pfmt^
10
RVMSG_INT
2 ^ver^
30
RVMSG_RVMSG 55 ^prefixList^
{
RVMSG_STRING 36 default "/tibco/public/class/ae/baseDocument"
}
RVMSG_RVMSG 350 ^data^
{
RVMSG_STRING 19 ^class^
"aeAdvisoryDocument"
RVMSG_STRING 19 Class
"Status Information"
RVMSG_INT
4 Version
3
RVMSG_STRING 12 ApplicationInstanceId "1268@ben_nb"
RVMSG_STRING 30 ReferenceId
"33c--C--CQdTh-uQ-//Ic4I2x-KgQ"
RVMSG_STRING 1 Analysis
""
RVMSG_DATETIME 12 DateTimeStamp
21-SEP-2000 19:26:50
RVMSG_STRING 16 Name
"Event Execution"
RVMSG_STRING 61 Description
"[ERR ] No records found for 'NewOrder^Order Entry - Orders'."
RVMSG_INT
4 Severity
3
RVMSG_STRING 16 ApplicationId
"serverPublisher"
}
316
| Appendix E
Message Formats
| 317
Appendix F
Topics
318
| Appendix F
Overview
Siebel Integration Objects allow you to represent integration metadata for Siebel Business
Objects, XML, SAP IDOCs, and SAP BAPIs as common structures that the EAI
infrastructure can understand. Because these Integration Objects adhere to a set of
structural conventions, they can be traversed and transformed as required.
The typical integration project involves transporting data from one application to another.
For example, you may want to synchronize data from a back-office system with the data in
your Siebel application. You may want to generate a quote in the Siebel application and
perform a query against your Enterprise Resource Planning (ERP) system transparently.
A message typically consists of header data that identifies the message type and structure,
and a body that contains one or more instances of data, for example, orders, accounts, or
employee records. A typical message structure for the integration object, Sample Account is as
follows:
<Siebel Message IntObjectName=Sample Account>
<ListOfSample Account>
<Account>
<Name>John<\Name>
<Location>Palo Alto<\Location>
<\Account>
<\ListOfSample Account>
<\Siebel Message>
The adapter schema structure for the integration object is based on the above message.
Any operation using Integration Objects is transactional. That is to say either the
whole operation succeeds or the entire operation fails.
The following are limitations when working with Picklist business components and
configuring the adapter to work with Business Components: (These limitations do not
exist with integration objects.)
The adapter does not update the Unbounded Picklist fields if the value in the
incoming message is not part of the preconfigured options for the Picklist.
The adapter does not update Constraint Picklist fields.
The adapter does not update Picklist fields in a specific order. This can cause
problems where Picklist values are dynamic and depend on the value in another
Picklist field.
When data for a Picklist field fetches multiple rows, the adapter will be unable to
update the field with any value.
Siebel supports methods to fetch Integration Object Query Results by page. This
allows a form of data chunking where large messages can be split into multiple
smaller messages.
Integration objects support Associations and setting of the primary with ease.
Ability to specify multiple user keys for an integration component. For example, the
first message might contain an Integration ID for the Account Integration Component.
This is used as the key to locate a unique record. The second message may contain
Account Name and Location, these are then used as the key fields to locate a unique
record. Multiple user keys may be defined for an Integration Component. This
definition is possible in Siebel Tools. A Business Components configuration means
that you will need to create different Business Events for each key option.
320
| Appendix F
322
| Appendix F
User Keys
User Key is a group of fields whose values must uniquely identify a Siebel Business
Component record. During inbound integration, User Keys are used to determine whether
the incoming data updates an existing record or inserts a new one.
In Siebel Tools, the Integration Component Key specifies which of the integration
component fields should be used for a user key. In Siebel Tools, you can look up this
information yourself before configuring the schema in the designer. Based on the User
Keys you have to choose the fields. The user key fields that you wish to use must be
configured in the schema. Before choosing the user key make sure that the user key is
valid and enabled.
- SiebelMessage
KeyValue:
The adapter in this case recognizes the event and does not query the Siebel data base.
Instead, it makes an ae message out of the incoming request KeyValue (Integration Object
Instance) and sends the request to the external application. The reply in this case can be an
integration object, which is sent back to Siebel.
324
| Appendix F
| 331
Index
adapter
component (operation) information through TIBCO
Hawk 205
Adapter Name 205, 206, 210, 212, 214, 215
Adapter Request-Response Server 8
adapter software development toolkit 310
Adapter Subscriber 8, 8
Adapter Tester, Starting 22
Adapter, Starting 120
Adapter, Stopping 120
Adatper, Command line, Starting 22
ADSBL_HOME xxiii
Advisory Document 319
attributes 319
AE xxvi
aeRvMsg 310
example output 315
agents 190
alerts 190
API xxvi
Attribute Name 207
Attribute Value 207
auto-discovery process, TIBCO Hawk 192
Certified 82
Certified Name 210
changes from the previous release xx
Class Microagent Name field, adapter 47
CM Timeout 211
COM xxvi
Command 206
command-line arguments 206
command-line options 139
Component Name 205
Component Type 205
configuration properties, retrieving through TIBCO
Hawk 206
Configuration URL 206
Configuring Non-Siebel Business Component 95
converting project to repository file 22
customer support xxviii
D
Daemon 210
Description 205
Distributed Queue 82
Durable 84
B
Business Component 90
Business Component Configuration 86
Business Event Schema 60, 67, 73, 79, 92, 102
Business Object 90
E
Element Name 207
ENV_HOME xxiii
332
| Index
F
G
GetSubTotalBy 201
global variables 126, 126
using 126
GUI xxvi
M
H
Hawk methods
preRegisterListener() 217
Host 212
HTTP Listener xxvii
I
Inbound xxvi
Instance ID 205, 206, 210, 212, 214, 215
Integration Component 99
Invoke an Adapter Request-Response Server 8
Match Field 93
MaxQueueSize 209
MeasurementInterva 202
MeasurementInterval 201, 203, 209, 213
message format
non-AE 310
Messages Received 212
Messages Sent 212
microagent methods supported 197, 197
Microagent Session field, adapter 47
Multi-Value Field xxvi
Multi-Value Links xxvi
MVF xxvi
MVG 91
MVL xxvi
MVL Field 91
J
JMS xxvi
K
Key 93
N
Name 201
Network 210
New Errors 212
non-AE message format 310
Non-durable 84
Non-persistent 83
Index 333
O
Object Manager xxvii
Operation 202, 202, 203
Outbound xxvi
P
parameters
design-time connection 29
logging 42
startup 45
Persistent 83
Pick List 91
PollingInterval 227, 228
preRegisterListener()
Hawk method 217
Prerequisites 14
Process ID 212
Property 207
Publication Service 54
Publisher Name 217, 224
publish-subscribe 83
Q
QOS xxvi
Queue 83
QueueCount 209
QueueID 209
QueueType 209
R
Reliable 82
Repository Connection 206
repository file 22
Repository Name 26
Request 8
S
Schema Name 203
Service 210
Service Name 202, 203, 203
ServiceName 228
Session Name 205, 210, 210, 217, 220, 220, 224
Session Type 210
Setting 226
setting global variables 126
setTraceSink() 199
Show Startup Banner 45
Siebel
Repository Data Model 26
Siebel Adapter Configuration 27
Siebel Fields Tab 90
Siebel Integration Fields Tab 99
Siebel Workflow xxvii
Sink Name 214, 214, 222
Sink Type 214
Standard Microagent Name field, adapter 46
Startup Tab 124
Subject 220, 220
Subscription Service 54
Subscription Service Configuration 109
substitution 126
Success 201, 202, 203
support, contacting xxviii
Synchronous? 210
334
| Index
T
tabs
Configuration 56, 62, 67, 74, 80
Monitoring 46
Startup 45
TaskCount 213
TaskType 213
technical support xxviii
Terminology and Acronyms xxvi
Third-Party Documentation xxii
ThreadID 213
ThreadType 213
TIBCO ActiveMatrix BusinessWorks 2
TIBCO Adapter SDK 310
TIBCO Designer 2
TIBCO Hawk
enterprise monitor components 190, 190
Monitoring tab use with 124
TIBCO Hawk methods
getComponents 205
getConfig 206
getRvConfig 210
getStatus 212
reviewLedger 220
TIBCO Hawk Session 124
TIBCO Rendezvous, retrieving configuration through
TIBCO Hawk 210
TIBCO_HOME xxiii
Topic 83, 83, 83
Total 201, 202, 203
Total Errors 212
Total Messages 220
Total Size 220
Tracing Levels and Fields 232, 232
Typographical Conventions
general xxiii
syntax xxiv
Uptime 212
Use Design-Time Connections 31
V
variable substitution 126
variables 126
variables, global 126
Version 215
VPD xxvi
W
W3C xxvi
U
UAN xxvi
UnacknowledgedMessages 221
TIBCO ActiveMatrix Adapter for Siebel Configuration and Deployment