Adapter for Siebel eBusiness Applications User Guide · PDF fileIBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Version 42. .x

IBM WebSphere Business Integration Adapters

Adapter for Siebel eBusiness ApplicationsUser GuideVersion 4.2.x

��

IBM WebSphere Business Integration Adapters

Adapter for Siebel eBusiness ApplicationsUser GuideVersion 4.2.x

��

Note!Before using this information and the product it supports, read the information in “Notices” on page 105.

18April2003

This edition of this document applies to connector version 4.2.x, and to all subsequent releases and modificationsuntil otherwise indicated in new editions.

To send us your comments about this document, email [email protected]. We look forward to hearingfrom you.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in anyway it believes appropriate without incurring any obligation to you.

© Copyright International Business Machines Corporation 1997, 2003. All rights reserved.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Integration broker compatibility

Supported on IBM WebSphere Business Integration Adapter Framework version2.2.0, IBM CrossWorlds Infrastructure version 4.1.1 and 4.2, WebSphere MQIntegrator version 2.1.0, and WebSphere MQ Integrator Broker, version 2.1.0. SeeRelease Notes for any exceptions.

© Copyright IBM Corp. 1997, 2003 iii

iv Adapter for Siebel eBusiness Applications User Guide

Contents

Integration broker compatibility . . . . . . . . . . . . . . . . . . . . . . . . . iii

About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiAudience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiRelated documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viiTypographic conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii

New in this release. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixNew in release 4.2.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixNew in release 4.1.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixNew in release 4.0.x. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Chapter 1. Overview of the connector . . . . . . . . . . . . . . . . . . . . . . . 1Definition of the connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Siebel application architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1Connector architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2How the connector works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2. Installing and configuring the connector . . . . . . . . . . . . . . . . . 9Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Installing the connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Configuring the connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15Connector startup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 3. Understanding business objects . . . . . . . . . . . . . . . . . . . . 19Business object structure and relationships . . . . . . . . . . . . . . . . . . . . . . . . . 19Business object application-specific information . . . . . . . . . . . . . . . . . . . . . . . 21Using business object samples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Chapter 4. Generating business object definitions using SiebelODA . . . . . . . . . 35Installation and usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35Using SiebelODA in Business Object Designer . . . . . . . . . . . . . . . . . . . . . . . . 37Contents of the generated definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Adding information to the business object definition . . . . . . . . . . . . . . . . . . . . . 49

Chapter 5. Using the Siebel connectivity DLL . . . . . . . . . . . . . . . . . . . 51Connector architecture and processes . . . . . . . . . . . . . . . . . . . . . . . . . . . 51Configuring the Siebel connectivity DLL. . . . . . . . . . . . . . . . . . . . . . . . . . 53Communicating with the Siebel connectivity DLL . . . . . . . . . . . . . . . . . . . . . . 55Generating WBIA business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55Configuring the IBM generic business services. . . . . . . . . . . . . . . . . . . . . . . . 56

Chapter 6. Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . 59MAX_LOG_FILE_SIZE error on UNIX . . . . . . . . . . . . . . . . . . . . . . . . . . 59Handling errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Appendix A. Standard configuration properties for connectors . . . . . . . . . . . 61New and deleted properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61Configuring standard connector properties for WebSphere InterChange Server . . . . . . . . . . . . . 62Configuring standard connector properties for WebSphere MQ Integrator . . . . . . . . . . . . . . 74

Appendix B. Connector Configurator . . . . . . . . . . . . . . . . . . . . . . . 83Using Connector Configurator in an internationalized environment. . . . . . . . . . . . . . . . . 83

© Copyright IBM Corp. 1997, 2003 v

Starting Connector Configurator . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Choosing your broker . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Using a connector-specific property template . . . . . . . . . . . . . . . . . . . . . . . . 86Using Connector Configurator with ICS as the broker . . . . . . . . . . . . . . . . . . . . . 89Setting the configuration file properties (ICS) . . . . . . . . . . . . . . . . . . . . . . . . 91Setting the configuration file properties (WebSphere MQ Integrator Broker) . . . . . . . . . . . . . . 96Using standard and connector-specific properties with Connector Configurator. . . . . . . . . . . . . 99Completing the configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Appendix C. Connector feature list . . . . . . . . . . . . . . . . . . . . . . . 101Business object request handling features . . . . . . . . . . . . . . . . . . . . . . . . . 101Event notification features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101General features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105Programming interface information . . . . . . . . . . . . . . . . . . . . . . . . . . . 106Trademarks and service marks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

vi Adapter for Siebel eBusiness Applications User Guide

About this document

IBM(R) WebSphere(R) Business Integration Adapters supply integration connectivityfor leading e-business technologies and enterprise applications.

This document describes the installation, configuration, and business objectdevelopment for the adapter for Siebel eBusiness Applications.

AudienceThis document is for WebSphere business integration system consultants andcustomers. To use the information in this document, you should be knowledgeablein the following areas:v Connector developmentv Business object developmentv Siebel application architecturev Siebel Toolsv Visual Basic

Note: If you are a consultant or customer located in Japan and are using Siebel2000, you must use the Adapter for Siebel 2000 User Guide.

Related documentsThe WebSphere business integration system documentation describes the featuresand components common to all installations, and includes reference material onspecific collaborations and connectors.

This document contains many references to two other documents: the SystemInstallation Guide for Windows or for UNIX and the System Implementation Guide forWebSphere InterChange Server. If you choose to print this document, you may wantto print these documents as well.

To access the documentation, go to the directory where you installed the productand open the documentation subdirectory. If a welcome.html file is present, open itfor hyperlinked access to all documentation. If no documentation is present, youcan install it or read it directly online at one of the following sites:v If you are using WebSphere MQ Integrator Broker as your integration broker:

http://www.ibm.com/websphere/integration/wbiadapters/infocenterv If you are using InterChange Server as your integration broker:

http://www.ibm.com/websphere/integration/wicserver/infocenter

The documentation set consists primarily of Portable Document Format (PDF) files,with some additional files in HTML format. To read it, you need an HTMLbrowser such as Netscape Navigator or Internet Explorer, and Adobe AcrobatReader 4.0.5 or higher. For the latest version of Adobe Acrobat Reader for yourplatform, go to the Adobe website (www.adobe.com).

© Copyright IBM Corp. 1997, 2003 vii

http://www.ibm.com/websphere/integration/wbiadapters/infocenter

http://www.ibm.com/websphere/integration/wicserver/infocenter

Siebel virtual business componentsIn addition to the Connector, the WebSphere business integration system includescomponents for implementing Siebel Virtual Business Components (VBCs). See theImplementation Guide for Siebel Virtual Business Components for more information.

Typographic conventionsThis document uses the following conventions:

courier font Indicates a literal value, such as a command name, filename, information that you type, or information that thesystem prints on the screen.

bold Indicates a new term the first time that it appears.italic, italic Indicates a variable name or a cross-reference.blue text Blue text, which is visible only when you view the manual

online, indicates a cross-reference hyperlink. Click any bluetext to jump to the object of the reference.

ProductDir Product family is WBIA: Represents the directory where theIBM WebSphere Business Integration Adapters product isinstalled. The CROSSWORLDS environment variablecontains the ProductDir directory path, which isIBM\WebSphereAdapters by default.

viii Adapter for Siebel eBusiness Applications User Guide

New in this release

New in release 4.2.xUpdated in March, 2003. The “CrossWorlds” name is no longer used to describe anentire system or to modify the names of components or tools, which are otherwisemostly the same as before. For example “CrossWorlds System Manager” is now“System Manager,” and “CrossWorlds InterChange Server” is now “WebSphereInterChange Server.”

The changes to this version of the connector support Siebel, version 7.5 and theSiebel connectivity DLL.

New in release 4.1.xThe connector delivered with IBM WebSphere Business Integration Adapter forSiebel eBusiness Applications has been internationalized. For more information, see“Processing locale-dependent data” on page 7 and Appendix A, “Standardconfiguration properties for connectors”, on page 61.

New in release 4.0.xThe IBM WebSphere business integration adapter for Siebel eBusiness Applicationsincludes the connector for Siebel eBusiness Applications. This adapter operateswith both the InterChange Server (ICS) and WebSphere MQ Integrator integrationbrokers. An integration broker, which is an application that performs integration ofheterogeneous sets of applications, provides services that include data routing. Thisadapter includes:v An application-component specific to Siebel eBusiness Applicationsv SiebelODAv Sample business objectsv IBM WebSphere Adapter Framework, which consists of:

– Connector Framework– Development tools (including Business Object Designer and Connector

Configurator)– APIs (including ODK, JCDK, and CDK)

This manual provides information about using this adapter with both integrationbrokers: InterChange Server (ICS) and WebSphere MQ Integrator.

Important: Because the connector has not been internationalized, do not run itagainst InterChange Server version 4.1.1 if you cannot guarantee thatonly ISO Latin-1 data will be processed.

© Copyright IBM Corp. 1997, 2003 ix

x Adapter for Siebel eBusiness Applications User Guide

Chapter 1. Overview of the connector

This chapter provides an overview of the connector component of the WebSphereBusiness Integration Adapter (WBIA) for Siebel eBusiness Applications andcontains the following sections:v “Definition of the connector”v “Siebel application architecture”v “Connector architecture” on page 2v “Business object processing” on page 3v “Event management” on page 5v “Handling lost connections to the Siebel application” on page 7v “Processing locale-dependent data” on page 7

Definition of the connectorConnectors consist of two parts: the connector framework and theapplication-specific component. The connector framework, whose code is commonto all connectors, acts as an intermediary between the integration broker and theapplication-specific component. The application-specific component contains codetailored to a particular application. The connector framework provides thefollowing services between the integration broker and the application-specificcomponent:v Receives and sends business objectsv Manages the exchange of startup and administrative messages

This document contains information about the connector framework and theapplication-specific component, which it refers to as the connector.

The connector component of the adapter provides connectivity to either Siebel 6.2.xor Siebel 7 (English) and only Siebel 7 (Japanese) using the WebSphere BusinessIntegration Adaptor (WBIA) framework and the Siebel eBusiness applicationcomponents.

The connector uses the Java APIs provided by the Siebel Java Data Bean tocommunicate with the Siebel Object Manager for data exchange. Siebel Java DataBean exposes the Siebel business components and business objects, which are partof the business object layer in the Siebel application architecture.

Siebel application architectureThe Siebel application architecture contains three layers, as follows:v User interface objects layer--This layer contains the visual elements that the user

interacts with.v Business objects layer--This layer contains both business components and

business objects. A business component is a fundamental business entity,consisting of multiple fields that represent it. A business object is a collection ofrelated business components. The Siebel connector communicates with this layerusing the Siebel Java Data Bean.

© Copyright IBM Corp. 1997, 2003 1

v Data objects layer--This layer contains the object definitions which providelogical representation of the underlying physical database. It is independent ofthe installed relational database management system, and it is not accessible bythe Siebel Java Data Bean.

Connector architectureThe connector has been designed following the meta-data design principles asoutlined in the Connector Development Guide for Java. This means that existingapplication-specific business objects can be extended and customized and newbusiness objects can be defined without requiring additional coding orcustomization in the connector code.

The following diagram illustrates the Siebel connector architecture.

How the connector worksThis section describes how meta-data enhances the connector’s flexibility, andpresents a high-level description of business object processing and eventnotification.

The connector and meta-dataThe connector is meta-data-driven. Meta-data is application-specific data that isstored in business objects and that assists the connector in its interaction with theapplication. A meta-data-driven connector handles each business object that itsupports based on meta-data encoded in the business object definition rather thanon instructions hardcoded in the connector. A business object corresponds to a

CWConnector API

Siebel connector agent

Integration broker

SiebelJavadata bean

User interface

Eventnotification

BOHandler

Siebel enterprise serverSiebel client administration manager

WebSphere InterChange Serverevent and archive store

Siebel business objects

Siebel eBusiness application

Via CW Event andCW Archive usiness

components

" "" " b

Figure 1. Siebel connector architecture

2 Adapter for Siebel eBusiness Applications User Guide

Siebel business component. For more information about business objects, seeChapter 3, “Understanding business objects”, on page 19.

Business object meta-data includes the structure of a business object, the settings ofits attribute properties, and the content of its application-specific information.Because the connector is meta-data driven, it can handle new or modified businessobjects without requiring modifications to the connector code.

Business object processingThis section provides an overview of how the connector processes integrationbroker requests and application events.

Processing integration broker requestsWhen the connector receives a request from a business object to perform anapplication operation, the connector processes hierarchical business objectsrecursively; that is, it performs the same steps for each child business object until ithas processed all individual business objects.

Note: The term hierarchical business object refers to a complete business object,including all the child business objects that it contains at any level. The termindividual business object refers to a single business object, independent ofany child business objects it might contain or that contain it. The termtop-level business object refers to the individual business object at the top ofthe hierarchy that does not itself have a parent business object.

Business object retrieval: When an integration broker asks the connector toretrieve a hierarchical business object from the Siebel application, the connectorattempts to return a business object to the integration broker that exactly matchesthe current representation of a Siebel business component instance. In other words,all simple attributes of each individual business object returned to the integrationbroker match the value of the corresponding field in the Siebel businesscomponents.

To retrieve the complete business component, the connector uses the primary keyvalues in the top-level business object received from the integration broker torecursively descend through the corresponding data in the database.

Business object RetrievalByContent: When an integration broker asks theconnector to retrieve a hierarchical business object based on values in non-keyattributes in the top-level business object, the connector uses the value of allnon-null attributes as the criteria for retrieving the data.

Business object creation: When an integration broker asks the connector to createa hierarchical business object in the Siebel application, the connector creates all thechildren of the top-level business object prior to creating the parent. An exceptionto this rule is when the relationship between the parent and child is a multi-valuelink in Siebel and the link is inactive. In this case, the child is created after theparent, and the keys are generated by the Siebel application.

Business object modification: Business object modification, or updating, involvescomparing the retrieved after image of the business object from Siebel with theinbound business object. The process involves setting the correct verb on the childobjects. If the keys are set on the parent and all other attributes are set to CxIgnore,the parent update is skipped.

Chapter 1. Overview of the connector 3

The default behavior is to compare the after image from the Siebel applicationswith the inbound business object, then change the verbs on the child containerobjects. This process ensures that all the children in the Siebel application are madethe same as the inbound business object. If the verb is not set on the children, thedefault is set to Update.

Important: If some of the children need to be retained, the inbound object verbmust be set to DeltaUpdate, and verbs must be set on each one of thechild container objects. In this case, only these objects in the Siebelapplication are processed while the others are left untouched.

Business object deletion: When an integration broker asks the connector to deletea record, the record is removed from the underlying database. Only the parentneeds to be deleted because the Siebel DeleteCascade feature deletes all of thechildren. If any of the required attributes are missing from the inbound businessobject, the delete fails.

Exists verb: The primary business component name is typically the same businessobject name in Siebel. If the ObjectName and ComponentName application specificinformation match, the keys are set on this business component and the query isexecuted. If the record exists, it returns True; if the record does not exist, it returnsFalse.

Processing application events

Components: The event notification requires the creation of event and archivetables in the Siebel database. You must create CW Event and CW Archive, twonew Siebel business components corresponding to these tables.

Triggering: The creation, update, or delete of any record in the Siebel eBusinessapplication can be treated as an event. Siebel supports Visual Basic scripts andSiebel eScripts embedded in the Siebel business component event handlers topopulate the event table. On a call to pollForEvents, these event records areobtained and processed. The Event business component stores information aboutthe event, as listed in Table 1.

Note: The information in Table 1 is used by the connector during eventsubscription to build corresponding business objects and to send thoseobjects to the connector framework for further processing.

Table 1. Events business component structure

Fields Description

Object Key The unique identifier that identifies the business object row for which theevent was created

Object Name Siebel business object for which the event was deletedObject Verb Verb for the eventPriority Event priority


Table 1. Events business component structure (continued)

Fields Description

Status Event Status Initially, this is set to READY_FOR_POLLOther status valuesinclude:IN_PROGRESS=1 -- The event has been picked up and is sent to theconnector framework. The connector changes the status of the event toIN_PROGRESS after it picks the event for processing. UNSUBSCRIBED=2 -- Theevent has not been subscribed for. The connector sets the status toUNSUBSCRIBED if the isSubscribed call returns a False. SUCCESS=3 -- Theevent was successfully processed by the connector framework. The connector setsthe status to SUCCESS if the event is processed successfully by the connectorframework.ERROR_PROCESSING_EVENT=-1 -- There was an error processingthe event. This status is set if there was an error while processing theevent. ERROR_POSTING_EVENT=-2 -- There was an error posting the event tothe connector framework. This status is set if the call to gotApplEventfails in pollForEvents. ERROR_OBJECT_NOT_FOUND=-3 -- The object forwhich the event was created could not be found. This status is set if thedoVerbFor call could not find the object in pollForEvents.

Description Any comment associated with the eventEvent Id Id of the event rowConnectorId Identifies the connector in a multiple connector configurationEvent Ts Event creation timestamp

Create notification: When the connector encounters a Create event, it creates abusiness object of the type specified by the event, sets the key values for thebusiness object (using the object key specified in the CW Event businesscomponent), and retrieves the business object from the Siebel application. After itretrieves the business object, the connector sends it with the Create verb to theintegration broker.

Update notification: When the connector encounters an Update event, it creates abusiness object of the type specified by the event, sets the key values for thebusiness object (using the object key specified in the CW Event businesscomponent), and retrieves the business object from the database. After it retrievesthe business object, the connector sends it with the Update verb to the integrationbroker.

Delete notification: When the connector encounters a Delete event, it creates abusiness object of the type specified by the event, sets the key values for thebusiness object (using the object key specified in the CW Event businesscomponent), and sends it with the Delete verb to the integration broker. All valuesother than the key values are set to CxIgnore.

Retrieving business objects for event processing: Retrieval of objects for eventprocessing is based on both key and non-key attributes. It is mandatory that thebusiness object support the RetrieveByContent verb.

Event managementThe connector’s event detection mechanism uses a CW Event business componentand a CW Archive business component. Because there are potential failure pointsassociated with the processing of events, the event management process does notdelete an event from the CW Event business component until it has been insertedit into the CW Archive business component.


The connector polls the CW Event business component at a regular, configurableinterval, retrieves the events, and processes the events first by priority and thensequentially. When the connector has processed an event, the event’s status isupdated appropriately.

The setting of its ArchiveProcessed property determines whether the connectorarchives an event into the CW Archive business component after updating itsstatus. For more information on the ArchiveProcessed property, see “Configuringthe connector” on page 15.

Table 2 illustrates the archiving behavior depending on the setting of theArchiveProcessed property.

Table 2. Archiving behavior

Archive processedsetting

Event processing status Connector behavior

true or no value Successful Event is deleted from the CWEvents business component andarchived with status of Success

Unsuccessful Archived with status of ErrorNo subscription for businessobject

Event is deleted from the CWEvents business component andarchived with one of the followingstatuses:Error Processing EventError Posting Event Error ObjectNot Found

false Successful Not archived and remains in theCW Events business componentwith a status of Success

Unsuccessful Event is not archived and remainsin the CW Events businesscomponent with one of thefollowing statuses:ErrorProcessing Event Error PostingEvent Error Object Not Found

No subscription for businessobject

Remains in event table with statusof Unsubscribed

Smart filteringDuplicate events are not saved in the event store. Before storing a new event as arecord in the event store, the VB Script or eScript needs to query the event storefor existing events that match the new event. The event detection mechanism doesnot generate a record for a new event in the following cases:v If the business object name, verb, status, and ConnectorId (if applicable) in a

new event match those of another unprocessed event in the event store.v If the business object name, key, and status for a new event match an

unprocessed event in the event table, and the verb for the new event is Updatewhile the verb for the unprocessed event is Create.

v If the business object name, key, and status for a new event match anunprocessed event in the event table, and the verb in the unprocessed event inthe event table is Create while the new verb is Delete. In this case, remove theCreate record from the event store.


Handling lost connections to the Siebel applicationThe connector terminates when an error message specified in the ConnectErrorsconnector property is detected. The text from ConnectErrors in compared with theSiebel error message. If a match is found, the connector returnsAppResponseTimeOut, which terminates the connector.

The ConnectErrors message can be returned by the Siebel application if theconnection is lost and the connector tries to:v Access the CW Event and CW Archive business componentsv Retrieve the business object that is related to the eventv Create or update a record pertaining to a business object.

Processing locale-dependent dataThe connector has been internationalized so that it can support double-bytecharacter sets, and deliver message text in the specified language. When theconnector transfers data from a location that uses one character code set to alocation that uses a different code set, it performs character conversion to preservethe meaning of the data. The Java runtime environment within the Java VirtualMachine (JVM) represents data in the Unicode character code set. Unicode containsencodings for characters in most known character code sets (both single-byte andmultibyte). Most components in the WebSphere business integration system arewritten in Java. Therefore, when data is transferred between most Server Accesscomponents, there is no need for character conversion. To log error andinformational messages in the appropriate language and for the appropriatecountry or territory, configure the Locale standard configuration property for yourenvironment. For more information on these properties, see Appendix A, “Standardconfiguration properties for connectors”, on page 61.



Chapter 2. Installing and configuring the connector

This chapter describes how to install and configure the connector component of theWebSphere Business Integration Adapter (WBIA) for Siebel eBusiness Applications.The following topics are covered:v “Prerequisites”v “User setup”v “Installing the connector” on page 10v “Event and archive tables” on page 11v “Configuring the connector” on page 15v “Connector startup” on page 18

PrerequisitesBefore you use the connector, you must do the following:v Install the Siebel 6.2.x or Siebel 7 .jar files that will be used.v Verify the existence of a user account in the application.v Copy the Siebel Connector.txt file from the

%ProductDir%/connectors/messages/Siebel directory to the%ProductDir%/connectors/messagesdirectory

User setupBefore installing the connector, you must create a user account for the connector inSiebel. This user account should have full access privileges, and the login nameshould be the same as the ApplicationUserName configuration property. The defaultvalue for the user account login name and password is CWCONN.

When installing the connector, be sure to install the files from one of the followinglists to the %ProductDir%/Connectors/Siebel/dependencies directory. The files arelocated on either Siebel 6 or Siebel 7 server.

Important: The start_Siebel.bat file in the %ProductDir%/Connectors/Siebeldirectory currently has the English and Japanese Siebel .jar files in theJCLASSES variable. This is added to the CLASSPATH. For any otherlanguage supported by Siebel, the corresponding .jar file must beadded to the JCLASSES variable.

Siebel 6

v SiebelDataBean.jarv SiebelTC_enu.jarv SiebelTcCommon.jarv SiebelTcOM.jar

Siebel 7

v SiebelJI_Common.jarv SiebelJI_enu.jar


Installing the connectorThe following subsections describe how to install the connector on a UNIX orWindows system.

After your WebSphere business integration system is installed, you can installadditional adapters from the WebSphere business integration CD at any time. Todo this, insert the WebSphere business integration CD, run the installationprogram, and choose the connectors that you want to install.

Note: Unless otherwise indicated, the remaining sections in this chapter apply toboth UNIX and Windows installations of the connector.

Installing on a UNIX systemTo install the connector on a UNIX system, run the Installer for IBM WebSphereBusiness Integration Adapter and select the IBM WebSphere Business IntegrationAdapter for Siebel eBusiness Applications.

Table 3 describes the UNIX file structure used by the connector.

Table 3. Installed UNIX file structure for the connector

Subdirectory of $ProductDir Description

connectors/Siebel Contains the CWSiebel.jar and thestart_Siebel.sh files for the adapter. The startupscript for the Siebel adapter is called from thegeneric connector manager script. When you clickInstall from the Connector Configurator,WebSphere MQ Integrator Broker as theintegration broker, or the ConnectorConfiguration screen of System Manager (ICS asthe integration broker), the Installer creates acustomized wrapper for this connector managerscript. When the connector works with ICS, usethis customized wrapper to start and stop theconnector. When the connector works withWebSphere MQ Integrator Broker, use thiscustomized wrapper only to start the connector;use mqsiremotestopadapter to stop the connector.

connectors/Siebel/dependencies Contains the patch files for event management inthe Siebel eBusiness application. Should alsocontain the siebel .jar files used by the Siebelconnector.

connectors/messages/Siebel Contains the relevant message file,SiebelConnector.txt. This file must be copied bythe user from theconnectors/messages/Siebel/Java directory.

connectors/messages/Siebel/Java Contains the SiebelConnector.txt file (for Siebel7 Java conn).

connectors/Siebel/Samples/Repository Contains the following BO samples:Siebel_BCAccount Siebel_BCQuoteSiebel_BCContact Siebel_BCInternalProductSiebel_BCAsset

repository/Siebel Contains the CN_Siebel.txt file.

/lib Contains the WBIA. jar file.

/bin Contains the CWConnEnv.sh file.


Installing on a Windows systemTo install the connector on a Windows system, run WebSphere business integrationInstaller and select the connector. WebSphere business integration Installer installsstandard files associated with the connector.

Table 4 describes the Windows file structure used by the connector.

Table 4. Installed Windows file structure for the connector

Subdirectory of %ProductDir% Description

\connectors\Siebel Contains the connector CWSiebel.jar and thestart_Siebel.bat files.

\connectors\Siebel\dependencies Contains the patch files for event managementin the Siebel eBusiness applications. This foldershould also contain the Siebel .jar files.

\connectors\messages Contains the relevant message file,SiebelConnector.txt. This file must be copiedby the user from theconnectors\messages\Siebel\Java directory

\connectors\messages\Siebel\Java Contains the SiebelConnector.txt file as wellas the SiebelConnector_ll_TT.txt files (messagefiles specific to a language (_ll) and a country orterritory (_TT).

\connectors\Siebel\Samples\Repository Contains the following BO samples:Siebel_BCAccount Siebel_BCQuoteSiebel_BCContact Siebel_BCInternalProductSiebel_BCAsset

\repository\Siebel\ Contains the CN_Siebel.txt file.

\lib Contains the WBIA. jar file.

\bin Contains the CWConnEnv.bat file.

Installer adds an icon for the connector file to the WebSphere business integrationmenu. For a fast way to start the connector, create a shortcut to this file on thedesktop.

Note: For more information on WebSphere business integration Installer, refer tothe System Installation Guide for Windows or for Unix.

Event and archive tablesThe connector uses the event table to queue events for pickup. If you have set theArchiveProcessed property to true or to no value, the connector uses the archivetable to store events after updating their status in the event table.

For each event, the connector gets the business object’s name, verb, and key fromthe CW Event business component. The connector uses this information to retrievethe entire entity from the application. If the entity was changed after the event wasfirst logged, the connector gets the initial event and all subsequent changes. Inother words, if an entity is created and updated before the connector gets it fromthe event table, the connector gets both data changes in the single retrieval.

The following three outcomes are possible for each event processed by a connector:v Event was processed successfullyv Event was not processed successfullyv Event was not subscribed to

Chapter 2. Installing and configuring the connector 11

If events are not deleted from the event table after the connector picks them up,they occupy unnecessary space there. However, if they are deleted, all events thatare not processed are lost and you cannot audit the event processing. Therefore,you should also create an archive table and keep the ArchiveProcessed property setto true. Whenever an event is deleted from the event table, the connector inserts itinto the archive table.

Configuring event and archive processingTo configure event and archive processing, you must use configuration propertiesto specify the following information:v The interval frequencyv The number of events for each polling intervalv Whether the connector archives unsubscribed and unprocessed eventsv The unique ID of the connector, which is important when multiple connectors

poll the same table

Creating the event and archive tablesThis procedure uses the Siebel Sales Enterprise application as an example.Substitute all references to Siebel Sales Enterprise with the name of the Siebelapplication in use.

To create the event and archive tables and to trigger the business objects, performthe following procedure:1. Ensure that all current projects have been checked in.2. On your local database, check out and lock the following files:

v New Table Project

Note: New Table Project does not apply to Siebel, version 7.5.v Siebel Sales Enterprise projectv Projects that include objects that you want to modify, such as the Account

projectv Dock project

Note: Ensure that the projects are locked on both the local and developmentservers.

3. Apply the seven patch files in the following order to your local database:v cwtable.sif

v cwview.sif

v cwapplet.sif

v cwbo.sif

v cwbc.sif

v cwdo.sif

v cwscreen.sif

v schemabo.sif

Note: There is no schemabo.sif file for Siebel, version 7.5.

When you apply WebSphere business integration system patch files in aJapanese environment, edit all the patch files as follows:


Edit the first line of each file from:

<xml version=”1.0” encoding=”windows-1252”?>

to:

<xml version=”1.0” encoding=”Shift_JPN”?>

Replace all instances of the “ENU” language setting with “JPN.” If you use thesearch and replace function of your text editor, make sure you use quotationmarks around the language setting to make sure no similar words (forexample, MENU) are replaced.

4. When you are prompted, lock the CW Audit project on your local database.5. Ensure that the following have been created:

v Two new tables, CX_CW_Archive_Q and CX_CW_Event_Q

v One new business object, CW Events

v One new business object, schema version

v Two new business components, CW Archive and CW Events

v One new view, CW Event List View

v Two new applets, CW Archive List Applet and CW Event List Applet

v One new screen CW Events and one new screen view, CW Event List viewv Two new dock objects, CX_CWArchive and CX_CWEvent

6. Create a page tab as follows:a. Access the Application>Siebel Sales Enterprise>Page tab.b. Right-click and select New Record from the menu.c. Enter CW Events as the screen name and IBM Events as the text name.d. For the sequence, enter a number greater than the rest of the sequence

numbers. This selection determines where the tab is displayed in theapplication.

e. Leave the inactive field unchecked.v If you are using Siebel 6, proceed to 7.v If you are using Siebel 7, go to the Page tab locale and create a new record

for CW Events. Add ENU for the Language Code and IBMEvents for text, if itdoes not exists.

7. Create a screen menu item as follows:a. Access the Application>Siebel Sales Enterprise>Screen Menu Item.b. Right-click and select New Record.c. Enter CW Events as the screen and IBM Events as the text name.d. For the sequence, enter a number greater than the rest of the sequence

numbers. This selection determines where the tab is displayed in thescreen pull-down menu.

e. Leave the inactive field unchecked.v If you are using Siebel 6, proceed to 8.v If you are using Siebel 7, go to the screen menu item locale and create a

new record for CWEvents. Add ENU for language and IBMEvents for text, if itdoes not exist.

8. Add or modify the Siebel VB scripts for the business components thatcorrespond to the business objects used at your site. The Siebel VB scriptstrigger event notification for business objects.


v If you want to sort events by priority, edit the priority values in thebusiness objects VB scripts before compiling them.

v If you are installing is multiple connectors, set and activate the ConnectorId in the VB scripts.Siebel 6

If you want to use the Additional Object Key field, you must set it in theVB script.

9. Apply the physical schema for the new tables to your local database. You cando this by querying for the two new tables, CX_CW_ARCHIVE_Q andCX_CW_EVENT_Q, and selecting the current query to create a physical schema.Make sure that you leave the table space and index space blank.

10. Activate the new schema using the activate button.11. Compile the updated and locked projects on your local database to create a

new Siebel repository (.srf) file.12. Open Siebel Sales Enterprise on your local database. You must have

administrative privileges to perform the following:a. .Create a new view called CW Event List View. Tip: Copy the view name

from tools and paste it into the View Name field.b. .Create a new responsibility called CW Responsibility for CW Event List

View.c. .Add the employees or teams who are responsible for reviewing events to

the newly created CW Responsibility.d. .Create the CWCONN user and add it to CW Responsibility and

Administrative Responsibility.13. Test the application in your local environment. Ensure that you have visibility

to CW Event List View and that an event is generated in the view after youcreate a supported object. For example, create a new account in Siebel andcheck that a new account event appears in the CW Event List View.

14. Check in the following updated and locked projects to your developmentserver.v New Tablev CW Auditv Dockv Siebel Sales Enterprisev The project for the business objects that you want to use

Note: You should check in your locked projects only through the query.15. Apply the physical schema to your development database. You can do this by

querying for the two new tables, CX_CW_ARCHIVE_Q and CX_CW_EVENT_Q, andselect the current query to create a physical schema. Make sure that you leavethe table space and index space blank.

16. Activate the queried tables in the development database.17. Move to test and production environments accordingly.18. Move your newly compiled Siebel.srf file to the server.

Note: Enable Enterprise Application Integration by going to: Sitemap-> ServerAdministration-> Component Group and selecting Enable.

To set Siebel JAVABean:1. Select, Site Map->Server Admin-> Components (Sales Object Manager).


2. In the lower applet, go to Component Parameter and enter a timeout value.

Note: The Request Timeout current value is set to 600. This means that theconnector will die after ten minutes. Based on Siebel, you can changethis value to be as large as you want.

Configuring the connectorConnectors have two types of configuration properties: standard configurationproperties and connector-specific configuration properties. You must set the valuesof some of these properties before running the connector.

You configure connector properties from Connector Configurator (when WebSphereMQ Integrator Broker is the integration broker) or from Connector Configurator,which is accessed from System Manager (when ICS is the integration broker). Fordetailed configuration information, see Appendix B, “Connector Configurator”, onpage 83 or the Connector Development Guide for Java.

Standard connector propertiesStandard configuration properties provide information that all connectors use. SeeAppendix A, “Standard configuration properties for connectors”, on page 61 fordocumentation of these properties.

Table 5 provides information specific to this connector about configurationproperties in the appendix.

Table 5. Property information specific to this connector

Property Note

Character Encoding This connector does not use this property.

Locale Because this connector has beeninternationalized, you can change the valueof this property. See release notes for theconnector to determine currently supportedlocales.

Important: WebSphere MQ Integrator Broker does not support multiple locales.Ensure that every component of your installation (for example, alladapters, applications, and the integration broker itself), are set to thesame locale.

Note: Because this connector supports all integration brokers, configurationproperties for all brokers are relevant to it.

Connector-specific propertiesConnector-specific configuration properties provide information needed by theconnector at runtime. Connector-specific properties also provide a way of changingstatic information or logic within the connector without having to recode andrebuild the agent.

Table 6 lists the connector-specific configuration properties for the connector. Seethe sections that follow for explanations of the properties.


Table 6. Connector-specific configuration properties

Name Meaning Possible values Default value

ConnectString With the new Siebelarchitecture, the Siebel JavaData Bean can connect to theSiebel Object Manager usingthe connect string. There isno need to know theconfiguration file, simplyread the file and connect tothe Object Manager.

protocol://machinename/enterprisename/objectmanager/servername

N/A

ConnectString (for Siebel,version 7.5)

With the new Siebelarchitecture, the Siebel JavaData Bean can connect to theSiebel Object Manager usingthe connect string. There isno need to know theconfiguration file, simplyread the file and connect tothe Object Manager.

protocol://machinename/enterprisename/objectmanager_languageCode/ servername

N/A

ConnectString (for ODA, version7.5)

With the new Siebelarchitecture, the Siebel JavaData Bean can connect to theSiebel Object Manager usingthe connect string. There isno need to know theconfiguration file, simplyread the file and connect tothe Object Manager.

siebel.tcpip.none.none://CW_ECOM2:2320/siebel/SSEObjMgr_Enu/ CW_ECOM2

N/A

ApplicationUserName User account for the Siebelapplication

CWCONN

ApplicationPassword Password for the Siebel useraccount

CWCONN

ConnectErrors A set of errors returned fromSiebel which are checked inthe connector. These errorsare considered to be fatal,and the connector isterminated when itencounters these errors.

Any network failure orconnectivity failure messages.These messages are separated bythe ’;’ delimiter.

ConnectorId Used in case the system hasbeen configured to handlemultiple connectors.

An integer value denoting thenumber of connectors configured.

ViewMode Retained for backwardcompatibility. The value isused if there is not VM asispecified for the businesscomponent.

An integer value. Refer to VM asifor details.

DataBeanRefreshInterval The value is used to refreshthe Siebel data beanresources when theconnector is running againstSiebel 6.2.x The connectorlogs off after the requestsprocessed are equal to thisvalue and logs back in.

An integer value indicating theDataBeanRefreshInterval whichcorresponds to the number ofrequests to be processed by theconnector before a refresh call.

DataBeanPoolSize Indicates the maximumnumber of beans in the databean pool.

An integer determining the beanpool size.


Table 6. Connector-specific configuration properties (continued)

Name Meaning Possible values Default value

SiebelLanguageCode Three letter NLS characterset code used by Siebel forthe languages supported.Default is US English withENU as the NLSrepresentation.

With Siebel 7, the languagessupported with their languagecodes is listed below: Italian (Std)-- ITA Japanese -- JPN Korean--KOR Norwegian -NOR (Bokmal)Polish -- POL Portuguese -- PTB(Brazil) Portuguese -- PTG(Portugal) Russian - RUS Spanish-- ESN (Modern Sort) Swedish --SVE Turkish -- TUR English (US)-- ENU + all the other languagessupported by NLS

DateFormat String date format for thespecified locale.

String representing the dateformat. Ex: MM/DD/YYHH:MM:SS AM/PM for US.

PollQuantity Determines the number ofevents that gets processedwith a pollForEvents call.

Integer representing the number ofevents that gets processed with apollForEvents call.

1

SupportNameValuePairs Used for determining theevent object key format. Ifnot set or if set to true, theobject key value needs to bea name-value pair with an“=” between the name andthe value. If set to false, onlyone rowId can be specified.

True or False False

PollAttributeDelimiter In case of multiplename-value pairs in theobject key, this valuedetermines the delimiterbetween the keys. If not set,the default is; (semi-colon).

Character ;

ResonateSupport Indicates if Resonate hasbeen installed with the Siebelserver. The connector beanpool uses Attach/Detachcalls (Siebel7) only ifResonate is installed. If not,it logs off after processing acertain number of requests.

Boolean(Logoff from the bean isdecided by theDataBeanRefreshInterval) setting.

false

ApplicationPasswordPassword for the application user account.

There is no default value.

ApplicationUserNameName of the application user account.

There is no default value.

ArchiveProcessedSpecifies whether the connector archives events for which there are no currentsubscriptions.


Set this property to true to cause events to be inserted into the CW Archivebusiness component after they are deleted from the CW Event businesscomponent.

Set this property to false to cause the connector not to perform archive processing.If ArchiveProcessed is set to false, the connector behaves as follows:v If the event is successfully processed, the connector deletes it from the CW Event

business component.v If the connector does not subscribe to the event’s business object, the connector

leaves the event in the CW Event business component and changes its eventstatus to Unsubscribed.

v If the business object encounters a problem while being processed, the connectorleaves the event in the event table with event status set to that of error.

If this property is set to false and the poll quantity is low, the connector appears tobe polling the event table, but it is simply picking up the same events repeatedly.

If this property has no value, the connector assumes the value to be true. If theArchiveTableName property also has no value, the connector assumes the archivetable’s name is xworlds_archive_events.

The default value is true.

ConnectorIDA unique ID for the connector. This ID is useful to retrieve events for a particularinstance of the connector.

Default value is null.

PollQuantityNumber of rows in the database table that the connector retrieves per pollinginterval. Allowable values are 1 to 500.

The default is 1.

UseDefaultsIf UseDefaults is set to true or is not set, the connector checks whether a validvalue or a default value is provided for each required business object attribute. If avalue is provided, the Create succeeds; otherwise, it fails.

If UseDefaults is set to false, the connector checks only whether a valid value isprovided for each required business object attribute; the Create operation fails if avalid value is not provided.

The default value is false.

Connector startupFor information on starting a connector, stopping a connector, and the connector’stemporary startup log file, see the IBM WebSphere Business Integration AdapterImplementation Guide for WebSphere MQ Integrator Broker, or, for ICS, see the IBMWebSphere InterChange Server System Administration Guide.


Chapter 3. Understanding business objects

This chapter describes how the connector processes business objects and providessuggestions for modifying them.

To properly create or modify business objects for Siebel, you must understand theobject relationships within the Siebel architecture.

The following topics are covered:v “Business object structure and relationships”v “Business object application-specific information” on page 21v “Using business object samples” on page 30

Business object structure and relationshipsThe connector supports Create, Retrieve, Update, Delete, Exists, Retrieve ByContent, and DetlaUpdate verbs for a Siebel application-specific business objectwhose semantics are encapsulated in its business object definition. There is noconnector logic that processes a Siebel application-specific business objectaccording to hard-coded instructions in the connector. For example, the connectordoes not expect a particular business object to consist of a certain type and numberof entities. What the connector expects is that any object may consist of one ormore entities.

Siebel business components can be associated in three ways. They can be linked inone-to-one relationships through single-valued links, or they can have Multi-ValueLink (MVL) fields representing one-to-many relationships, or they can have asimple link.

Business components can be associated in many-to-one relationships by means ofPickLists. Business component methods provide support for searching a PickListbusiness component for a specific value and placing that value in a field. Finally,business components can be associated in many-to-many relationships throughintersection tables.

In order to support the Siebel concept of a business object context encapsulatingnumerous business components, a top-level business object should becorresponded to the appropriate Siebel business object. The top-level businessobject application-specific information should contain the name of thecorresponding Siebel business object. Each top-level attribute should thencorrespond to a Siebel business component.

Within a business object definition that corresponds to a business component, eachattribute specifies either a simple field, or a Multi-Value Group (MVG) field. Theattribute data in simple attributes should have simple data types. Attributes thatcorrespond to MVG fields should be treated as child (container) business objects.

If there are two unrelated single cardinality business components under the samebusiness object in Siebel, a separate business object wrapper needs to be created.


This business object structure is part of the meta-data that allows the connector tohandle all business objects in the same manner. The connector can supportadditional Siebel objects if a business object definition is specified for the object.

Specifying key attributesWhen developing a Siebel business object, always place the key attribute at the topof the object. This ensures that the connector has the key value before processingthe rest of the object. Placing the key attribute elsewhere in the object may lead toprocessing errors. The key attribute for an object is its RowId in Siebel.

Note: The connector does not support specifying an attribute that represents achild business object or an array of child business objects as a key attribute,except for the child of a top-level business object (the Siebel BO).

Note: When developing business objects for the connector, you must ensure thatthere is a 1-to-1 correspondence between the business object and the Siebelbusiness component.

Attribute propertiesThe following tables describe simple attributes and child object attributes.

Table 7. Simple attribute

Name Name of attribute

Type Data Type of the attribute. Currently, this isnot used, but for forward compatibilityreasons, Siebel ODA sets the type to eitherboolean, String, Date, int, double. All typesare treated as Strings.

MaxLength Applies to String types and represents themaximum length allowed for the attribute.This is not used by the connector. If the datais large, it must be handled in the businessprocesses.

IsKey If set, this denotes that the attribute is a key.It is used with Update to update a specificrecord in Siebel. With Retrieve, theseattributes are used in the search specificationto get the record from Siebel. During Delete,The keys are set on the top-level businesscomponents.

IsForeignKey Not used.IsRequired Set to true if the attribute for the fields in the

Siebel business component whose “Required”property is checked.

AppSpecificInfo Text comprised of information aboutcommunicating with the application andgetting the Siebel business objects andbusiness components associated with thisbusiness object.

DefaultValue If set for the attribute, this value is used bythe connector if one is not set in the inboundbusiness object and the connector propertyUseDefaults is set to True.


Table 8. Child object attributes

Name Name of the child object

Type Business object type for the child.ContainedObjectVersion The child business object versionRelationship If the child is a container attribute, this is set

to Containment.IsKey This attribute has to be set on the primary

business component.IsForeignKey Not used.IsRequired If set to True, the child is expected to have a

representation in the parent business object.During Create verb processing, the primarybusiness component is required to bepresent. A check is made to see if thiscomponent is present in the inboundbusiness object. If found, the create proceedsunless an error is thrown indicating that therequired object was not found in the inboundbusiness object.

Cardinality 1 or N depending on the number of childrecords that can be chosen for a parentrecord.

Business object application-specific informationApplication-specific information in business object definitions provides theconnector with application-dependent instructions on how to process businessobjects. Because a meta-data-driven connector makes assumptions about how itssupported business objects are designed, modifications to business objects mustmatch the connector’s rules for the connector to process modified business objectscorrectly. Therefore, if you modify or create Siebel application-specific businessobjects, you must be sure that the application-specific information in the businessobject definition matches the syntax that the connector expects.

This section describes the application-specific information for the Siebel businessobject, attributes, and verbs.

Business object application-specific informationThe application-specific information at the top level of a business object specifiesthe name of the Siebel business object. For example, the object application-specificinformation for the parent business object Siebel_BCAccount specifies the SiebelAccount object, as shown below.[BusinessObjectDefinition]Name = Siebel_BCAccountVersion = 1.0.0AppSpecificInfo = ON=Account;CN=Account

Example of multiple unrelated business components:[BusinessObjectDefinition]Name = Siebel_BCInternalProductVersion = 1.0.0AppSpecificInfo = CN=InternalProduct

[BusinessObjectDefinition]Name = Siebel_BCProductDefectVersion = 1.0.0

Chapter 3. Understanding business objects 21

AppSpecificInfo = CN=ProductDefect

[BusinessObjectDefinition]Name = Siebel_BOInternalProductVersion = 1.0.0AppSpecificInfo = ON=InternalProduct

[Attribute]Name = Siebel_BCInternalProductType = Siebel_BCInternalProductContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = 1MaxLength = 0IsKey = falseIsForeignKey = falseIsRequired = falseAppSpecificInfo =

[Attribute]Name = Siebel_BCProductDefectType = Siebel_BCProductDefectContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = 1MaxLength = 0IsKey = falseIsForeignKey = falseIsRequired = falseAppSpecificInfo =

Attribute application-specific information formatThe connector uses application-specific information for simple attributes andcontainer attributes. The application-specific property field must be empty for theObjectEventId attribute.

Application-specific information for simple attributesFor simple attributes, the application-specific information consists of thename-value pairs listed in the following table. The name-value pairs areorder-independent and are delimited by semicolons.

Parameter Description

FN = The name of the corresponding field in theSiebel business component.

PLK = ...;Restrict=<field name>:SiebelGUI Name>,<field name>:Siebel GUI Name

Business components in Siebel can beassociated with a many-to-one relationshipusing PickLists. The PickList can be searched,and a specific value can be chosen to beplaced in a field. The PickListKey is set incase there is a PickList associated with thefield in Siebel. The PickListKey identifies thefield in the PickList that is used in the searchspecification to obtain the PickList record. Insome cases, PickList values are chosen basedon more than one attribute. In such cases, thePickList can be restricted by more than onefield.

Example of the use of these parameters are provided in the sections that follow.


Field names for a simple attributesapplication-specific information for simple business objects attributes must specifythe name of the corresponding field in the Siebel business component. Theapplication-specific information for this is:FN=fieldname

For example, in the Siebel_BCAccount business object the application-specificinformation for the Main Phone attribute specifies that Main Phone Number is thecorresponding field in the Siebel Account business component. Theapplication-specific information in the business object attribute is shown below.Name = Main PhoneType = StringIsKey = falseAppSpecificInfo = FN=Main Phone Number

Foreign key relationship using a pickListIn Siebel, a foreign key relationship between two business components is definedby a PickList. If a field has an associated PickList, the field’s PickList propertyand PickList correspondence define the relationship between the two businesscomponents. One of the attributes in the PickList correspondence is usually an Id,such as Account Id or Product Id.

On a simple attribute in a business object, if a Siebel business component field hasan associated PickList, the attribute application-specific information in the businessobject should be coded to provide the connector with this information so that theconnector can use the attribute as a foreign key.

To specify a PickList for an attribute, you need to include two attributes in thebusiness object. The first attribute identifies the foreign key field of the relatedbusiness component, and the second attribute corresponds to the field in thebusiness component that has the PickList as a field property. Two attributes arerequired because the PickList relationship is based on the object name rather thanthe object Id.

In the application-specific information for the PickList attribute, specify that thisattribute is a PickList using the text PLK. Then, to identify which record in thePickList should be selected, use the text PLK=...;Restrict=<field name>:<SiebelGUI Name>,<field name>:Siebel GUI Name>.

For example, suppose that you are creating a Siebel_BCAsset business object, andyou want to add an attribute in the business object as a foreign key to theSiebel_BCInternalProduct business object. The Product Name field in theSiebel Asset Mgmt business component is a PickList to the Internal Productbusiness component, so you add an attribute for the key and another attribute forthe PickList. The attributes might be defined in the business object as shownbelow.[Key Attribute]Name = IdType = StringCardinality = 1IsForeignKey = trueAppSpecificInfo = Product Id

[PickList Attribute]Name = ProductNameType = stringCardinality = nAppSpecificInfo = FN=ProductName;PLK=Id


In some cases, PickList values are chosen based on more than one attribute. Forexample, where there is more than one Account with the same name, a Contactretrieve will get the first Account with that name if Account name is set as theonly PickList value. To ensure that the correct data is retrieved, you can restrict thePickList by more than one field. In the following example, the Contact businessobject is restricted by Account, Site and City:[Key Attribute]Name = ContactIdType = StringCardinality = 1AppSpecificInfo = FN=Id

Name = Last_NameType = StringCardinality = 1AppSpecificInfo = FN=Last Name

Name = First_NameType = StringCardinality = 1AppSpecificInfo = FN=First Name

Name = SiteType = StringCardinality = 1AppSpecificInfo = N/A

Name = CityType = StringCardinality = 1AppSpecificInfo = N/A

Name = AccountType = StringCardinality = 1AppSpecificInfo = FN=Account;PLK=Name;Restrict=Location:Site,City:City

The AppSpecificInfo for restricting PickList fields follows this syntax:Restrict=<field name>:<Siebel GUI name>,<field name>:<Siebel GUI name>

There is no limit to the number of restricting fields. Do not use spaces between theattributes after the Restrict parameter. All restricting fields must be added asattributes to the business object, and should have no AppSpecificInfo. Theseattributes serve as place holders for the restricting fields.

On a Retrieve, the application-specific information PLK=Id specifies that theProductName attribute corresponds to a PickList business component, and the setparameter specifies that the value of the Id identifies which record the connectorshould pick.

Some PickList relationships require the creation of a picked child, for example, thePickList relationship between Account and Quote in Siebel_BCQuote. On a Create,you must create a new Account business component for the PickList with acontainment relationship to the Quote business component as follows:[Business Object Definition]Name = Siebel_BCQuoteVersion = 7.0.0Relationship = ContainmentAppSpecificInfo = ON=Quote;CN=Quote

Name = Account


Type = StringAppSpecificInfo = FN=AccountId

Name = AccountType = Siebel_BCAccountRelationship = ContainmentCardinality = 1IsForeignKey = falseAppSpecificInfo = LFN=Account;PL=true;From=AccountId;To=AccountId

[Siebel_BCAccount]Name = AccountIdIsKey = trueAppSpecificInfo = ...

Note the following business processing tips for PickList attributes:v On a Retrieve operation, correspond the value of the PickList attribute to the

name of the PickList business component, and correspond the value of the keyattribute to the key.

v On a Create or Update operation, correspond the PickList attribute to the key,and correspond the key attribute to a null value. Because the PickList link isdefined on the name of a field, the connector could set the key attribute value toany value, and Siebel does not validate the value. If the PickList attributecontains the key value, and a pick operation is performed using the PickListcomponent, validation of the key is performed. If the Pick operation finds thefield, it adds all the attributes in the pick correspondence to the new object, andthe new object is created.

v To remove the link from the PickList, correspond the value for the PickListattribute to null and correspond the value for the key attribute to blank.

Application-specific information for container attributesFor container attributes, the application-specific information contains thename-value pairs listed in the following table. The name-value pairs are orderindependent and are separated by semicolons.

Parameter Description

LFN = ...; Multi Value Field Name related to the Siebel businesscomponent.

MVL = ...; When MVL is set to Active, it specifies a one-to-manyrelationship. Setting MVL to Inactive indicates that there is aninactive multi-value link relationship between the parent andchild objects, which means that the parent object does not havea multi-value field.

PL = ... When PL is set to True, it indicates that there is a many-to-onerelationship.

Assoc = ... When Assoc is set to True, it indicates that a relationship ismany-to-many through an intersection table.

From = ...; To = ... These are preprocessing instructions to the connector to set theTo attribute to the value of the From attribute. The Fromattribute must be populated, while the True attribute is set onlyif it is null. The objects containing the attributes must have aone-to-one relationship. This is used in a Retrieve operation andto specify which child record needs to be fetched.

SF Simple link which provides the master detail view of thebusiness component structure under a business object. SFrepresents the source field.

DF Simple link which provides the master detail view of thebusiness component structure under a business object. DFrepresents the destination field (foreign key).


Field names for container attributesapplication-specific information for a container attribute referencing a childbusiness object must specify the name of the Multi-Value Field related to theparent business component. A Multi-Value Field represents the Multi-Value Linkthat defines the relationship between the parent and child business components inSiebel. The application-specific information for this is:LFN=multiValueFieldName

For example, the WebSphere business integration system business objectSiebel_BCContact has a container attribute for the child business objectSiebel_BCBusinessAddress. The application-specific information for this containerattribute specifies Street Address as the Multi-Value Field that contains the link tothe Siebel Business Address business component.[Example of Container Attribute]Name = PrimaryAddressType = Siebel_BCBusinessAddressContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = nIsKey = falseIsForeignKey = falseAppSpecificInfo = MVL=Active;LFN=Street Address

Relationships between parent and child business objectsIn addition to the field name, the application-specific information for a containerattribute can include a parameter that defines the type of relationship between theparent and child business components in Siebel.

Setting a relationship type parameter to 0 is not valid. To set a relationship type tofalse, do not include the parameter.

As an example, the container attribute for the child business objectSiebel_BCBusinessAddress, shown in the previous section, might include theparameter to indicate that Street Address is a Multi Value Field that links theSiebel Account business component to the Siebel Business Address businesscomponent.[Example of Container Attribute]Name = PrimaryAddressType = Siebel_BCBusinessAddressContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = nIsKey = falseIsForeignKey = falseAppSpecificInfo = MVL=Active;LFN=Street Address

Another example for the child business object Siebel_BCOpportunity is shown herewhich has a many-to-many relationship to Siebel_BCContact or Association. In thiscase, on a Create operation, the connector searches for the business componentusing the populated fields of the business object in the container. If the connectorfinds a matching object, it associates it with the parent business component. If theobject is not found, an error is logged, and the business object request fails.Name = Siebel_BCContactVersion = 1.0.0AppSpecificInfo = ON=Contact;CN=Contact

Name = ContactId


Type = StringCardinality = 1MaxLength = 10IsKey = trueIsForeignKey = falseIsRequired = falseAppSpecificInfo = FN=Id

Name = ...

Name = ...

Name = Siebel_BCOpportunityType = Siebel_BCOpportunityContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = NMaxLength = 0IsKey = falseIsForeignKey = falseIsRequired = falseAppSpecificInfo =LFN=Opportunity;Assoc=true

This example is for a simple link relationship. In this case, there is a simple linkbetween Quote and Order Entry:Name = Siebel_BCQuoteVersion = 1.0.0AppSpecificInfo = ON=Quote;CN=QuoteName = QuoteIdType = StringCardinality = 1MaxLength = 10IsKey = trueIsFireignKey = falseIsRequired - falseAppspecificInfo = FN=Id

Name = ...

Name = ...

Name = Siebel_BCOrderEntryType = Siebel_BCOrderEntryContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = NMaxLength = 0IsKey = trueIsFireignKey = falseIsRequired - falseAppspecificInfo = SF=QuoteId;DF=QuoteId

Assigning the value of an attribute to another attributeAttribute application-specific information can be coded so that the connectorobtains a value for an attribute and assigns it to another attribute before thesecond attribute is processed. This functionality is used in a Retrieve operation andis primarily used on container attributes to specify which record for the childshould be retrieved.

To use this functionality, edit the attribute application-specific information in thebusiness object definition to include the following text:From=attribute;To=attribute;


The attribute path value can be an attribute name in the current business object.Note the following rules:v The From attribute is an attribute from the parent, and the To attribute is the

child attribute.v The From attribute must be populated before the to attribute in the instruction

can be processed.v The To attribute is set only if it has a null value.v If the path is invalid for the from parameter, the to parameter is set to null. If

the path is invalid for the to parameter, no error is flagged.v The From/To directive can be specified only in the application-specific

information of an attribute on a child business object. In other words, it cannotbe specified on a top-level business object.

For example, if a Siebel_BCQuote business object includes a child business objectSiebel_BCAccount, attributes in the Siebel_BCQuote object can specify whichaddress from the PickList is retrieved. In this example, AccountId is the keyattribute, and Siebel_BCAccount is the picked object. The connector gets the valueof the AccountId attribute, and uses that value to retrieve the specific account. Thechild attributes are processed after the attributes in the parent business object. Thefollowing example shows the processing flow of attributes from parent to childbusiness objects.[Siebel_BCQuote]Name = AccountType = StringAppSpecificInfo = FN=Id

Name = AccountType = Siebel_BCAccountRelationship = ContainmentCardinality = 1IsForeignKey = falseAppSpecificInfo = LFN=Address;PL=true;From=AccountId;To=AccountId

[Siebel_BCAccount]Name = AccountIdIsKey = trueAppSpecificInfo = ...

Specifying pickList relationshipsSome PickList relationships require the creation of the picked child object in thesame transaction. In WebSphere business integration system business objects, aPickList relationship between parent and child business objects is represented bytwo attributes: a key attribute and a single cardinality container attribute for thepicked object. This set of attributes can be used to retrieve some or all of theattributes of the PickList business component that are not included in the PickListmap.

For example, the Siebel_BCQuote business object might be designed to include twoattributes to specify a PickList relationship between Quote and Opportunity. Asshown below, OpportunityId is the key attribute, and Opportunity is the PickListobject.Name = Siebel_BCQuoteVersion = 1.0.0AppSpecificInfo = ON=Quote;CN=Quote

Name = ...

Name = ...


Name = OpportunityIdType = StringCardinality = 1MaxLength = 10IsKey = falseIsForeignKEy = trueIsRequired = falseAppSpecificInfo = FN= OpportunityId

Name = Siebel_BCOpportunityType = Siebel_BCOpportunityContainedObjectVersion = 1.0.0Relationship = ContainmentCardinality = 1MaxLength = 0IsKey = falseIsForeignKey = falseIsRequired = falseAppSpecificInfo = LFN=Opportunity;PL=true;From=OpportunityId;To=OpportunityId

In the application-specific information, PL=true indicates that the containerattribute represents a PickList, the From= parameter is the pointer to the keyattribute, and the To= parameter points to the key attribute of theSiebel_BCOpprotunity business object.

The order of the attributes is significant in a Retrieve operation, because the valueof OpportunityId must be retrieved before it can be defined as the foreign key inthe child object. On a Create or Update operation, the value of OpprotunityId is aforeign key and is retrieved after the object is created.

It is not necessary to use a complete business object as a PickList container. Anobject with only the required keys set is sufficient. The connector uses thefollowing rules for processing a PickList container:v If none of the key attributes of the PickList business object are set, a new object

is created in Siebel and picked.v If any of the key attributes of the PickList business object are set, the connector

searches for the object and picks it. If a PickList object for that business object isnot found, the connector logs an error. An error might occur when the objectkeys are not valid.

The following are guidelines for maps for PickList attributes on container businessobjects:v Mapping of the key attribute when it is a business object request from the

collaboration to the connector should follow the same guidelines for simpleattributes as described above.

v Mapping of the container attribute should be keys only if keys are known.v If the PickList object will be created, map all the required attributes as specified

for the PickList object.v On a Delete operation, set the key attribute to a space and the PickList container

attribute to null.

Verb application-specific information formatApplication-specific information for a business object Retrieve verb can specify thatthe connector retrieve a limited number of objects on each retrieve. Theapplication-specific information to retrieve a subset of objects is max=n. An exampleof a Retrieve verb that specifies that only five objects are retrieved is:


[Verb]Name = RetrieveAppSpecificInfo = max=5

For other verbs, the application-specific property is not used and should be leftblank or omitted when creating business object definitions.

Key attribute for create and update verbsOn a Create or Update request, if the Object Key value is different from RowId, theSiebel application blanks out the Object Key attribute and creates its own RowIdfor that record.

Important: You must use RowId as the key attribute in Create and Updaterequests.

Using business object samplesBusiness object samples are provided with the connector component of the adapter.In order to use these samples, you must make modifications to the Siebelapplication. Each business object sample has its own set of instructions.v “Siebel_BCAccount” on page 30v “Siebel_BCQuote” on page 31v “Siebel_BCContact” on page 31v “Siebel_BCInternalProduct” on page 32v “Siebel_BCAsset” on page 33

Siebel_BCAccount1. Locate the following Siebel VB files:

Siebel 6Account_Write.svb, Account_PreDelete.svb, Business_Address_PreDelete.sbv, andBusiness_Address_Write.svb.

Siebel 7Account.sbl or Account.js

The Siebel VB files are located in the Common/Siebel/Dependencies/Siebel_VBdirectory.

2. Save the files in a temporary directory. For example, use Temp as the directoryname.

3. Give the CWCONN account the System Administrator responsibility withinSiebel.

4. In your Siebel Tools environment, check out and lock the Account and Contactprojects.

5. Add the VB script to the Account business component as follows:a. Right-click on the Account business component, and select Edit Basic Scripts

from the menu. This launches the script editor.b. Import the VB code by selecting Import from the File menu, choosing the

Temp directory, and picking Account_Write.svb for import into the BusComp object and BusComp_WriteRecord procedure.

c. Import the second VB code by selecting Import from the File menu,choosing the Temp directory, and picking Account_PreDelete.svb for importinto the Bus Comp object and BusComp_PreDeleteRecord procedure.


d. Save changes to the object.6. Add the script to the Business Address business component as follows:

a. Right-click on the Business Address business component, and select EditBasic Scripts from the menu. This launches the script editor.

b. Import the VB code by selecting import from the File menu, choosing theTemp directory, and picking Business_Address_Write.svb, for import intothe Bus Comp object and BusComp_WriteRecord procedure.

c. Import the second VB code by selecting import from the File menu,choosing the Temp directory, and picking Business_Address_PreDelete.svbfor import into the Bus Comp object and BusComp_PreDeleteRecordprocedure.

d. Save changes to the object.e. In the Business Address business component for the Account Id attribute,

set the Force Active field to TRUE.

Note: Sometime this field does not get populated because of the view beingused.

7. You will not be able to test the object until you have saved all objects andcompiled the result.

Siebel_BCQuote1. Locate the following Siebel VB files:

Siebel 6Quote_Write.svb, Contact_PreDelete.svb

Siebel 7Quote.sbl, Quote.js


2. Save the file in a temporary directory. For example, use Temp as the directoryname.


4. In your Siebel Tools environment, check out and lock the Quote project.5. Add the script to the Quote business component as follows:

a. Right-click on the Quote business component, and select Edit Basic Scriptsfrom the menu. This launches the script editor.

b. Import the VB code by selecting Import from the File menu, choosing theTemp directory, and picking Quote_Write.svb for import into the Bus Compobject and the BusComp_WriteRecord procedure.

c. Save changes to the object.6. You will not be able to test the object until you have saved all objects and

compiled the result.

Siebel_BCContact1. Locate the following Siebel VB files:

Siebel 6Contact_Write.svb, Contact_PreDelete.svb.


Siebel 7Contact.sbl, Contact.js


2. Save the Siebel VB file in a temporary directory. For example, use Temp as thedirectory name.


4. In your Siebel Tools environment, check out and lock the Contact project.5. Add the Siebel VB script to the Contact business component as follows:

a. Right-click on the Contact business component, and select Edit BasicScriptsfrom the menu. This launches the script editor.

b. Import the VB code by selecting Import from the File menu, choosing theTemp directory, and picking Contact_Write.svb for import into the BusComp object and BusComp_WriteRecord procedure.

c. Import the second VB code by selecting Import from the File menu,choosing the Temp directory, and picking Contact_PreDelete.svb for importinto the Bus Comp object and BusComp_PreDeleteRecord procedure.

d. Save changes to the object.6. You will not be able to test the object until you have saved all objects and

compiled the result.

Siebel_BCInternalProduct1. Locate the file InternalProduct_Write.svb. The Siebel VB files are located in

the Common/Siebel/Dependencies/Siebel_VB directory.2. Save the file in a temporary directory. For example, use Temp as the directory

name.3. Give the CWCONN account the System Administrator responsibility within

Siebel.4. In your Siebel Tools environment, check out and lock the Product project.5. Add the Siebel VB script to the Internal Product business component.

a. Right-click on the Internal Product business component, and select EditBasic Scripts from the menu. This launches the script editor.

b. Import the VB code by selecting Import from the File menu, choosing theTemp directory, and picking InternalProduct_Write.svb for import into theBus Comp object and BusComp_WriteRecord procedure.

c. Save changes to the object.6. Change the business component properties as follows:

a. In the tool bar, select View > Property Window.b. Go to Business Component/Internal Product.c. Change the following attributes to False:

No Insert = FalseNo Merge = FalseNo Update = False

Note: The purpose of changing the above properties is to allow Com DataServer Interface to create and update products inbound to Siebel.



Siebel_BCAsset1. Locate the Siebel VB file Asset_Write.svb. The Siebel VB files are located in the

Common/Siebel/Dependencies/Siebel_VB directory.2. Save the Siebel VB file in a temporary directory. For example, use Temp as the

directory name.3. Give the CWCONN account the System Administrator responsibility within

Siebel.4. In your Siebel Tools environment, check out and lock the Asset Management

project.5. Add the Siebel VB script to the Asset Mgmt - Asset business component as

follows:a. Right-click on the Asset Mgmt - Asset business component, and select the

Edit Basic Scripts from the menu. This launches the script editor.b. Import the Write VB code by selecting Import from the File menu, choosing

the Temp directory, and picking Asset_Write.svb into Bus Comp object andBusComp_WriteRecord procedure.

c. Save changes to the object.6. Change the business component properties as follows:

a. In the tool bar, select View > Property Windows.b. Go to Business Component/Asset Mgmt - Asset.c. Go to fields.d. Change the field property values as follows:

v Select Account Id and set the value for Inactive to False. (This field isrequired in the WebSphere business integration system object.)

v Select Name and set the value to Not Required.v Select Product Id and set the value to Required.

Note: WebSphere business integration system tracks the Products by theirProduct Id and not their Name.




Chapter 4. Generating business object definitions usingSiebelODA

This chapter describes SiebelODA, an object discovery agent (ODA), whichgenerates business object definitions for the connector. The SiebelODA uses theSiebel Java APIs to get the information about the Siebel business objects andbusiness components from the Siebel application server. It then uses thisinformation to build new business object definitions. The SiebelODA also enablesthe conversion of existing business object definitions to those which are supportedby the connector.

The following topics are covered:v “Installation and usage”v “Installing SiebelODA”v “Running SiebelODA on multiple machines” on page 36v “Using SiebelODA in Business Object Designer” on page 37v “Contents of the generated definition” on page 47v “Adding information to the business object definition” on page 49

Installation and usageThis section discusses the following:v “Installing SiebelODA” on page 35v “Before using SiebelODA” on page 36v “Starting SiebelODA” on page 36v “Running SiebelODA on multiple machines” on page 36v “Changing the error and message filename” on page 37

Installing SiebelODATo install SiebelODA, use the WebSphere Business Integration Adapter (WBIA)Installer. Follow the instructions in the System Installation Guide for UNIX or forWindows. When the installation is complete, the following files are installed in thedirectory on your system where you have installed the product:v ODA\Siebel\SiebelODA.jar

v ODA\messages\SiebelODAAgent.txt

v ODA\Siebel\start_SiebelODA.bat (Windows only)v ODA/Siebel/start_SiebelODA.sh (UNIX only)v bin\CWODAEnv.bat (Windows only)v bin/CWODAEnv.sh (UNIX only)

Note: Except as otherwise noted, this document uses backslashes (\) as theconvention for directory paths. For UNIX installations, substitute slashes (/)for backslashes. All WBIA product pathnames are relative to the directorywhere the product is installed on your system.


Before using SiebelODABefore you can run SiebelODA, you must copy the required Siebel application’s .jarfiles to the %ProductDir%/connectors/Siebel/dependencies directory. The followingfiles must be copied to this directory:

Siebel 7SiebelJI_enu.jarSiebelJI_Common.jar

The default version of Siebel is set to 7.x. Ensure that the REM in the followingline is not removed:REM set SIEBELVERSION=”6.x”

Siebel 6.2.xSiebelDataBean.jarSiebelTC_enu.jarSiebelTcCommon.jarSiebelTcOM.jar

You must edit the start_SiebelODA.bat file to remove the REM in the line:REM set SIEBELVERSION =”6.X”

After installing the SiebelODA, you must do the following to generate businessobjects:1. Start the ODA.2. Start Business Object Designer.3. Follow a six-step process in Business Object Designer to configure and run the

ODA.

The following sections describe these steps in detail.

Starting SiebelODAYou can start SiebelODA using one of the following scripts:

UNIX:start_SiebelODA.sh

Windows:start_SiebelODA.bat

You configure and run SiebelODA using Business Object Designer. Business ObjectDesigner locates each ODA by the name specified in the AGENTNAME variable of eachscript or batch file. The default ODA name for this connector is SiebelODA.

Running SiebelODA on multiple machinesYou can run multiple instances of the ODA, either on the local host or a remotehost in the network. Each instance has to run on a unique port if multipleinstances are being run on the same machine.

Figure 2 on page 38 illustrates the window in Business Object Designer from whichyou select the ODA to run.


Changing the error and message filenameThe error and trace message file (SiebelODAAgent.txt) is located in\ODA\messages\, which is under the product directory. This file uses the followingnaming convention:

AgentNameAgent.txt

If you change an ODA’s name in the AGENTNAME variable of a script or batch file,use this convention to change the name of its associated error and trace messagefile.

If you create multiple instances of the script or batch file and provide a uniquename for each represented ODA, create a copy of the error and trace message filefor each of these. Name each file according to this convention. For example, if theAGENTNAME variable specifies SiebelODA1, name the associated message file:SiebelODA1Agent.txt.

During the configuration process, you specify:v The name of the file into which SiebelODA writes error and trace informationv The level of tracing, which ranges from 0 to 5.

Table 9 describes the tracing level values.

Table 9. Tracing levels

Trace Level Description

0 Logs all errors

1 Traces all entering and exiting messages for method

2 Traces the ODA’s properties and their values

3 Traces the names of all business objects

4 Traces details of all spawned threads

5 v Indicates the ODA initialization values for all of its properties v Traces adetailed status of each thread that SiebelODA spawned v Traces thebusiness object definition dump

For information on where you configure these values, see “Configuringinitialization properties” on page 39.

Using SiebelODA in Business Object DesignerThis section describes how to use SiebelODA in Business Object Designer toconvert the existing business definitions to new ones and to generate new businessobject definitions. This is done by getting information directly from the applicationserver. For information on starting Business Object Designer, see the Business ObjectDevelopment Guide.

After you start an ODA, you must start Business Object Designer to configure andrun it. There are six steps in Business Object Designer to generate a business objectdefinition using an ODA. Business Object Designer provides a wizard that guidesyou through each of these steps.

After starting the ODA, do the following to start the wizard:1. Open Business Object Designer.

Chapter 4. Generating business object definitions using SiebelODA 37

2. From the File menu, select the New Using ODA... submenu.Business Object Designer displays the first window in the wizard, named SelectAgent. Figure 2 on page 38 illustrates this window.

To select, configure, and run the ODA, follow these steps:1. “Select the ODA”2. “Configuring initialization properties” on page 393. “Generating definitions” on page 44 and, optionally, “Providing additional

information” on page 454. “Saving definitions” on page 46

Select the ODAFigure 2 illustrates the first dialog box in Business Object Designer’s six-stepwizard. From this window, select the ODA to run.

To select the ODA:1. Click the Find Agents button to display all registered or currently running

ODAs in the Located agents field.

Note: You can also find the agent using the Host name and the Port number. Ifyou are using Business Object Designer to locate your desired ODAwithout success , check the setup of the ODA.

2. Select the desired ODA from the displayed list.Business Object Designer displays your selection in the Agent’s name field.

Figure 2. Selecting the ODA


Configuring initialization propertiesThe first time Business Object Designer communicates with SiebelODA, it promptsyou to enter a set of initialization properties as shown in Figure 3. You can savethese properties in a named profile so that you do not need to re-enter them eachtime you use SiebelODA. For information on specifying an ODA profile, see theBusiness Object Development Guide.

Configure the SiebelODA properties described inTable 10.

Important: All of the SiebelODA properties inTable 10 are required to be entered.

Table 10. SiebelODA properties

Rownumber

Property name Property type Description

1 UserName String Siebel application login name2 Password String Siebel application password3 SiebelConnectString String Connect string to log into the Siebel Application. For

example, for Siebel 7.0://machinename/enterprisename/objectmanager/servernameFor Siebel 7.5: //machinename/enterprisename/objectmanager _languageCode/servername

4 TraceFileName String5 TraceLevel Integer Text that is prepended to the name of the business object

to make it unique. You can change this later, if required,when Business Object Designer prompts you for businessobject properties. For more information, see “Providingadditional information” on page 45.

6 DefaultBOPrefix String Example: Siebel_BO. This is a recommended field, not arequired field.

Figure 3. Configuring agent initialization properties


Table 10. SiebelODA properties (continued)

Rownumber

Property name Property type Description

7 LanguageVersion String Example: ENU for English8 FileLocation String The absolute path containing the files with previous

versions of business object definitions. For example, inWindows, the path is C:\SiebelBos. In UNIX, the path is/home/SiebelBOs

9 MessageFile String Siebel ODA Agent.txt

Expand nodes and select repository files, business objects,and business components

After you configure all initialization properties for SiebelODA, the following screenis displayed by Business Object Designer.

This screen has two expandable options, Convert and Generate. If you need toconvert the old business object definitions into new ones, expand Convert. Thisdisplays the repository files containing the business object definitions that need tobe converted (see Figure 5).

Figure 4. Tree giving two options for BO conversion and BO generation


Select the files to be converted, then click Next.

If you need to generate new business object definitions by getting informationfrom the Siebel application server, expand Generate. This gets all of the businessobject names from the Siebel application server and displays a tree (see Figure 6).

Figure 5. Tree displaying the business object definitions to be converted


The business object names which are presented as nodes in the tree areexpandable. Expand the node you want, then expand the business componentsnode under it to select the business components required (see Figure 7).

Figure 6. Tree displaying the business object names from the application server

Figure 7. Business objects displaying required business components


If you need all of the business components under a business object to begenerated, you may select the business object instead of selecting all of thebusiness components underneath it. After selecting the required business objects orcomponents, click Next.

Confirm the selection of the repository files, business objects,and business components

After you identify all the repository files, business objects, or business componentsto be associated with the generated business object definition, Business ObjectDesigner displays the following confirmation screens (see Figure 8 and Figure 9).

Figure 8. Confirming selection of repository files


These windows provides the following options:v To confirm the selection, click Next.v If the selection is not correct, click Back to return to the previous window and

make the necessary changes. When the selection is correct, click Next.

Generating definitionsAfter you confirm the database objects, the next dialog box informs you thatBusiness Object Designer is generating the definitions.

Figure 10 illustrates this dialog box.

Figure 9. Confirming selection of business objects and business components


Providing additional informationIf the SiebelODA needs additional information, Business Object Designer displaysthe BO Properties window, which prompts you for the information. This is doneonly in the case of business object generation. Figure 11 illustrates this dialog box.

Figure 10. Generating the definition


In the BO Properties window, enter or change the following information:v Prefix—The text that is prepended to the name of the business object to make it

unique. If you are satisfied with the value you entered for the DefaultBOPrefixproperty in the Configure Agent window (Figure 3), you do not need to changethe value here.

v Verbs— Click in the Value field and select one or more verbs from the pop-upmenu. These are the verbs supported by the business object.

Note: If a field in the BO Properties dialog box has multiple values, the fieldappears to be empty when the dialog box first displays. Click in the field todisplay a drop-down list of its values.

Saving definitionsAfter you provide all required information in the BO Properties dialog box andclick OK, Business Object Designer displays the final dialog box in the wizard.Here, you can save the definition to the server or to a file, or you can open thedefinition for editing in Business Object Designer. For more information, and tomake further modifications, see the Business Object Development Guide.

Figure 12 illustrates this dialog box.

Figure 11. Providing additional information


Contents of the generated definitionThe business object definition that SiebelODA generates contains:v An attribute for each column in the specified database tables and viewsv The verbs specified in the BO Properties windowv Application-specific information:

– At the business-object level– For each attribute– For each verb

When generating business objects by getting the information from the Siebelapplication server, the application-specific information generated is for simpleattributes only. The exception to this rule is if the container attribute is amulti-value link. In all other cases, the user must enter the application-specificinformation as described in Chapter 3, “Understanding business objects”, onpage 19.

This section describes:v “Business-object-level properties” on page 47v “Attribute properties” on page 48v “Verbs” on page 49

Business-object-level propertiesSiebelODA generates the following information at the business-object level:v Name of the business objectv Version—defaults to 1.0.0

v Application-specific information

Figure 12. Saving the business object definition


Application-specific information at the business-object level contains the name ofthe corresponding Siebel business object or business component.

Attribute propertiesThis section describes the properties that SiebelODA generates for each attribute.

Important: Any user edits described in the following sections refer to businessobject generation only, not to business object conversion.

Name propertySiebelODA obtains the value of the attribute’s name from the correspondingattribute in the Siebel business component.

Data type propertyWhen setting the type of an attribute, SiebelODA converts the data type of theattribute in the Siebel business component and converts it to the correspondingdata type, as shown in Table 11. This is only in the case of business objectgeneration, since business object conversion is for existing business objects.

Table 11. Correspondence of data types

Application WebSphere businessintegration system

Length

DTYPE_BOOL BOOLEAN

DTYPE_ID,DTYPE_PHONE

STRING Length of corresponding attributein the Siebel application server

DTYPE_TEXTDTYPE_NOTE

DTYPE_DATEDTYPE_TIMEDTYPE_DATETIMEDTYPE_UTCDATETIME

DATE

DTYPE_INTEGERDTYPE_NUMBER

INTEGER

DTYPE_CURRENCY DOUBLE

Note: If an attribute’s data type is not one of those shown in Table 11, SiebelODAskips the column and displays a message stating that the column cannot beprocessed.

Cardinality propertySiebelODA sets the cardinality of all simple attributes to 1 and the containerattributes to n. The user should change the cardinality of the container attributeswherever it is needed. For example, if the container attribute turns out to be aPickList, the user needs to set the cardinality to 1.

MaxLength propertySiebelODA obtains the length of the attribute from the Siebel application server.

IsKey propertyIf the column is a primary key in the table or view, SiebelODA marks it as a keyattribute. In the case of business object generation, the Id attribute is the only onemarked as key by default.


IsRequired propertyIf a field is designated not null in the table or view, SiebelODA marks it as arequired attribute. However, SiebelODA does not mark the key field as requiredbecause the Siebel application generates its own Id values while creating a record.

AppSpecificInfo PropertyThe user should edit this property if container attributes have not been generatedand ensure the correctness if container attributes have been generated.

PollQuantityNumber of rows in the database table that the connector retrieves per pollinginterval. Allowable values are 1 to 500.

The default is 1.

VerbsSiebelODA generates the verbs specified in the BO Properties window. It creates anAppSpecificInfo property for each verb but does not populate it.

Adding information to the business object definitionSince Siebel business objects and business components may not have all theinformation that a business objects requires, it may be necessary to addinformation to the business object definition that SiebelODA creates, especiallywhen generating new business objects.

To examine the business object definition or reload a revised definition into therepository, use Business Object Designer. Alternatively, if ICS is the integrationbroker, you can use the repos_copy command to load the definition into therepository; if WebSphere MQ Integrator Broker is the integration broker, you canuse a system command to copy the file into the repository directory.

Note: Because the calculated fields in Siebel Application do not correspond to acolumn, they are not being generated by the ODA. These fields can bemanually added to the Business Object Definition.



Chapter 5. Using the Siebel connectivity DLL

The Siebel Enterprise Application Integration (EAI) framework provides transportsthat allow Siebel applications to exchange data with external applications. To dothis, the Siebel EAI Dynamic Link Library (DLL) transport invokes the WebSphereIntegration Adapter (WIA) Siebel connectivity DLL which invokes the accessframework interface provided by the ICS Integration Broker. The WebSphereIntegration Adapter Suite consists of adapters for various applications, hence, ICSand the appropriate WBI adapters can process the Siebel generated request sent bythe DLL. The DLL is unidirectional; requests sent from Siebel to the broker (ICS)are processed, and not vice versa.

The following topics are covered in this chapter:v “Connector architecture and processes”v “Configuring the Siebel connectivity DLL” on page 53v “Communicating with the Siebel connectivity DLL” on page 55v “Generating WBIA business objects” on page 55v “Configuring the IBM generic business services” on page 56

Connector architecture and processesIn the context of the Siebel EAI, data is transported in the form of an integrationmessage. In this context, a message typically consists of header data that identifiesthe message type and structure, and a body that contains one or more instances ofdata, such as orders, accounts, or employee records.

The following diagram illustrates the Siebel connector architecture and processes.


The IBM generic Siebel business service is provided as part of the Siebelconnectivity DLL solution. A business service is an object that encapsulates andsimplifies the use of some set of functionality, such as the task of moving data andconverting data formats. Business components and business objects are typicallytied to specific data and tables in the Siebel data model. Alternately, businessservices are not tied to specific objects; they operate or act upon objects to achievea particular goal.

IBM generic business service can be invoked by a workflow or other businessservices. The generic business service receives requests in the form of a propertyset. The XML converter, converts data from property sets to XML string. Duringconversion, the string is stripped of the tags that the WBI DataHandler does notsupport. This stripped down XML string is sent as a property set to the EAI DLLtransport to invoke the send or receive method. The EAI DLL transport adaptersends and receives integration messages to and from the IBM Siebel connectivityDLL.

The EAI DLL transport adapter:

Collaboration

Server accessinterfaceengine

Server accessinterface

(client side)

Siebel workflowengine

(Integrated businessobject)

EAI DLL Transport Adapter

IBM/Siebelconnectivity DLL

IBM WebSphereInterchange Server

Siebel application(EAI framework)

DataHandler

XML converter

IBM generic Siebelbusiness service

Propertyset

XML string

Propertyset

Figure 13. Siebel connector and architecture process


v Allows Siebel applications to exchange data with external applications usingstandard technologies for synchronous communication protocols

v Supports only outbound messagesv Invokes the IBM Siebel connectivity DLLv Is synchronous and waits for a response back after messages are sent before

continuing

To execute the collaboration, the IBM Siebel connectivity DLL makes server accessinterface calls. The collaboration represents the business process that can representmultiple applications. The XML request from Siebel is then converted to WBIbusiness objects using the XML DataHandler.

The interchange server invokes the XML DataHandler through the server accessinterfaces. In this instance, the DataHandler converts the XML input from Siebelinto a generic WBI business object. The resultant message is passed back by theinterchange server to the Siebel connectivity DLL. The connectivity DLL passes themessage to the IBM Siebel generic business service. In the generic business service,the Siebel-specific tags stripped earlier are added back to the message and areconverted back to a Siebel property set using the XML converter service. Themessage is set to the generic Siebel business service’s output property set. At thispoint, the Siebel workflow will pickup the message.

Configuring the Siebel connectivity DLLThe WBI Siebel connectivity DLL is installed as part of the Siebel suite of products.When you are running the WBI CD installation program, choose Siebel for yourinstallation. The installation puts the Siebel connectivity DLL and its componentsin %ProductDir%connectors\Siebel\SiebelEAIAdapter directory. This sectiondescribes how to configure and set up the WBI Siebel connectivity DLL.

Editing the IBMCrossWorlds.cfg fileTo add the [collabdetails] section (the Collaboration Name, Generic BO Name,PortName etc.), you must edit IBMCrossWorlds.cfg file. You can find a copy of thefile in the %ProductDir%connectors\Siebel\SiebelEAIAdapter\Samples directory.The file should contain the items listed in Table 12.

Table 12. IBMCrossWorlds.cfg file contents

Item Description

SERVERNAME Name of your interchange server.

USERNAME Siebel application user name.

PASSWORD Siebel application password.

[CollabDetails] Details for each collaboration that is being used. Forexample, an account object would include:

[CollabDetails]

IntObjName=Account

BOName=NewSiebel_Account

CollabName=SiebelConnectivityObject

PortName=From

[EndCollabDetails]

Chapter 5. Using the Siebel connectivity DLL 53

Copying the filesCopy the following files from the install folder to the %Siebel%/Client/bindirectory:v SiebelConnectivity.DLLv IBMCrossWorlds.cfgv SiebelConnectivityMessages.txt

Generating persistent .ior filesWhen the InterChange Server is started, it generates an .ior file, the persistentobject reference to the interchange server access engine object. The name of the fileis [Server Name] InterChangeServer.ior and can be found in %WBIA%. Copy this fileto the %Siebel%/Client/bin directory. Each time the ICS starts, it generates a new.ior file. To keep the contents of this .ior file the same for every boot of interchangeserver, a persistent .ior file is generated. To have the server generate a persistent.ior file, edit the InterchangeSystem.cfg file, and add a subsection for CORBA, ifone does not already exist.

The CORBA subsection contains the port number in the format:OAport=portnumber. For example, if the port number is 15000, add the followinglines to the InterchangeSystem.cfg file:[CORBA]USERNAME=Siebel Application user nameOAport=15000

If the access client is in the DMZ and InterChange Server is on a different subnet,make sure that the port number for the OAport is open.

Note: For more information on the system guide, copy the [Server Name]InterChangeServer.ior file to the %Siebel%/Client/bin directory.

Generating and copying the WBIA business objectGenerate a WBIA business object definition for every integration object usingXMLborgen or XMLODA. The object generated will be used by the workflowprocess. The business objects generated are automatically loaded into theinterchange server repository.

Configuring the XML DataHandlerThe XML DataHandler is a data-conversion module whose primary role is toconvert business objects to and from XML documents. An XML document isserialized data with the text/xml MIME type. This XML document is called fromwithin the server access interface. To configure the XML DataHandler, theconfiguration information must be provided in the XML child meta-object. For theXML DataHandler, WebSphere business integration system delivers the defaultmeta-object MO_DataHandler_DefaultXMLConfig. Table 13 shows attributescontained in the meta-objects that must be configured.

Table 13. Attributes contained in the meta-object

Attribute Description

BOPrefix The WBIA Business Object Name with the appropriateprefix is given in the configuration file. Hence, thisattribute should be left blank.


Table 13. Attributes contained in the meta-object (continued)

Attribute Description

ClassName The ClassName attribute, by default, will point to XMLDataHandler class that is invoked by the server accessinterface. The default value iscom.crossworlds.DataHandlers.text.xml.

Defining the collaboration templateDefine a collaboration template and create a collaboration object for the businessprocess. For more details on defining collaboration templates and creatingcollaboration objects, refer to the “Collaboration development Guide”.

Importing the business serviceTo import the business service:1. Start the Siebel client.2. Select View—>Site Map—>Business Service Administration—>Business Service

Scripts.3. Import the business service from the file, IBMSiebelConnectivityService.xml,

found under the following folder:%ProductDir%connectors\Siebel\SiebelEAIAdapter\dependencies.

Configuring the Siebel workflowFollow the workflow process set up described in the Siebel documentation andadd the business service trigger. This trigger will call theIBMsiebelConnectivityService into action. The method name needs to be set by theworkflow according to the process that needs to be performed.

Communicating with the Siebel connectivity DLLAs the Siebel Connectivity DLL is a server access client, it uses CORBA tocommunicate with ICS. To ensure that the access client can locate the interchangeserver instance, access to an interoperable object reference file for that interchangeserver instance needs to be provided. For access details, refer to “User setup” onpage 9.

Generating WBIA business objectsSiebel integration objects represent integration metadata for the Siebel businessobject. XML is a common structure that the Siebel EAI infrastructure understands.Because these integration objects adhere to a set of structural conventions, they canbe traversed and transformed programmatically, using Siebel eScript objects,methods, and functions or transformed declaratively using Siebel Data Mapper. Formore information, see the Siebel eBusiness Application Integration, volume IV.

Siebel tools provide the ability to generate the schema or DTD for the integrationobjects. The DTDs generated become the input for the WBI utility, XMLborgen orXMLODA. The WebSphere business integration system business object is generatedfrom the XMLborgen and XMLODA DTD. While executing the XMLborgen, givethe top-level object name as the one which has the string, ListOf, prepended to itsname.


As an example, ListOfChargesData in the DTD, can be found in the file,ListofChargerData.dtd, under the following directory:%ProductDir%connectors/Siebel/Siebel/SiebelEAIAdapter/Samples.

Note: For more information on generating schemas or DTDs, see Siebel IntegrationPlatform Technologies.

Business objects generated by XMLborgen, can be found in the%ProductDir%connectors/Siebel/SiebelEAIAdapter/Samples directory.

Note: Remember to generate the DTD without the Siebel message envelope.However, for this, you need to select the No Envelope option. While passingin the property set, which would have the actual data, you need to send itwith the Siebel message tags, <SiebelMessage> and </SiebelMessage>, andthe <?Siebel-Property-Set...> tag.

Configuring the IBM generic business servicesIBM provides the generic Siebel business service, IBMSiebelConnectivityService aspart of the WBI Siebel EAI Adapter. This business service needs to be part of theSiebel workflow process. The Siebel workflow passes the Siebel property setcontaining the integration object instance (data) to theIBMSiebelConnectivityService. This property set should contain the<SiebelMessage> tag. The Siebel integration object name is obtained from this tag.The IBMSiebelConnectivityService, in turn, will use an instance of the Siebelbusiness service, XML converter, to convert the property sets to XML. After theintegration object name is obtained from the converted XML string, it is stripped ofthe two tags, <SiebelMessage> and </SiebelMessage>, that are not supported bythe WebSphere business integration system Data Handler.

Siebel connectivity DLL supports one method for each of the following verbs:v Createv Retrievev Updatev Delete

The IBMSiebelConnectivityService takes a parameter called MethodName in theService_PreInvokeMethod. This methodname maps to a method in the Siebelconnectivity DLL. Table 14 shows the mapping between the MethodNameparameter and the verb supported by the DLL.

Table 14. Mapping supported by the Siebel connectivity DLL

Method name Verb

Insert Create

Update Update

Retrieve Retrieve

Delete Delete

Once the value of the MethodName is verified by the generic business service, theSiebel request is processed as follows:v The edited XML string is set as part of another property set.


v The EAI DLL transport business service is invoked and the following parametersare set:– MethodName is set to the value of ExternalFunction property– SiebelConnectivity DLL’s name is set to the DLLName property of the same

servicev The SendReceive method of the EAI DLL transport service is then called and the

property set is passed as input. The input property set is passed on to the Siebelconnectivity DLL in the form of a XML string. The Siebel connectivity DLL willthen perform the needed operation through the server access interface calls. Itwill then return the result in the form of XML string back to the generic Siebelbusiness service.

In the generic Siebel business service, the Siebel-specific tags are added back to theresultant XML string that comes back from the connectivity DLL. The edited XMLstring is then converted back to a property set using the instance of XML converterservice again. The result is stored as part of the output property set parameter ofthe IBMSiebelConnectivityService. The Siebel workflow would obtain the samefrom the IBMSiebelConnectivityService and perform the required operation.



Chapter 6. Troubleshooting

This chapter describes error messages that you may encounter when running theconnector and possible fixes for those errors.

MAX_LOG_FILE_SIZE error on UNIXWhen running the connector on UNIX, you may receive the following errormessage:

Using default value UNLIMITED for configuration parameter MAX_LOG_FILE_SIZEin subsystem LOGGING.

This error message may result from the following conditions:v The OS agent is not running.v Incorrect information in the InterchangeSystem.cfg file.v Incompatible connector and InterChange Server versions.

Handling errorsThe Siebel connectivity DLL component of the WBI Siebel EAI adapter returns anerror in the following cases:v Inability to connect to the interchange serverv Inability to open log or trace files for writingv Errors occurring when creating the WebSphere business integration system

business object from input XML messages. This could be the result of incorrectdata formatting in the incoming XML data. In the case of a data error in arequest, the workflow does not stop processing the batch request. To find thefailed requests, the workflow log needs to be looked at to find the failedrequests. After fixing the errors, the request must be sent again. This scenariocan also occur if the Interchange Server goes down while processing the request.The user will have to look at the workflow log to check and see if a series ofrequests have failed. Then, the user will have to verify that the InterchangeServer is up, and the failed requests will need to be resent.

v Errors in executing the collaboration can be caused due to a wrong verb setting,attribute values not having the correct formatting, or if the external applicationor Interchange Server goes down. This could also happen if the collaborationdoes not exist or is not up. The user will have to ensure that the externalapplication is up and the Interchange Server is up prior to analyzing the causeof the error. The user will have to look at the DLL log and trace files to find thecause of the error, fix the error and send the request again.

v Unable to open log or trace files for writing.v There are error scenarios in which the Siebel Connectivity DLL has no control.

For example, consider the scenario in which the WebSphere business integrationsystem business object has been built and sent to the collaboration forprocessing, the results have been returned to the DLL and the Siebel applicationtriggering the workflow is down. In addition, the request has already been sentout and processed by the external application. In this case, the user will have tocheck for the requests processed prior to the application shut down. Also, the


user needs to verify that the request processing has succeeded in the externalapplication. If anything in the batch needs to be sent again, the same needs to behandled on an individual request basis.

For all the above cases excluding the last one, the connectivity DLL returns anerror message in an XML message. The error message is enclosed in the tags<Error> and </Error>. The generic business adds the Siebel specific tags to theerror message, then, converts it to a property set by calling the XML converterservice. All error messages from the generic business service needs to be handledby the workflow from which it was invoked.

The Siebel connectivity DLL logs the trace and error messages to theSiebelConnectivityTrace.txt file created in the Siebel\Client\bin folder.


Appendix A. Standard configuration properties for connectors

Connectors have two types of configuration properties:v Standard configuration propertiesv Connector-specific configuration properties

This chapter describes standard configuration properties, applicable to allconnectors. For information about properties specific to the connector, see theinstalling and configuring chapter of its adapter guide.

The connector uses the following order to determine a property’s value (where thehighest numbers override the value of those that precede):1. Default2. Repository (relevant only if InterChange Server is the integration broker)3. Local configuration file4. Command line

Note: In this document backslashes (\) are used as the convention for directorypaths. For UNIX installations, substitute slashes (/) for backslashes and obeythe appropriate operating system-specific conventions.

New and deleted propertiesThe following are the standard properties that have been either added or deletedin the 2.2 release of the adapters.v New properties

CharacterEncodingLocalJVMMinHeapSizeJVMMaxHeapSizeJVMMaxStackSizeWireFormatMaxEventCapacityDuplicateEventEliminationjms.NumConcurrentRequestsContainerManagedEventsjms.Messagebrokername (replaces jms.BrokerName)

v Deleted properties

RequestTransportPingFrequencyTraceLevelAgentProxyTypeMaxThreadPoolSizeAnonymous ConnectionsGW NameAgent URL


Listener PortCertificate LocationLogFileNameTraceFileNamejms.BrokerName

Configuring standard connector properties for WebSphere InterChangeServer

This section describes standard configuration properties applicable to connectorswhose integration broker is WebSphere InterChange Server (ICS). Standardconfiguration properties provide information that is used by a configurablecomponent of InterChange Server called the connector controller. Like theconnector framework, the code for the connector controller is common to allconnectors. However, you configure a separate instance of the controller for eachconnector.

A connector, which consists of the connector framework and theapplication-specific component, has been referred to historically as the connectoragent. When a standard configuration property refers to the agent, it is referring toboth the connector framework and the application-specific component.

For general information about how connectors work with InterChange Server, seethe Technical Introduction to IBM WebSphere InterChange Server.

Important: Not all properties are applicable to all connectors that use InterChangeServer. For information specific to an connector, see its adapter guide.

You configure connector properties from Connector Configurator, which you accessfrom System Manager.

Note: Connector Configurator and System Manager run only on the Windowssystem. Even if you are running the connector on a UNIX system, you muststill have a Windows machine with these tools installed. Therefore, to setconnector properties for a connector that runs on UNIX, you must start upSystem Manager on the Windows machine, connect to the UNIXInterChange Server, and bring up Connector Configurator for the connector.

A connector obtains its configuration values at startup. If you change the value ofone or more connector properties during a runtime session, the property’s updatesemantics determine how and when the change takes effect. There are fourdifferent types of update semantics for standard connector properties:v Dynamic—The change takes effect immediately after it is saved.v Component restart—The change takes effect only after the connector is stopped

and then restarted in System Manager. This does not require stopping andrestarting the application-specific component or InterChange Server.

v Server restart—The change takes effect only after you stop and restart theapplication-specific component and InterChange Server.

v Agent restart—The change takes effect only after you stop and restart theapplication-specific component.


To determine the update semantics for a specific property, refer to the UpdateMethod column in the Connector Configurator window, or see the Update Methodcolumn of the table below.

The following table provides a quick reference to the standard connectorconfiguration properties. You must set the values of some of these propertiesbefore running the connector. See the sections that follow for explanations of theproperties.

Property Name Possiblevalues

Defaultvalue

Updatemethod

Notes

AdminInQueue valid JMS queue name CONNECTORNAME /ADMININQUEUE

AdminOutQueue valid JMS queue name CONNECTORNAME/ADMINOUTQUEUE

AgentConnections 1-4 1 server restart multi-threadedconnector only

AgentTraceLevel 0-5 0 dynamicApplicationName application name the value that is specified for the

connector namecomponentrestart

value required

BrokerType ICS, WMQI ICS is requiredif your brokeris ICS

CharacterEncoding ascii7, ascii8, SJIS,Cp949, GBK, Big5,Cp297,Cp273,Cp280,Cp284,Cp037, Cp437

ascii7 componentrestart

ConcurrentEventTriggeredFlows 1 to 32,767 no value componentrestart

ContainerManagedEvents JMS or no value JMS guaranteedevent delivery

ControllerStoreAndForwardMode true or false true dynamicControllerTraceLevel 0-5 0 dynamicDeliveryQueue CONNECTORNAME/DELIVERYQUEUE component

restartJMS transportonly

DeliveryTransport MQ, IDL, or JMS IDL componentrestart

FaultQueue CONNECTORNAME/FAULTQUEUE componentrestart

DuplicateEventElimination True/False False componentrestart

JMS transportonly,ContainerManagedEvents mustbe <NONE>

JvmMaxHeapSize heap size in megabytes 128m componentrestart

JvmMaxNativeHeapSize size of stack in kilobytes 128k componentrestart

JvmMinHeapSize heap size in megabytes 1m componentrestart

jms.MessageBrokerName If FactoryClassName isIBM, usecrossworlds.queue.manager. IfFactoryClassName isSonic, uselocalhost:2506.

crossworlds.queue.manager server restart JMS transportonly

jms.FactoryClassName CxCommon.Messaging.jms.IBMMQSeriesFactory orCxCommon.Messaging.jms.SonicMQFactory orany Java class name

CxCommon.Messaging.jms.IBMMQSeriesFactory

server restart JMS transportonly

jms.NumConcurrentRequests positive integer 10 componentrestart

JMS transportonly

Appendix A. Standard configuration properties for connectors 63


Defaultvalue

Updatemethod

Notes

jms.Password Any valid password server restart JMS transportonly

jms.UserName Any valid name server restart JMS transportonly

Locale en_US , ja_JP, ko_KR, zh_C,zh_T, fr_F, de_D, it_I,es_E, pt_BRNote: These are only asubset of supportedlocales.

en_US componentrestart

LogAtInterchangeEnd true or false false componentrestart

MaxEventCapacity 1-2147483647 2147483647 dynamic RepositoryDirectoryvalue must be<REMOTE>

MessageFileName path/filename Connectorname.txt orInterchangeSystem.txt

componentrestart

MonitorQueue any valid queue name CONNECTORNAME/MONITORQUEUE componentrestart

JMS transportonly, DuplicateEventEliminationmust be True

OADAutoRestartAgent true or false false dynamicOADMaxNumRetry a positive number 1000 dynamicOADRetryTimeInterval a positive number in

minutes10 dynamic

PollEndTime HH:MM HH:MM componentrestart

PollFrequency a positive integer inmilliseconds

no (to disable polling) key(to poll only when theletter p is entered in theconnector’s CommandPrompt window)

10000 dynamic

PollQuantity 1-500 1 componentrestart

Number ofitems to pollfromapplication

PollStartTime HH:MM(HH is 0-23, MM is0-59)

HH:MM componentrestart

RepositoryDirectory location where repositoryis located

<REMOTE> componentrestart

<REMOTE>for ICS broker

RequestQueue valid JMS queue name CONNECTORNAME/REQUESTQUEUE componentrestart

ResponseQueue valid JMS queue name CONNECTORNAME/RESPONSEQUEUE componentrestart

RestartRetryCount 0-99 3 dynamicRestartRetryInterval a sensible positive value in

minutes1 dynamic

SourceQueue valid MQSeries queue name CONNECTORNAME/SOURCEQUEUE componentrestart

Valid only ifdeliverytransport isJMS andContainerManagedEvents isspecified.

SynchronousRequestQueue CONNECTORNAME/SYNCHRONOUSREQUESTQUEUE

componentrestart



Defaultvalue

Updatemethod

Notes

“SynchronousResponseQueue” onpage 80

CONNECTORNAME/SYNCHRONOUSRESPONSEQUEUE

componentrestart

SynchronousRequestTimeout 0 componentrestart

“WireFormat” on page 81 CwXML, CwBO cwxml agent restart CwXML fornon-ICSbroker; CwBOif RepositoryDirectory is<REMOTE>

AdminInQueueThe queue that is used by the integration broker to send administrative messagesto the connector.

The default value is CONNECTORNAME/ADMININQUEUE.

AdminOutQueueThe queue that is used by the connector to send administrative messages to theintegration broker.

The default value is CONNECTORNAME/ADMINOUTQUEUE.

AgentConnectionsThe AgentConnections property controls the number of IIOP connections openedfor request transport between an application-specific component and its connectorcontroller. By default, the value of this property is set to 1, which causesInterChange Server to open a single IIOP connection.

This property enhances performance for a multi-threaded connector by allowingmultiple connections between the connector controller and application-specificcomponent. When there is a large request/response workload for a particularconnection, the IBM WebSphere administrator can increase this value to enhanceperformance. Recommended values are in the range of 2 to 4. Increasing the valueof this property increases the scalability of the Visigenic software, which establishesthe IIOP connections. You must restart the application-specific component and theserver for a change in property value to take effect.

Important: If a connector is single-threaded, it cannot take advantage of themultiple connections. Increasing the value of this property causes therequest transport to bottleneck at the application-specific component.To determine whether a specific connector is single- or multi-threaded,see the installing and configuring chapter of its adapter guide.

AgentTraceLevelLevel of trace messages for the application-specific component. The default is 0.The connector delivers all trace messages applicable at the tracing level set orlower.


ApplicationNameName that uniquely identifies the connector’s application. This name is used bythe system administrator to monitor the WebSphere business integration systemenvironment. This property must have a value before you can run the connector.

BrokerTypeIdentifies the integration broker type that you are using. If you are using an ICSconnector, this setting must be ICS.

CharacterEncodingSpecifies the character code set used to map from a character (such as a letter ofthe alphabet, a numeric representation, or a punctuation mark) to a numeric value.

Note: Java-based connectors do not use this property. A C++ connector currentlyuses the value ASCII for this property. If you previously configured thevalue of this property to ascii7 or ascii8, you must reconfigure theconnector to use either ASCII or one of the other supported values. Todetermine whether a specific connector is written in Java or C++, see theinstalling and configuring chapter of its adapter guide.

Important: By default only a subset of supported character encodings display inthe drop list. To add other supported values to the drop list, you mustmanually modify the \Data\Std\stdConnProps.xml file in the productdirectory. For more information, see the appendix on ConnectorConfigurator.

Attention: Do not run a non-internationalized connector against InterChangeServer version 4.1.1 if you cannot guarantee that only ISO Latin-1 data will beprocessed.

The default value is ascii.

ConcurrentEventTriggeredFlowsDetermines how many business objects can be concurrently processed by theconnector controller for event delivery. Set the value of this attribute to the numberof business objects you want concurrently mapped and delivered. For example, setthe value of this property to 5 to cause five business objects to be concurrentlyprocessed. The default value is 1.

Setting this property to a value greater than 1 allows a connector controller for asource application to simultaneously map multiple event business objects, and tosimultaneously deliver them to multiple collaboration instances. Setting thisproperty to enable concurrent mapping of multiple business objects can speeddelivery of business objects to a collaboration, particularly if the business objectsuse complex maps. Increasing the arrival rate of business objects to collaborationscan improve overall performance in the system.

Note: To implement concurrent processing for an entire flow (from a sourceapplication to a destination application) also requires that the collaborationbe configured to use multiple threads and that the destination application’sapplication-specific component be able to process requests concurrently. Toconfigure the collaboration, set its Maximum number of concurrent eventsproperty high enough to use multiple threads. For an application-specificcomponent to process requests concurrently, it must be either


multi-threaded, or be capable of using Connector Agent Parallelism and beconfigured for multiple processes (setting the Parallel Process Degreeconfiguration property greater than 1).

Important: To determine whether a specific connector is single- or multi-threaded,see the installing and configuring chapter of its adapter guide.

The ConcurrentEventTriggeredFlows property has no effect on connector polling,which is single-threaded and performed serially.

ContainerManagedEventsSetting this property to JMS allows a JMS-enabled connector with a JMS eventstore to provide guaranteed event delivery, in which an event is removed from thesource queue and placed on the destination queue as a single JMS transaction. Thisproperty can also be set to no value.

Notes:

1. When ContainerManagedEvents is set to JMS, you must also configure thefollowing properties to enable guaranteed event delivery: PollQuantity = 1 to500, SourceQueue = SOURCEQUEUE. In addition, you must configure a datahandler with the MimeType, DHClass, and DataHandlerConfigMOName(optional) properties. To set those values, use the Data Handler tab ofConnector Configurator. The fields for the values under the Data Handler tabwill be displayed only if you have set ContainerManagedEvents to JMS.

2. When ContainerManagedEvents is set to JMS, the connector does not call itspollForEvents() method, thereby disabling that method’s functionality.

The default value is JMS.

This property only appears if the DeliveryTransport property is set to the valueJMS.

ControllerStoreAndForwardModeSets the behavior of the connector controller after it detects that the destinationapplication-specific component is unavailable. If this property is set to true and thedestination application-specific component is unavailable when an event reachesInterChange Server, the connector controller blocks the request to theapplication-specific component. When the application-specific component becomesoperational, the controller forward the request to it.

Important: If the destination application’s application-specific component becomesunavailable after the connector controller forwards a service callrequest to it, the connector controller fails the request.

If this property is set to false, the connector controller begins failing all servicecall requests as soon as it detects that the destination application-specificcomponent is unavailable.

The default is true.

ControllerTraceLevelLevel of trace messages for the connector controller. The default is 0.


DeliveryQueueThe queue that is used by the connector to send business objects to the integrationbroker.

The default value is DELIVERYQUEUE.

DeliveryTransportSpecifies the transport mechanism for the delivery of events. Possible values are MQfor WebSphere MQ, IDL for CORBA IIOP, or JMS for Java Messaging Service.

If ICS is the broker type, the value of the DeliveryTransport property can be MQ,IDL, or JMS, and the default is IDL.

If WMQI is the broker type, JMS is the only possible Delivery Transport value.

The connector sends service call requests and administrative messages overCORBA IIOP if the value configured for the DeliveryTransport property is MQ orIDL.

WebSphere MQ and IDLUse WebSphere MQ rather than IDL for event delivery transport, unless you havecompelling reasons not to license and maintain two separate products. WebSphereMQ offers the following advantages over IDL:v Asynchronous communication – WebSphere MQ allows the application-specific

component to poll and persistently store events even when the server is notavailable.

v Server side performance – WebSphere MQ provides faster performance on theserver side. In optimized mode, WebSphere MQ stores only the pointer to anevent in the repository database, while the actual event remains in theWebSphere MQ queue. This saves the overhead of having to write potentiallylarge events to the repository database.

v Agent side performance – WebSphere MQ provides faster performance on theapplication-specific component side. Using WebSphere MQ, the connector’spolling thread picks up an event, places it in the connector’s queue, then picksup the next event. This is faster than IDL, which requires the connector’s pollingthread to pick up an event, go over the network into the server process, storethe event persistently in the repository database, then pick up the next event.

JMSEnables communication between the connector controller and client connectorframework using Java Messaging Service (JMS).

If you select JMS as the delivery transport, additional JMS properties such as″jms.MessageBrokerName,″ ″jms.FactoryClassName,″ ″jms.Password,″ and″jms.UserName,″ display in Connector Configurator. The first two of theseproperties are required for this transport.

Important: There may be a memory limitation if you use the JMS transportmechanism for a connector in the following environment:

v AIX 5.0v WebSphere MQ 5.3.0.1v InterChange Server (ICS) as the Integration broker


In this environment, you may experience difficulty starting the both the connectorcontroller (on the server side) and the connector (on the client side) due to memoryuse within the WebSphere MQ client. If your installation uses less than 768M ofprocess heap size, IBM recommends that you set:v The LDR_CNTRL environment variable in the CWSharedEnv.sh script.

This script resides in the \bin directory below the product directory. With a texteditor, add the following line as the first line in the CWSharedEnv.sh script:export LDR_CNTRL=MAXDATA=0x30000000

This line restricts heap memory usage to a maximum of 768 MB (3 segments *256 MB). If the process memory grows more than this limit, page swapping canoccur, which can adversely affect the performance of your system.

v The IPCCBaseAddress property to a value of 11 or 12. For more information onthis property, see the System Installation Guide for UNIX.

Notes:

v If your installation uses more than 768M of process heap size, this resolutionwould adversely affect product performance.

v If you run on AIX 4.3.3, you do not need to set the LDR_CNTRL environmentvariable. However, you must set IPCCBaseAddress to a value of 11 or 12.

DuplicateEventEliminationSetting this property to true enables a JMS-enabled connector to ensure thatduplicate events are not delivered to the delivery queue. To make use of thisfeature, during connector development a unique event identifier must be set as thebusiness object’s ObjectEventId attribute in the application specific code.

This property can also be set to false.

Note: When DuplicateEventElimination is set to true, you must also configure theMonitorQueue property to enable guaranteed event delivery.

FaultQueueIf the connector experiences an error while processing a message then theconnector moves the message to the queue specified in this property, along with astatus indicator and a description of the problem.

The default value is CONNECTORNAME/FAULTQUEUE.

JvmMaxHeapSizeThe maximum heap size for the agent (in megabytes). This property is applicableonly if the RepositoryDirectory value is <REMOTE>.

The default value is 128m.

JvmMaxNativeStackSizeThe maximum native stack size for the agent (in kilobytes). This property isapplicable only if the RepositoryDirectory value is <REMOTE>.

The default value is 128k.


JvmMinHeapSizeThe minimum heap size for the agent (in megabytes). This property is applicableonly if the RepositoryDirectory value is <REMOTE>.

The default value is 1m.

jms.FactoryClassNameSpecifies the class name to instantiate for a JMS provider. You must set thisconnector property when you choose JMS as your delivery transport mechanism(DeliveryTransport).

The default is CxCommon.Messaging.jms.IBMMQSeriesFactory.

jms.MessageBrokerNameSpecifies the broker name to use for the JMS provider. You must set this connectorproperty when you choose JMS as your delivery transport mechanism(DeliveryTransport).

The default is crossworlds.queue.manager.

jms.NumConcurrentRequestsSpecifies the maximum number of concurrent service call requests that can be sentto a connector at the same time. Once that maximum is reached, new service callsblock and wait for another request to complete before proceeding.

The default value is 10.

jms.PasswordSpecifies the password for the JMS provider. A value for this property is optional.

There is no default.

jms.UserNameSpecifies the user name for the JMS provider. A value for this property is optional.


LocaleSpecifies the language code, country or territory, and, optionally, the associatedcharacter code set. The value of this property determines such cultural conventionsas collation and sort order of data, date and time formats, and the symbols used inmonetary specifications. For more information, see the overview chapter of theconnector guide for an internationalized connector.

A locale name has the following format:ll_TT.codeset

where:

ll a two-character language code (usually in lowercase)


TT a two-letter country or territory code (usually inupper case)

codeset the name of the associated character code set; thisportion of the name is often optional.

The default is en_US.

Important: By default only a subset of supported locales display in the drop list.To add other supported values to the drop list, you must manuallymodify the \Data\Std\stdConnProps.xml file in the product directory.For more information, see the appendix on Connector Configurator.

Attention: If the connector has not been internationalized, the only valid valuefor this property is en_US. Do not run a non-internationalized C++ connectoragainst InterChange Server version 4.1.1 if you cannot guarantee that only ISOLatin-1 data will be processed. To determine whether a specific connector has beeninternationalized, see the installing and configuring chapter of its connector guide.

LogAtInterchangeEndSpecifies whether to log errors to InterChange Server’s log destination, in additionto the location specified in the LogFileName property. Logging to the server’s logdestination also turns on email notification, which generates email messages forthe MESSAGE_RECIPIENT specified in the InterchangeSystem.cfg file when errors orfatal errors occur. As an example, when a connector loses its connection to itsapplication, if LogAtInterChangeEnd is set to true, an email message is sent to thespecified message recipient. The default is false.

MaxEventCapacityThe maximum number of events in the controller buffer. This property is used byflow control and is applicable only if the value of the RepositoryDirectory propertyis <REMOTE>.

The value can be a positive integer between 1 and 2147483647. The default value is2147483647.

MessageFileNameThe name of the connector message file. The standard location for the message fileis \connectors\messages. Specify the message filename in an absolute path if themessage file is not located in the standard location.

If a connector message file does not exist, the connector usesInterchangeSystem.txt as the message file. This file is located in the productdirectory.

Important: To determine whether a specific connector has its own message file, seethe installing and configuring chapter of its adapter guide.

OADAutoRestartAgentSpecifies whether the Object Activation Daemon (OAD) automatically attempts torestart the application-specific component after an abnormal shutdown. Theproperties “OADMaxNumRetry” on page 72 and “OADRetryTimeInterval” onpage 72 are related to this property. This property is required for automatic restart.


The default value is false.

OADMaxNumRetrySpecifies the maximum number of times that the OAD automatically attempts torestart the application-specific component after an abnormal shutdown.


OADRetryTimeIntervalSpecifies the number of minutes of the retry time interval that the OADautomatically attempts to restart the application-specific component after anabnormal shutdown. If the application-specific component does not start within thespecified interval, the OAD repeats the attempt as many times as specified in“OADMaxNumRetry”.

The default is 10.

PollEndTimeTime to stop polling the event queue. The format is HH:MM, where HH represents0-23 hours, and MM represents 0-59 seconds.

You must provide a valid value for this property. The default value is HH:MM, butmust be changed.

PollFrequencyThe amount of time between polling actions. Set PollFrequency to one of thefollowing values:v The number of milliseconds between polling actions.v The word key, which causes the connector to poll only when you type the letter

p in the connector’s Command Prompt window. Enter the word in lowercase.v The word no, which causes the connector not to poll. Enter the word in

lowercase.

The default is 10000.

Important: Some connectors have restrictions on the use of this property. Todetermine whether a specific connector does, see the installing andconfiguring chapter of its adapter guide.

PollStartTimeThe time to start polling the event queue. The format is HH:MM, where HH represents0-23 hours, and MM represents 0-59 seconds.


RequestQueueThe queue that is used by the integration broker to send business objects to theconnector.

The default value is REQUESTQUEUE.


RepositoryDirectoryThe location of the repository from which the connector reads the XML schemadocuments that store the meta-data of business object definitions.

When the integration broker is ICS, this value must be set to <REMOTE> becausethe connector uses the InterChange Server repository to obtain itsconnector-definition information

ResponseQueueDesignates the JMS response queue, which delivers a response message from theconnector framework to the integration broker. When the integration broker isInterChange Server, InterChange Server sends the request and waits for a responsemessage in the JMS response queue.

RestartRetryCountSpecifies the number of times the connector attempts to restart itself. When usedfor a parallel connector, specifies the number of times the master connectorapplication-specific component attempts to restart the slave connectorapplication-specific component.

The default is 3.

RestartRetryIntervalSpecifies the interval in minutes at which the connector attempts to restart itself.When used for a parallel connector, specifies the interval at which the masterconnector application-specific component attempts to restart the slave connectorapplication-specific component.

The default is 1.

SourceQueueDesignates the JMS source queue for the connector framework in support ofguaranteed event delivery for JMS-enabled connectors that use a JMS event store.For further information, see “ContainerManagedEvents” on page 67.

The default value is SOURCEQUEUE.

SynchronousRequestQueueDelivers request messages that require a synchronous response from the connectorframework to the broker. This queue is necessary only if the connector usessynchronous execution. With synchronous execution, the connector frameworksends a message to the SynchronousRequestQueue and waits for a response backfrom the broker on the SynchronousResponseQueue. The response message sent tothe connector bears a correlation ID that matches the ID of the original message.

SynchronousResponseQueueDelivers response messages sent in reply to a synchronous request from the brokerto the connector framework. This queue is necessary only if the connector usessynchronous execution.


SynchronousRequestTimeoutSpecifies the time in minutes that the connector waits for a response to asynchronous request. If the response is not received within the specified time thenthe connector moves the original synchronous request message into the fault queuealong with an error message.


TraceFileNameThe name of the file where the application-specific component writes tracemessages. Specify the filename in an absolute path. The default is STDOUT.

WireFormatMessage format on the transport.

Possible values are:v CwXMLif the broker is not ICS.v CwBOif the value of RepositoryDirectory is <REMOTE>.

Configuring standard connector properties for WebSphere MQIntegrator

This section describes standard configuration properties applicable to adapterswhose integration broker is WebSphere MQ Integrator Broker. For information onusing WebSphere Integrator Broker, see the Implementation Guide for WebSphere MQIntegrator Broker.

Important: Not all properties are applicable to all connectors that use WebSphereMQ Integrator Broker. For information specific to a connector, see itsadapter user guide.

You configure connector properties from Connector Configurator.

Note: Connector Configurator runs only on the Windows system. Even if you arerunning the connector on a UNIX system, you must still have a Windowsmachine with this tool installed. Therefore, to set connector properties for aconnector that runs on UNIX, you must run Connector Configurator on theWindows computer and copy the configuration files to the UNIX computerusing FTP or some other file transfer mechanism. For more informationabout Connector Configurator, see Appendix B, ″Connector Configurator.″

A connector obtains its configuration values at startup. If you change the value ofone or more connector properties during a runtime session, you must restart theconnector. Standard configuration properties provide information that is used bythe adapter framework and connector framework, and is common to allconnectors.

Standard connector propertiesThe following table provides a quick reference for standard connectorconfiguration properties. See the sections that follow for explanations of theproperties.


Name Possible values Default value

AdminInQueue valid JMS queue name CONNECTORNAME/ADMININQUEUEAdminOutQueue valid WebSphere MQ

queue nameCONNECTORNAME/ADMINOUTQUEUE

AgentTraceLevel 0-5 0ApplicationName application name AppNameConnectorBrokerType WMQI WMQICharacterEncoding ASCII, SJIS, Cp949, GBK,

Big5, Cp297, Cp273,Cp280, Cp284, Cp037,Cp437Note: These are only asubset of supportedvalues.

ASCII

ContainerManagedEvents JMS or no value JMSDeliveryQueue valid WebSphere MQ

queue nameCONNECTORNAME/DELIVERYQUEUE

DeliveryTransport JMS JMSDuplicateEventElimination true, falseFaultQueue valid WebSphere MQ

queue nameCONNECTORNAME/FAULTQUEUE

jms.FactoryClassName CxCommon.Messaging.jms.IBMMQSeriesFactory

jms.MessageBrokerName If FactoryClassName isIBM, usecrossworlds.queue.manager.If FactoryClassName isSonic, uselocalhost:2506.

crossworlds.queue.manager

jms.NumConcurrentRequests 10jms.Passwordjms.UserNameLocale en_US , ja_JP, ko_KR,

zh_C, zh_T, fr_F, de_D,it_I, es_E, pt_BRNote: These are only asubset of supportedlocales.

en_US

MessageFileName path/filename InterchangeSystem.txtPollEndTime HH:MM HH:MMPollFrequency milliseconds/key/no 10000PollStartTime HH:MM HH:MMRepositoryDirectory path/directory name Note:

Typically you mustchange this value fromthe default to whateverpath and directory namewas actually used whenyou installed the theconnector files.

C:\crossworlds\Repository

RequestQueue valid WebSphere MQqueue name

CONNECTORNAME/REQUESTQUEUE

ResponseQueue RESPONSEQUEUERestartRetryCount 0-99 3RestartRetryInterval an appropriate integer

indicating the number ofminutes between restartattempts

1


Name Possible values Default value

SourceQueue valid WebSphere MQqueue name

CONNECTORNAME/SOURCEQUEUE

SynchronousRequestQueue valid WebSphere MQqueue name

SynchronousResponseQueue valid WebSphere MQqueue name

SynchronousTimeout an appropriate integerindicating the number ofminutes the connectorwaits for a response to asynchronous request

0

WireFormat CwXML CwXML

AdminInQueueThe queue that is used by the integration broker to send administrative messagesto the connector.

The default value is CONNECTORNAME/ADMININQUEUE.

AdminOutQueueThe queue that is used by the connector to send administrative messages to theintegration broker.

AgentTraceLevelLevel of trace messages for the connector’s application-specific component. Thedefault is 0. The connector delivers all trace messages applicable at the tracinglevel set or lower.

ApplicationNameName that uniquely identifies the connection to the application. This name is usedby the system administrator to monitor the connector’s environment. When youcreate a new connector definition, this property defaults to the name of theconnector; when you work with the definition for an IBM WebSphere-deliveredconnector, the property is also likely to be set to the name of the connector. Set theproperty to a value that suggests the program with which the connector isinterfacing, such as the name of an application, or something that identifies a filesystem or website in the case of technology connectors.

BrokerTypeThis property is set to the value WMQI for connectors that are configured to useWebSphere MQ Integrator Broker as the integration broker.

CharacterEncodingSpecifies the character code set used to map from a character (such as a letter ofthe alphabet, a numeric representation, or a punctuation mark) to a numeric value.

Note: Java-based connectors do not use this property. A C++ connector currentlyuses the value ASCII for this property. If you previously configured thevalue of this property to ascii7 or ascii8, you must reconfigure theconnector to use either ASCII or one of the other supported values. Todetermine whether a specific connector is written in Java or C++, see theinstalling and configuring chapter of its adapter guide.

Important: By default only a subset of supported character encodings display inthe drop list. To add other supported values to the drop list, you must


manually modify the \Data\Std\stdConnProps.xml file in the productdirectory. For more information, see the appendix on ConnectorConfigurator.

Attention: Do not run a non-internationalized connector against InterChangeServer version 4.1.1 if you cannot guarantee that only ISO Latin-1 data will beprocessed.

The default value is ascii.

ContainerManagedEventsSetting this property to JMS enables a JMS-enabled connector with a JMS eventstore to provide guaranteed event delivery, in which an event is removed from thesource queue and placed on the destination queue as a single JMS transaction. Thisproperty can also be set to no value.

Notes:

1. When ContainerManagedEvents is set to JMS, you must also configure thefollowing properties to enable guaranteed event delivery: PollQuantity = 1 to500, SourceQueue = SOURCEQUEUE. In addition, you must configure a datahandler with the MimeType, DHClass, and DataHandlerConfigMOName(optional) properties.

2. When ContainerManagedEvents is set to JMS, the connector does not call itspollForEvents() method, thereby disabling that method’s functionality.

The default value is JMS.

DeliveryQueueThe queue that is used by the connector to send business objects to the integrationbroker.

The default value is CONNECTORNAME/DELIVERYQUEUE.

DeliveryTransportSpecifies the transport mechanism for the delivery of events. The property defaultsto the value JMS, indicating that the Java Messaging Service (JMS) is used forcommunication with WebSphere MQ Integrator. This property must be set to JMSwhen WebSphere MQ Integrator Broker is the integration broker. Otherwise, theconnector cannot start.

DuplicateEventEliminationSetting this property to true enables a JMS-enabled connector to ensure thatduplicate events are not delivered to the delivery queue. To make use of thisfeature, during connector development a unique event identifier must be set as thebusiness object’s ObjectEventId attribute in the application specific code.

This property can also be set to false.

Note: When DuplicateEventElimination is set to true, you must also configure theMonitorQueue property to enable guaranteed event delivery.

FaultQueueIf the connector experiences an error while processing a message then theconnector moves the message to the queue specified in this property, along with astatus indicator and a description of the problem.

The default value is CONNECTORNAME/FAULTQUEUE.


jms.FactoryClassNameSpecifies the class name to instantiate for a JMS provider.

The default is CxCommon.Messaging.jms.IBMMQSeriesFactory.

jms.MessageBrokerNameSpecifies the broker name to use for the JMS provider.

The default is crossworlds.queue.manager.

jms.NumConcurrentRequestsSpecifies the maximum number of concurrent service call requests that can be sentto a connector at the same time. Once that maximum is reached, new service callsblock and wait for another request to complete before proceeding.


jms.PasswordSpecifies the password for the JMS provider. A value for this property is optional.


jms.UserNameSpecifies the user name for the JMS provider. A value for this property is optional.


LocaleSpecifies the language code, country or territory, and, optionally, the associatedcharacter code set. The value of this property determines such cultural conventionsas collation and sort order of data, date and time formats, and the symbols used inmonetary specifications. For more information, see the overview chapter of theconnector guide for an internationalized connector.

A locale name has the following format:ll_TT.codeset

where:

ll a two-character language code (usually in lowercase)

TT a two-letter country or territory code (usually inupper case)

codeset the name of the associated character code set; thisportion of the name is often optional.

The default is en_US.

Important: By default only a subset of supported locales display in the drop list.To add other supported values to the drop list, you must manuallymodify the \Data\Std\stdConnProps.xml file in the product directory.


Attention:

v WebSphere MQ Integrator supports only one locale at a time. Ensure that everycomponent of the installation (for example, all adapters, applications, and theintegration broker itself) is set to the same locale.

v If the connector has not been internationalized, the only valid value for thisproperty is en_US. Do not run a non-internationalized C++ connector againstInterChange Server version 4.1.1 if you cannot guarantee that only ISO Latin-1data will be processed. To determine whether a specific connector has beeninternationalized, see the installing and configuring chapter of its connectorguide.

MessageFileNameThe name of the connector message file. The standard location for the message fileis \connectors\messages. Specify the message filename in an absolute path if themessage file is not located in the standard location. This property defaults to thevalue InterchangeSystem.txt for new connector definitions and should be changedto the name of the message file for the specific connector.

PollEndTimeTime to stop polling the event queue. The format is HH:MM, where HH represents0-23 hours, and MM represents 0-59 seconds.


PollFrequencyThe amount of time between polling actions. Set the PollFrequency to one of thefollowing values:v The number of milliseconds between polling actions.v The word key, which causes the connector to poll only when you type the letter

p in the connector’s Command Prompt window. Enter the word in lowercase.v The word no, which causes the connector not to poll. Enter the word in

lowercase.

The default is 10000.

Important: Some connectors have restrictions on the use of this property. Todetermine whether a specific connector does, see the installing andconfiguring chapter of its adapter guide.

PollStartTimeThe time to start polling the event queue. The format is HH:MM, where HH represents0-23 hours, and MM represents 0-59 seconds.


RepositoryDirectoryThe path and name of the directory from which the connector reads the XMLschema documents that store the meta-data of business object definitions.

The default value is C:\crossworlds\repository. You must change this to thedirectory path that you are using for the \repository directory for your connector.Typically that path is established when you install the adapter product; for


example, C:\WebSphereAdapters\repository. The value must be a directory path.Do not use <REMOTE> as the RepositoryDirectory value for a connector that isnot using ICS as the broker.

RequestQueueThe queue that is used by the integration broker to send business objects to theconnector.

The default value is CONNECTORNAME/REQUESTQUEUE.

ResponseQueueDesignates the JMS response queue, which delivers a response message from theconnector framework to the integration broker.

RestartRetryCountSpecifies the number of times the connector attempts to restart itself. The defaultvalue is 3, indicating that the connector tries to restart 3 times. For instance, if aconnector is unable to log in to an application it fails to start, but with thisproperty set to the value 3 the connector tries a total of three times to start. Whenused in conjunction with the “RestartRetryInterval” property, this behavior enablesa connector to make several attempts at communicating with an application thatmight not reliably have a connection available all the time.

RestartRetryIntervalSpecifies the interval in minutes at which the connector attempts to restart itself.The default value is 1, indicating that the connector waits 1 minute in between itsrestart attempts.

SourceQueueDesignates the JMS source queue for the connector framework in support ofguaranteed event delivery for JMS-enabled connectors that use a JMS event store.For further information, see “ContainerManagedEvents” on page 67.

The default is CONNECTORNAME/SOURCEQUEUE.

SynchronousRequestQueueDelivers request messages that require a synchronous response from the connectorframework to WebSphere MQ Integrator Broker. This queue is necessary only if theconnector uses synchronous execution. With synchronous execution, the connectorframework sends a message to the SynchronousRequestQueue and waits for aresponse back from WebSphere MQ Integrator Broker on theSynchronousResponseQueue. The response message sent to the connector bears acorrelation ID that matches the ID of the original message.

SynchronousResponseQueueDelivers response messages sent in reply to a synchronous request fromWebSphere MQ Integrator Broker to the connector framework. This queue isnecessary only if the connector uses synchronous execution.

SynchronousTimeoutSpecifies the time in minutes that the connector waits for a response to asynchronous request. If the response is not received within the specified time thenthe connector moves the original synchronous request message into the fault queuealong with an error message.



WireFormatThe data format for messages exchanged by the connector. The default value CwXMLis the only valid value, and directs the connector to compose the messages in XML.



Appendix B. Connector Configurator

Before you can use a connector, you must create a connector configuration file thatsets the properties for the connector, designates the business objects and anymeta-objects that it supports, and sets logging and tracing values that theconnector will use at runtime. The configuration file may also contain propertiesfor the use of messaging and data handlers required by your connector.

Use Connector Configurator to create and modify the configuration file for yourconnector. If a configuration file has previously been created for your connector,you can use Connector Configurator to open the file and modify its settings. If noconfiguration file has yet been created for your connector, you can use ConnectorConfigurator to both create the file and set its properties.

When you complete a connector configuration file, the file is saved as an XMLdocument. You will save the XML document either as a project in System Manager(if ICS is your broker) or as a file with a *.cfg extension in a directory folder (ifWebSphere MQ Integrator Broker is your broker, or if you are using the file as alocal configuration file for ICS).

This appendix describes how to use Connector Configurator to:v Create a connector-specific property template for configuring your connectorv Create a configuration filev Set properties in a configuration file

Connector Configurator runs only in a Windows environment. If you are runningthe connector itself in a UNIX environment, use Connector Configurator in theWindows system in the network to modify the configuration file. Then copy thefile to your UNIX environment.

Note: Some properties in the connector configuration file use directory paths, andthese paths default to the Windows convention for directory paths. If youuse the connector configuration file in a UNIX environment, revise anydirectory path constructs in the configuration properties to match the UNIXconvention for directory paths.

Using Connector Configurator in an internationalized environmentConnector Configurator is internationalized and handles character conversionbetween the configuration file and the integration broker. Connector Configuratoruses native encoding. When it writes to the configuration file, it uses UTF-8encoding.

Connector Configurator supports non-English characters in:v All value fieldsv Log file and trace file path (specified in the Trace/Log files tab)

The drop list for the CharacterEncoding and Locale standard configurationproperties displays only a subset of supported values. To add other values to thedrop list, you must manually modify the \Data\Std\stdConnProps.xml file in theproduct directory.


For example, to add the locale en_GB to the list of values for the Locale property,open the stdConnProps.xml file and add the line in boldface type below:<Property name="Locale" isRequired="true" updateMethod="component restart">

<ValidType>String</ValidType><ValidValues>

<Value>ja_JP</Value><Value>ko_KR</Value><Value>zh_CN</Value><Value>zh_TW</Value><Value>fr_FR</Value><Value>de_DE</Value><Value>it_IT</Value><Value>es_ES</Value><Value>pt_BR</Value><Value>en_US</Value><Value>en_GB</Value>

<DefaultValue>en_US</DefaultValue></ValidValues>

</Property>

Starting Connector ConfiguratorConnector Configurator can be started and run in either of two modes:v Launched from System Managerv Independent of System Manager (stand-alone mode)

Running Configurator from System ManagerWhen you run Connector Configurator in conjunction with System Manager, youcanv Save connector configuration files (XML documents with the extension *.cfg) to a

directory that you specify, andv Save connector configuration files as components of System Manager projects. If

you are using ICS as your broker, this is a mandatory step before you deployyour configuration into the ICS.

Note: When you save a configuration file as a component of a System Managerproject, the file is stored in the designated project as an XML document filewith the extension *.con. It is not advisable to open the *.con file and edit itdirectly; instead, make any changes by opening the component in SystemManager.

To run Connector Configurator with System Manager, do any of the following:v In System Manager, right-click on the Connector folder of the Integration

Components Library (to create a new configuration), or right-click on aconnector configuration component within the Connector folder (to edit anexisting configuration), or

v From the System Manager menu, choose Tools>Connector Configurator, orv With System Manager already running, from Start>Programs choose IBM

WebSphere InterChange Server>IBM WebSphere Business IntegrationToolset>Development>Connector Configurator.

For details about using projects in System Manager and deploying to InterChangeServer, see the Implementation Guide for WebSphere InterChange Server.


Running Configurator independently of System ManagerWhen you run Connector Configurator without connecting to System Manager,you can save a connector configuration file (an XML document with the extension*.cfg) to a directory that you specify, but you cannot save or open a SystemManager project.

When you are creating a connector for use with a broker other than ICS, you donot need to connect to System Manager at any point in order to use the file. If youare creating a connector configuration for use with ICS as the broker, you may stillfind it useful on occasion to run Connector Configurator independently, and thenconnect to System Manager when you are ready to save the configuration file as acomponent of a System Manager project.

Choosing your brokerConnector Configurator can be used to configure connectors either for use withICS as the broker, or with WebSphere MQ Integrator Broker (also referred to asWMQI) as the broker.

Before you begin to configure the connector, you must choose the mode ofConnector Configurator that is appropriate for your broker. The mode that youchoose determines the properties that Connector Configurator will include in theconfiguration file. Choosing a broker is a mandatory step when you begin theprocess of creating a completely new configuration file. After a configuration filehas been created, you can optionally change the designated broker mode, using astandard configuration property. (This makes it possible to use an existingconfiguration file as a starting point for creating a configuration file that will beused with a different broker. However, be aware that revising a configuration filefor use with a different broker typically involves changing other configurationproperties as well, and not just the broker mode property.)

To choose a broker when you create a new configuration file (mandatory):v In the Connector Configurator home menu, choose File>New>Connector

Configuration. The New Connector Dialog displays.v In the Integration Broker field, choose either WMQI connectivity (for WebSphere

Integrator Broker) or ICS connectivity, according to the broker you are using.v Complete the remaining fields of the New Connector dialog, as described later

in this chapter for your specific broker.

To change your broker selection within an existing configuration file (optional):v Open the existing configuration file in Connector Configurator.v Select the Standard Properties tab.v In the Broker Type field of the Standard Properties tab, choose the value that is

appropriate for your broker. If you change the existing value, the available tabsand field selections of the properties screen will immediately refresh, to showonly those tabs and fields that appropriate for a configuration using the brokeryou have selected.

After you have chosen your broker type, you can complete the remainingConnector Configurator tasks for configuring your connector. When you save theconnector configuration file, Connector Configurator will save it in the brokermode that you have already selected. The title bar of Connector Configuratoralways displays the broker mode (such as ICS or WMQI) that ConnectorConfigurator is currently using.

Appendix B. Connector Configurator 85

After you have completed the configuration file and set its properties, it will needto be deployed to the appropriate location for your connector.v If you are using ICS as your broker, save the configuration in a System Manager

project, and use System Manager to load the file into InterChange Server.v If you are using WebSphere MQ Integrator Broker as your broker, manually

copy the configuration file to its appropriate location, which must match exactlythe configuration file location specified in the startup file for your connector.

For further information about deployment, see the Implementation Guide forWebSphere InterChange Server (for using the connector with ICS as the broker), orthe Implementation Guide for WebSphere MQ Integrator Broker (for using the connectorwith MQ Integrator as the broker).

Using a connector-specific property templateTo create a configuration file for your connector, you can start with a previouslycreated connector configuration file (*.cfg), a connector definition file (*.txt) or arepository file (*.in or *.out), if any of these already exists for your connector. Forinstructions on using such existing files, see “Using an existing file” on page 90.

If none of those files exist, or if they are too dissimilar to the configurationrequirements of your connector, you can start instead by creating a template forthe connector-specific properties of your connector. You’ll create properties in thetemplate, define general characteristics and values for those properties, and specifyany dependencies between the properties. Then you’ll save the template and use itas the base for creating a new connector configuration file.

Creating a template of connector-specific propertiesTo create a template:1. Choose File>New>Connector-Specific Property Template.2. The Connector-Specific Property Template dialog appears, with the following

fieldsv Name

Enter a unique name that identifies the connector, or type of connector, forwhich this template will be used. You will see this name again when youopen the dialog for creating a new configuration file from a template.

v Find Template, and Template NameThe names of all currently available templates are displayed in the TemplateName display. Look for an existing template that would make a goodstarting point for your new connector template (such as a template whoseproperty definitions are a subset of the properties used by your connector).To see the connector-specific property definitions that are contained in anytemplate, select that template’s name in the Template Name display. A list ofthe property definitions contained in that template will appear in theTemplate Preview display.If you do not see any template that displays the connector-specific propertiesthat are used by your connector, you will need to create one. ConnectorConfigurator provides a template named None, containing no propertydefinitions, as a default choice.Choose a template from the Template Name display, enter that templatename in the Find Name field (or highlight your choice in Template Name),and choose Next.


Specifying general characteristicsThe Properties - Connector-Specific Property Template dialog appears. The dialoghas tabs for General characteristics of the defined properties and for Valuerestrictions. The General display has the following fields:v Edit properties

Use the buttons provided (or right-click within the Edit properties display) toadd a new property to the template, to edit or delete an existing property, or toadd a child property to an existing property.A child property is a property that is an attribute of another property--the″parent″ property. The parent property can obtain values, or child properties, orboth. These property relationships are commonly referred to as ″hierarchical″properties. Later, when you create a configuration file from these properties,Connector Configurator will identify hierarchical property sets with a plus signin a box at the left of any parent property.

v Property typeChoose one of these property types: Boolean, String, Integer, or Time.

v FlagsYou can set Standard Flags (IsRequired, IsDepracated, IsOverridden) or CustomFlags (for Boolean operators) to apply to this property

After you have made selections for the general characteristics of the property,choose the Value tab.

Specifying valuesThe Value tab enables you to set the maximum length, the maximum multiplevalues, a default value, or a value range for the property. To do so:1. Choose the Value tab. The display panel for Value replaces the display panel

for General.2. Select the name of the property in the Edit properties display.3. In the fields for Max Length and Max Multiple Values, make any necessary

changes. Note that the changes will not be accepted until and unless you alsoopen the Property Value dialog for the property, described in the next step.

4. Right-click the box in the left-hand corner of the Value display panel. AProperty Value dialog displays. Depending on the type of the property, thedialog allows you to enter either a value, or both a value and range. Enter theappropriate value or range, and click OK.

5. The Value panel refreshes to display any changes you made in Max Length andMax Multiple Values, and it displays a table with three columns:The Value column shows the value that you entered in the Property Valuedialog, and any previous values that you created.The Default Value column allows you to designate any of the values as thedefault.The Value Range shows the range that you entered in the Property Valuedialog.After a value has been created and appears in the grid, it can be edited fromwithin the table display. To make a change in an existing value in the table,select an entire row by clicking on the row number. Then right-click in theValue field and choose EditValue.


Setting dependenciesAfter you have finished making changes in both the General and the Value tabs,choose Next. The Dependencies dialog appears.

A dependent property is a property that is included in the template and used inthe configuration file only if the value of another property meets a specificcondition. To designate a property as being dependent and set the condition uponwhich it depends, do this:1. In the Available Properties display, select the property that will be made

dependent.2. In the Select Property field, use the drop-down menu to select the property that

will hold the conditional value.3. In the Condition Operator field, choose one of the following:

== (equal to)/= (not equal to)> (greater than)< (less than)>= (greater than or equal to)<=(less than or equal to)

4. In the Conditional Value field, enter the value that is required in order for thedependent property to be included in the template.

5. With the dependent property highlighted in the Available Properties display,click an arrow to move it to the Dependent Property display.

6. Click Finish. Connector Configurator stores the information you have enteredas an XML document, under \data\app in the\bin directory where you haveinstalled Connector Configurator.

Creating a configuration file from a connector-specifictemplate

After a connector-specific template has been created, you can use it to create aconfiguration file:1. Choose File > New>Connector Configuration.2. The New Connector dialog appears, with the following fields:

v NameEnter the name of the connector. Names are case-sensitive. The name youenter must be unique, must end with the word “connector”, and must beconsistent with the file name for a connector that is installed on the system;for example, enter PeopleSoftConnector if the connector file name isPeopleSoft.jar.

Important: Connector Configurator does not check the spelling of the namethat you enter. You must ensure that the name is correct.

v System ConnectivityChoose ICS or choose WMQI (for WebSphere MQ Integrator Broker)connectivity.

v Select Connector-Specific Property TemplateType the name of the template that has been designed for your connector.The names of all available templates are displayed in the Template Name


display. When you select a name in the Template Name display, the PropertyTemplate Preview display shows the connector-specific properties that havebeen defined in that template.After you have chosen the template you want to use, choose OK.

3. A configuration screen will display for the connector that you are configuring.The title bar of the configuration screen shows the broker that you are usingand the name that you have given to the connector. You can fill in all the fieldvalues to complete the definition now, or you can save the file and completethe fields later.When you are using the configuration screen, you can, if you wish, addadditional connector-specific properties, as described under “Settingapplication-configuration properties (ICS)” on page 92. Any such additionsbecome part of the configuration file that you are creating, but do not affect thetemplate that you used in creating the file.

4. To save the file, choose File > Save > to File or File > Save > Save to the project.To save to a project, you must be using ICS as the broker, and System Managermust be running. If you save as a file, the Save File Connector dialog displays.Choose *.cfg as the file type, verify in the File Name field that the name isspelled correctly and has the correct case, navigate to the directory where youwant to locate the file, and choose Save. The status display in the messagepanel of Connector Configurator indicates that the configuration file wassuccessfully created.

Important: The directory path and name that you establish here must matchthe connector configuration file path and name that you supply inthe startup file for the connector.

5. To complete the connector definition, enter values in the fields for each of thetabs of the Connector Configurator window, as described for your broker laterin this chapter.

Using Connector Configurator with ICS as the brokerTo use Connector Configurator to configure a connector that will be used with ICS,first select ICS as the broker mode in which you are running ConnectorConfigurator, as described under“Choosing your broker” on page 85.

In a typical ICS implementation, the configuration file that you create withConnector Configurator is not put into use until after you have deployed it to theICS server. You will perform that deployment (described in the ImplementationGuide for WebSphere InterChange Server) after you have finished using ConnectorConfigurator to complete the connector configuration file.

Completing a configuration fileThis topic assumes that you already have a starting point for your connectorconfiguration, either from an existing file (a connector definitions file, a repositoryfile, or a *.cfg file) or from an existing project in System Manager. If you do not,see “Creating a template of connector-specific properties” on page 86.

When you open a configuration file or a connector from a project, the ConnectorConfigurator window displays the configuration screen, with the attributes andvalues that Connector Configurator finds in the connector definition file.

The title of the configuration screen displays the type of the broker and the nameof the connector as specified in the file. Make sure the title indicates the


appropriate type for your broker--either ICS or WebSphere MQ Integrator Broker(for WMQI). If it does not, change the broker value before you configure theconnector. To do so:1. Under the Standard Properties tab, select the value field for the BrokerType

property. In the drop-down menu, select the value WMQI or ICS.2. The Standard Properties tab refreshes to display properties associated with the

selected broker. When you save the file, you retain this broker selection. Youcan save the file now or proceed to complete the remaining configurationfields, as described in “Setting the configuration file properties (WebSphere MQIntegrator Broker)” on page 96.

3. When you have finished making entries in the configuration fields, chooseFile>Save>To Project or File>Save>To File.If you are saving to file, choose *.cfg as the extension, choose the correctlocation for the file and choose Save.If multiple connector configurations are open, choose Save All to File to save allof the configurations to file, or choose Save All to Project to save all ICSconnector configurations to a System Manager project.Before it saves the file, Connector Configurator validates that values have beenset for all required Standard properties. If a required Standard property ismissing a value, Connector Configurator displays a message that the validationfailed. You must supply a value for the property in order to save theconfiguration file.

Using an existing fileYou may have an existing file available in one or more of the following formats:v A connector definition file. This is a text file that lists properties and applicable

default values for a specific connector. Some connectors include such a file in a\repository directory in their delivery package (the file typically has theextension .txt; for example, CN_XML.txt for the XML connector).

v An ICS repository file. Definitions used in a previous ICS implementation of theconnector may be available to you in a repository file that was used in theconfiguration of that connector. Such a file typically has the extension .in or.out.

v A previous configuration file for the connector. Such a file typically has theextension *.cfg.

Although any of these file sources may contain most or all of the connector-specificproperties for your connector, the connector configuration file will not be completeuntil you have opened the file and set properties, as described later in this chapter.

To use an existing file to configure a connector, you must open the file inConnector Configurator, revise the configuration, and then save the file as aconfiguration file (*.cfg file).

Follow these steps to open a *.txt, *.cfg, or *.in file from a directory:1. In Connector Configurator, choose File > Open > From File.2. In the Open File Connector dialog, choose one of the following file types to see

the available files:v Configuration (*.cfg)v ICS Repository (*.in, *.out)

Choose this option if a repository file was used to configure the connector inan ICS environment. A repository file may include multiple connectordefinitions, all of which will display when you open the file.


v All files (*.*)Choose this option if a *.txt file was delivered in the adapter package forthe connector, or if a definition file is available under another extension.

3. In the directory display, navigate to the appropriate connector definition file,select it, and choose Open.

Using an existing System Manager projectFollow these steps to open a connector configuration from a System Managerproject:1. Start System Manager. A configuration can be opened from or saved to System

Manager only if System Manager has been started.2. Start Connector Configurator.3. Choose File > Open > From Project.

Setting the configuration file properties (ICS)The topics in this section apply if you are using InterChange Server as theintegration broker. If you are using WebSphere MQ Integrator Broker as theintegration broker, see “Setting the configuration file properties (WebSphere MQIntegrator Broker)” on page 96. When you create and name a new connectorconfiguration file, or when you open an existing connector configuration file,Connector Configurator displays a configuration screen with tabs for the categoriesof required configuration values.

Connector Configurator requires values for properties in all of these categories:1. Standard Properties2. Connector-Specific Properties3. Supported Business Objects4. Associated Maps5. Resources6. Trace/Log File values7. Messaging (where applicable)8. Data handlers (applicable for connectors that use JMS messaging with

guaranteed event delivery)

Note: For connectors that use JMS messaging, an additional category may display,for configuration of data handlers that convert the data to business objects.

Important: Connector Configurator accepts property values in either English ornon-English character sets. However, the names of both standard andconnector-specific properties, and the names of supported businessobjects, must use the English character set only.

Standard properties differ from connector-specific properties as follows:v Standard properties of a connector are shared by both the application-specific

component of a connector and its broker component. All connectors have thesame set of standard properties. These properties are described in Appendix A ofeach adapter guide. You can change some but not all of these values.

v Application-configuration (application-specific) properties apply only to theapplication-specific component of a connector, that is, the component thatinteracts directly with the application. Each connector has application-specificproperties that are unique to its application. Some of these properties provide


default values and some do not; you can modify some of the default values. Theinstallation and configuration chapter of each adapter guide describes theapplication-specific properties and the recommended values.

The fields for Standard Properties and Connector-Specific Properties arecolor-coded to show which are configurable:v A field with a grey background indicates a standard property. You can change

the value but cannot change the name or remove the property.v A field with a white background indicates an application-specific property. These

properties vary according to specific needs of the application or connector. Youcan change the value and delete these properties.

v Value fields are configurable.v The Update Method field is informational and not configurable. This field

specifies the action required to activate a property whose value has changed.

Setting standard connector properties (ICS)To change the value of a standard property:1. Click in the field whose value you want to set.2. Either enter a value, or choose from the drop-down menu if one appears.3. After entering all values for the standard properties, you can do one of the

following:v To discard the changes, preserve the original values, and exit Connector

Configurator, choose File > Exit (or close the window), and choose No whenprompted to save changes.

v To enter values for other categories in Connector Configurator, choose the tabfor the category. The values you enter for Standard Properties (or othercategory) are retained when you move to the next category; when you closethe window, you are prompted to either save or discard the values that youentered in all of the categories as a whole.

v To save the revised values, choose File > Exit (or close the window) andchoose Yes when prompted to save changes. Alternatively, choose Save > ToFile from either the File menu or the toolbar.

Setting application-configuration properties (ICS)For application-specific configuration properties, you can add or change propertynames, configure values, delete a property, and encrypt a property:1. Right click in the top-left portion of the grid. A pop-up menu bar will appear.

Select Add to add a property or Add Child to add a child property for aproperty.

2. Enter a value for the property or child property.3. To encrypt a property, click the Encrypt box.4. Choose to save or discard changes, as described for Setting Standard Connector

Properties.

The Update Method displayed for each property indicates whether a component oragent restart is necessary to activate changed values.

Important: Changing a preset application-specific connector property name maycause a connector to fail. Certain property names may be needed bythe connector to connect to an application or to run properly.


Encryption for connector properties (ICS)Application-specific properties can be encrypted by clicking the Encrypt check boxin the Edit Property window. To decrypt a value, click to clear the Encrypt checkbox, enter the correct value in the Verification dialog box, and choose OK. If theentered value is correct, the value is decrypted and displays. The adapter guide foreach connector contains a list and description of each property and its defaultvalue.

If a property has multiple values, the Encrypt check box will appear for the firstvalue of the property. When you click the Encrypt check box, all values of theproperty will encrypted. To decrypt multiple values of a property, click to clear theEncrypt check box of the first value of the property, and then enter the correctvalue of the first value in the Verification dialog box. If the input value is a match,all multiple values will decrypt.

Update method (ICS)When WebSphere MQ Integrator Broker is the integration broker, connectorproperties are static. The Update Method is always Connector Restart. In otherwords, for changes to take effect, you must restart the connector after saving therevised connector configuration file.

Specifying supported business object definitions (ICS)This topic assumes that you have already created or acquired the intendedbusiness objects, created or acquired maps for them, and have saved both thebusiness object definitions and map definitions into System Manager projects.

Before you can make use of a connector (and before you can bind the connectorwith a collaboration’s ports), you must make selections under the SupportedBusiness Objects tab to specify the business objects that the connector will use. Youmust specify both generic business objects and corresponding application-specificbusiness objects, and you must specify associations for the maps between thebusiness objects.

Note: Some connectors require that certain business objects be specified assupported in order to perform event notification or additional configuration(using meta-objects) with their applications. For more information, see theConnector Development Guide for C++ or the Connector Development Guide forJava.

To specify that a business object definition is supported by the connector, or tochange the support settings for an existing business object definition, choose theSupported Business Objects tab and use the following fields:

Business object nameThese instructions assume that you started Business Object Designer with SystemManager running.

To designate that a business object definition is supported by the connector:1. Click in an empty field of the Business Object Name list. A drop-down list

displays, showing all the business object definitions that exist in the SystemManager project.

2. Click on a business object to add it.3. Set the Agent Support (described below) for the business object.


4. In the File menu of the Connector Configurator window, choose Save to Project.The revised connector definition, including designated support for the addedbusiness object definition, is saved to the project in System Manager.

To delete a business object from the supported list:1. To select a business object field, click the number to the left of the business

object2. From the Edit menu of the Connector Configurator window, choose Delete

Row. The business object is removed from the list display.3. From the File menu, choose Save to Project.

Note that deleting a business object from the supported list does not affect thecode of the connector, nor does it remove the business object definition itself fromSystem Manager. It does, however, change the connector definition and make thedeleted business object unavailable for use in this implementation of thisconnector.

Agent supportIndicating Agent Support for a business object means that the system will attemptto use that business object for delivering data to an application via the connectoragent.

Typically, application-specific business objects for a connector are supported bythat connector’s agent, but generic business objects are not.

To indicate that the business object is supported by the connector agent, put acheck in the Agent Support box. Note that the Connector Configurator windowdoes not validate your Agent Support selections.

Maximum transaction levelThe maximum transaction level for a connector is the highest transaction level thatthe connector supports.

For most connectors Best Effort is the only possible choice, because mostapplication APIs do not support the Stringent level.

You must restart the server for changes in transaction level to take effect.

Note: For this release, maximum transaction level of a connector is always BestEffort.

Associated maps (ICS)Each connector supports a list of business object definitions and their associatedmaps that are currently active in InterChange Server. This list displays when youselect the Associated Maps tab.

The list of business objects contains the application-specific business object whichthe agent supports and the corresponding generic object that the controller sendsto the subscribing collaboration. The association of a map determines which mapwill be used to transform the application-specific business object to the genericbusiness object or the generic business object to the application-specific businessobject.


If you are using maps that are uniquely defined for specific source and destinationbusiness objects, the maps will already be associated with their appropriatebusiness objects when you open the display, and you will not need (or be able) tochange them.

If more than one map is available for use by a supported business object, you willneed to explicitly bind the business object with the map that it should use.

The Associated Maps tab displays the following fields:v Business Object Name

These are the business objects supported by this connector, as designated in theSupported Business Objects tab. If you designate additional business objectsunder the Supported Business Objects tab, they will be reflected in this list afteryou save the changes by choosing Save to Project from the File menu of theConnector Configurator window.

v Associated MapsThe display shows all the maps that have been installed to the system for usewith the supported business objects of the connector. The source business objectfor each map is shown to the left of the map name, in the Business Object Namedisplay.

v ExplicitIn some cases, you may need to explicitly bind an associated map.Explicit binding is required only when more than one map exists for a particularsupported business object. When InterChange Server boots, it tries toautomatically bind a map to each supported business object for each connector.If more than one map takes as its input the same business object, the serverattempts to locate and bind one map that is the superset of the others. If there isnot a map that is the superset of the others, the server will not be able to bindthe business object to a single map, and you will need to set the bindingexplicitly.To explicitly bind a map:1. In the Explicit column, place a check in the check box for the map you want

to bind.2. Select the map that you intend to associate with the business object3. In the File menu of the Connector Configurator window, choose Save to

Project.4. Deploy the project to InterChange Server.5. Reboot the InterChange Server for the changes to take effect.

Resources (ICS)The Resource tab allows you to set a value that determines whether and to whatextent the connector agent will handle multiple processes concurrently usingconnector agent parallelism. Not all connectors support this feature, and use of thisfeature is not usually advised for connector agents that were designed in Java to bemulti-threaded, since it is usually more efficient to use multiple threads thanmultiple processes.

Setting trace/log file values (ICS)When you open a connector configuration file or a connector definition file,Connector Configurator uses the logging and tracing values of that file as defaultvalues. You can change those values in Connector Configurator.


To change the logging and tracing values:1. Choose the Trace/Log Files tab.2. For either logging or tracing, you can choose to write messages to one or both

of the following:v To console (STDOUT): Writes logging or tracing messages to the STDOUT

display.v To File: Writes logging or tracing messages to a file that you specify. To

specify the file, choose the directory button (ellipsis), navigate to thepreferred location, provide a file name, and choose Save. Logging or tracingmessage are written to the file and location that you specify.

Note: Both logging and tracing files are simple text files. You can use the fileextension that you prefer when you set their file names. For tracingfiles, however, it is advisable to use the extension .trace rather than.trc, to avoid confusion with other files that might reside on thesystem. For logging files, .log and .txt are typical file extensions.

Configuring messagingThe messaging properties are available only if you have set MQ as the value of theDeliveryTransport standard property and ICS as the broker type. These propertiesaffect how your connector will use queues.

Data handlersThe data handlers section is available for configuration only if you have designateda value of JMS for DeliveryTransport and a value of JMS forContainerManagedEvents. See the descriptions under ContainerManagedEvents inAppendix A, Standard Properties, for values to use for these properties. Foradditional details, see the Connector Development Guide for C++or the ConnectorDevelopment Guide for Java.

Setting the configuration file properties (WebSphere MQ IntegratorBroker)

The topics in this section apply if you are using WebSphere MQ Integrator (alsoreferred to as WMQI) as the integration broker.

When you create and name a new connector configuration file, or when you openan existing connector configuration file, Connector Configurator displays aconfiguration screen with tabs for the categories of required configuration values.

Connector Configurator requires values for properties in all of these categories:1. Standard Properties2. Connector-Specific Properties3. Supported Business Objects4. Trace/Log File values5. Data Handlers (where applicable)

Note: For connectors that use JMS messaging, an additional category may display,for configuration of data handlers that convert the data to business objects.For information about the values to use in the Data Handlers category, seethe Connector Development Guide for C++ or the Connector Development Guidefor Java.


Important: Connector Configurator accepts property values in either English ornon-English character sets. However, the names of both standard andconnector-specific properties, and the names of supported businessobjects, must use the English character set only.

Standard properties differ from connector-specific properties as follows:v Standard properties of a connector are shared by both the application-specific

component of a connector and its broker component. All connectors have thesame set of standard properties. These properties are described in Appendix A ofeach adapter guide. You can change some but not all of these values.

v Application-configuration (application-specific) properties apply only to theapplication-specific component of a connector, that is, the component thatinteracts directly with the application. Each connector has application-specificproperties that are unique to its application. Some of these properties providedefault values and some do not; you can modify some of the default values. Theinstallation and configuration chapter of each adapter guide describes theapplication-specific properties and the recommended values.

The fields for Standard Properties and Connector-Specific Properties arecolor-coded to show which are configurable:v A field with a grey background indicates a standard property. You can change

the value but cannot change the name or remove the property.v A field with a white background indicates an application-specific property. These

properties vary according to specific needs of the application or connector. Youcan change the value and delete these properties.

v Value fields are configurable.v The Update Method field is informational and not configurable. This field

specifies the action required to activate a property whose value has changed.

Setting standard connector propertiesTo change the value of a standard property:1. Click in the field whose value you want to set.2. Either enter a value, or choose from the drop-down menu if one appears.3. After entering all values for the standard properties, you can do one of the

following:v To discard the changes, preserve the original values, and exit Connector

Configurator, choose File > Exit (or close the window), and choose No whenprompted to save changes.

v To enter values for other categories in Connector Configurator, choose the tabfor the category. The values you enter for Standard Properties (or othercategory) are retained when you move to the next category; when you closethe window, you are prompted to either save or discard the values that youentered in all of the categories as a whole.

v To save the revised values, choose File > Exit (or close the window) andchoose Yes when prompted to save changes. Alternatively, choose Save > ToFile from either the File menu or the toolbar.

Setting application-configuration propertiesFor application-specific configuration properties, you can add or change propertynames, configure values, delete a property, and encrypt a property:1. Click in the field whose name or value you want to set.


2. Enter a name or value.3. To encrypt a property, click the Encrypt box.4. Choose to save or discard changes, as described for Setting Standard Connector

Properties.

The Update Method displayed for each property indicates whether a component oragent restart is necessary to activatechanged values.

Important: Changing a preset application-specific connector property name maycause a connector to fail. Certain property names may be needed bythe connector to connect to an application or to run properly.

Encryption for connector propertiesApplication-specific properties can be encrypted by clicking the Encrypt check boxin the Edit Property window. To decrypt a value, click to clear the Encrypt checkbox, enter the correct value in the Verification dialog box, and choose OK. If theentered value is correct, the value is decrypted and displays. The adapter guide foreach connector contains a list and description of each property and its defaultvalue.

Update methodWhen WebSphere MQ Integrator Broker is the integration broker, connectorproperties are static. The Update Method is always Agent Restart. In other words,for changes to take effect, you must restart the connector agent after saving therevised connector configuration file.

Specifying supported business object definitionsThe procedures in this section assume that you have already created:v Business object definitionsv MQ message set files (*.set files)

The *.set files contain message set IDs that Connector Configurator requires fordesignating the connector’s supported business objects. See the ImplementationGuide for WebSphere MQ Integrator Broker for information about creating the MQmessage set files.

Each time that you add business object definitions to the system, you must useConnector Configurator to designate those business objects as supported by theconnector.

Important: If the connector requires meta-objects, you must create message set filesfor each of them and load them into Connector Configurator, in thesame manner as for business objects.

To specify supported business objects:1. Select the Supported Business Objects tab and choose Load. The Open Message

Set ID File(s) dialog displays.2. Navigate to the directory where you have placed the message set file for the

connector and select the appropriate message set file (*.set) or files.3. Choose Open. The Business Object Name field displays the business object

names contained in the *.set file; the numeric message set ID for each businessobject is listed in its corresponding Message Set ID field. Do not change themessage set IDs. These names and numeric IDs are saved when you save theconfiguration file.


4. When you add business objects to the configuration, you must load theirmessage set files. If you attempt to load a message set that contains a businessobject name that already exists in the configuration, or if you attempt to load amessage set file that contains a duplicate business object name, ConnectorConfigurator detects the duplicate and displays the Load Results dialog. Thedialog shows the business object name or names for which there are duplicates.For each duplicate name shown, click in the Message Set ID field, and choosethe Message Set ID that you wish to use.

Setting trace/log file valuesWhen you open a connector configuration file or a connector definition file,Connector Configurator uses the logging and tracing values of that file as defaultvalues. You can change those values in Connector Configurator.

To change the logging and tracing values:1. Choose the Trace/Log Files tab.2. For either logging or tracing, you can choose to write messages to one or both

of the following:v To console (STDOUT): Writes logging or tracing messages to the STDOUT

display.v To File: Writes logging or tracing messages to a file that you specify. To

specify the file, choose the directory button (ellipsis), navigate to thepreferred location, provide a file name, and choose Save. Logging or tracingmessage are written to the file and location that you specify.

Note: Both logging and tracing files are simple text files. You can use the fileextension that you prefer when you set their file names. For tracingfiles, however, it is advisable to use the extension .trace rather than.trc, to avoid confusion with other files that might reside on thesystem. For logging files, .log and .txt are typical file extensions.

Configuring data handlersThe data handlers section is available for configuration only if you have designateda value of JMS for DeliveryTransport and a value of JMS forContainerManagedEvents. See the descriptions under ContainerManagedEvents inAppendix A, Standard Properties, for values to use for these properties. Foradditional details, see the Connector Development Guide for C++ or the ConnectorDevelopment Guide for Java

Using standard and connector-specific properties with ConnectorConfigurator

Connector configuration properties include both standard configuration properties(the properties that all connectors have) and connector-specific properties(properties that are needed by the connector for a specific application ortechnology).

Because standard properties are used by all connectors, you do not need to definethose properties within your configuration file; Connector Configurator already hasthose definitions, and it incorporates them into your configuration file as soon asyou create the file. For standard properties, your only task is to use ConnectorConfigurator to set the values of the properties.


For connector-specific properties, however, you will need to both define theproperties and set their values. Connector Configurator provides the interface forperforming both of these tasks.

Completing the configurationAfter you have created a configuration file for a connector and modified it, makesure that the connector can locate the configuration file when the connector startsup. To do so, open the startup file used for the connector, and verify that thelocation and file name used for the connector configuration file match exactly thename you have given the file and the directory or path where you have placed it.


Appendix C. Connector feature list

This appendix details the features supported by the connector. For descriptions ofthese features, see “Appendix A: Connector Feature Checklist” in the ConnectorDevelopment Guide for Java.

Business object request handling featuresTable 15 details the business object request handling features supported by theconnector.

Table 15. Business object request handling features

Category Feature Support Notes

Create Create verb FullDelete Delete verb Full

Logical delete N/A Siebel applications do not support logicaldeletes.

Exist Exist verb Full The check is made to see if the primarybusiness component (the first child in abusiness object) exists in the Siebel database.

Misc Attribute names FullBusiness object names Full

Retrieve Ignore missing child object N/ARetrieveByContent Ignore missing child object N/A

Multiple results FullRetrieveByContent verb Full The non-key values are set only on the parent.

Update After-image support FullDelta support Partial This is done using DeltaUpdate verb support.KeepRelations Full The DeltaUpdate verb is used in place of

KeepRelations.Verbs Retrieve verb Full

Subverb support Partial This support is for the Update operation onthe top level business object. On an update,the child verbs are processed independentlyof the parent verb set.

Verb stability Full

Event notification featuresTable 16 details the event notification features supported by the connector.

Table 16. Event notification features


Connector Properties Event distribution FullPollQuantity Full

Event Table Event status values Full READY_FOR_POLL = 0 IN_PROGRESS = 1UNSUBSCRIBED = 2 SUCCESS = 3ERROR_PROCESSING_EVENT = -1ERROR_POSTING_EVENT = -2ERROR_OBJECT_NOT_FOUND = -3

Object key FullObject name Full


Table 16. Event notification features (continued)


Priority FullMisc. Archiving Full

CDK methodgotApplEvent

Full

Delta event notification NoEvent sequence Full The events are retrieved using the search

criteria on status and connector Id andsorted using timestamp and priority.

Future event processing NoIn-Progress event recovery Full With this connector, the event is

reprocessed. The connector propertyInDoubtEvents is set to Reprocess.

Physical delete event FullRetrieveAll FullSmart filtering FullVerb stability Full

General featuresTable 17 details the general features supported by the connector.

Table 17. General features


Business ObjectAttributes

Foreign key No

Foreign Key attributeproperty

N/A

Key Full For simple attributes, if Key is set to true, theattribute is used with Update to update aspecific record in Siebel. With Retrieve, theseattributes are used in the search specificationto get the record from Siebel. During Delete,the keys are set on the top-level businessobject.

Max Length NoMeta-data-driven design FullRequired Full If any attribute or child object in a WebSphere

business integration system business object ismarked as required, the value needs to bepresent.

Connection Lost Connection lost on poll FullConnection lost on requestprocessing

Full Using the connectorErrors connector property.

Connection lost while idle NoConnector Properties ApplicationPassword Full

ApplicationUserName FullUseDefaults Full

Message Tracing General messaging FullgenerateMsg() NoTrace level 0 FullTrace level 1 FullTrace level 2 FullTrace level 3 Full


Table 17. General features (continued)


Trace level 4 FullTrace level 5 Full

Misc. CDK method LogMsg FullJava Package Names FullLogging messages UnknownNT service compliance FullTransaction support Full

Special Value CxBlank processing NoCxIgnore processing Full In a Create operation, if the attribute is a

required attribute, UseDefaults is true, andthere is a default value for the attribute, thisvalue is set in the attribute even if theinbound is CxIgnore. Thus, the value in theapplication changes.

Appendix C. Connector feature list 103


Notices

IBM may not offer the products, services, or features discussed in this document inall countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user’s responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not give youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785U.S.A.

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or program(s) described in this publicationat any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Websites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM RTP Laboratory3039 Cornwallis RoadP.O. BOX 12195


Raleigh, NC 27709-2195U.S.A

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurement may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not necessarily tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

This information may contain examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples may includethe names of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

All statements regarding IBM’s future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

Programming interface informationProgramming interface information, if provided, is intended to help you createapplication software using this program.

General-use programming interfaces allow you to write application software thatobtain the services of this program’s tools.

However, this information may also contain diagnosis, modification, and tuninginformation. Diagnosis, modification and tuning information is provided to helpyou debug your application software.

Warning: Do not use this diagnosis, modification, and tuning information as aprogramming interface because it is subject to change.

Trademarks and service marksThe following terms are trademarks or registered trademarks of InternationalBusiness Machines Corporation in the United States or other countries, or both:


IBMthe IBM logoAIXCrossWorldsDB2DB2 Universal DatabaseMQIntegratorMQSeriesTivoliWebSphere

Lotus, Domino, Lotus Notes, and Notes Mail are trademarks of the LotusDevelopment Corporation in the United States, other countries, or both.Microsoft,Windows, Windows NT, and the Windows logo are trademarks of MicrosoftCorporation in the United States, other countries, or both.

MMX, Pentium, and ProShare are trademarks or registered trademarks of IntelCorporation in the United States, other countries, or both.

Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in theUnited States, other countries, or both.

Other company, product or service names may be trademarks or service marks ofothers. IBM WebSphere InterChange Server V4.2, IBM WebSphere BusinessIntegration Toolset V4.2, IBM WebSphere Business Integration Adapters V2.2, IBMWebSphere Business Integration Collaborations V4.2.

Notices 107


��

Printed in U.S.A.

Documents

Adapter for Siebel eBusiness Applications User Guide · PDF fileIBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Version 42. .x