Page 3 - Adapter
IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter Version 4.6.x
Page 5 - Contents; iii
Contents About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v What this document includes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v What this document does not include . . . . . . . . . . . . . . . . . . . . . . . . . . . v Audience . . . . . . . . . ...
Page 6 - iv
Chapter 6. Using the adapter with Siebel business services . . . . . . . . . . . . . 73 Understanding business services . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Verb processing with business services . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Events detection with busin...
Page 7 - Siebel
About this document The IBM R WebSphere R Business Integration Adapter portfolio supplies integration connectivity for leading e-business technologies, enterprise applications, and legacy and mainframe systems. The product set includes tools and templates for customizing, creating, and managing comp...
Page 9 - RetrievebyContent; vii
New in this release New in release 4.6.x Updated in September, 2004 This guide has been updated to include the following changes: v The adapter supports Siebel version 7.7. v Adapter support for Siebel version 7.7 is provided on two additional platforms: Solaris 9.0 and Windows 2003. v The adapter i...
Page 10 - viii
found, the adapter will check for CW Events. If it does not find either, and the adapter is configured for subscription delivery, it will return an error and terminate. Note: Adapter installation information has been removed from this guide. See Chapter 2 for the new location of that information. Ne...
Page 11 - ix
Important: Because the connector has not been internationalized, do not run it against InterChange Server version 4.1.1 if you cannot guarantee that only ISO Latin-1 data will be processed. New in this release ix
Page 13 - Terminology; adapter
Chapter 1. Overview v “Terminology” v “Siebel application architecture” on page 2 v “Connector architecture” on page 3 v “Business object processing” on page 4 v “Event management” on page 6 v “Handling lost connections to the Siebel application” on page 7 v “Processing locale-dependent data” on pag...
Page 16 - Processing
Business object processing This section provides an overview of how the connector processes integration broker requests and application events. Processing integration broker requests When the connector receives a request from a business object to perform an application operation, the connector proce...
Page 18 - RetrieveByContent; Event
Table 1. Events business component structure (continued) Fields Description Event Ts Event creation timestamp Create notification: When the connector encounters a Create event, it creates a business object of the type specified by the event, sets the key values for the business object (using the obj...
Page 19 - Smart; ConnectErrors
Table 2. Archiving behavior (continued) Archive processed setting Event processing status Connector behavior No subscription for business object Event is deleted from the Events business component and archived with one of the following statuses: Error Processing Event Error Posting Event Error Objec...
Page 22 - ProductDir; User; ApplicationUserName
v Windows: Windows 2000 (Professional, Server, or Advanced Server) with Service Pack 4 Windows XP with Service Pack 1A, for WebSphere Business Integration Adapter Framework (administrative tools only) Windows 2003 (Standard Edition or Enterprise Edition) Adapter dependencies Before you use the conne...
Page 31 - Overview; property
Chapter 3. Configuring the connector This chapter describes how to install and configure the adapter using Connector Configurator. v “Overview of Connector Configurator” v “Starting Connector Configurator” on page 20 v “Running Configurator from System Manager” on page 21 v “Creating a connector-spe...
Page 35 - only; Setting
The Value panel displays a table with three columns: The Value column shows the value that you entered in the Property Value dialog box, and any previous values that you created. The Default Value column allows you to designate any of the values as the default. The Value Range shows the range that y...
Page 37 - out
Type the name of the template that has been designed for your connector. The available templates are shown in the Template Name display. When you select a name in the Template Name display, the Property Template Preview display shows the connector-specific properties that have been defined in that t...
Page 38 - BrokerType
Choose this option if a repository file was used to configure the connector in an ICS environment. A repository file may include multiple connector definitions, all of which will appear when you open the file. v All files (*.*) Choose this option if a *.txt file was delivered in the adapter package ...
Page 39 - ICS
Setting the configuration file properties When you create and name a new connector configuration file, or when you open an existing connector configuration file, Connector Configurator displays a configuration screen with tabs for the categories of required configuration values. Connector Configurat...
Page 41 - Specifying
4. To get more information on a particular property, left-click the entry in the Description column for that property. If you have Extended Help installed, a hot button will appear. When you click on the hot button, a Help window will open and display details of the standard property. Note: If the h...
Page 43 - Associated
If you have System Manager running, you can select the empty box under the Business Object Name column in the Supported Business Objects tab. A combo box appears with a list of the business object available from the Integration Component Library project to which the connector belongs. Select the bus...
Page 44 - DeliveryTransport; Validating; Security
The display shows all the maps that have been installed to the system for use with the supported business objects of the connector. The source business object for each map is shown to the left of the map name, in the Business Object Name display. v Explicit Binding In some cases, you may need to exp...
Page 46 - ContainerManagedEvents
Setting trace/log file values When you open a connector configuration file or a connector definition file, Connector Configurator uses the logging and tracing values of that file as default values. You can change those values in Connector Configurator. To change the logging and tracing values: 1. Cl...
Page 47 - CharacterEncoding
For details about using projects in System Manager, and for further information about deployment, see the following implementation guides: v For ICS: Implementation Guide for WebSphere InterChange Server v For WebSphere Message Brokers: Implementing Adapters with WebSphere Message Brokers v For WAS:...
Page 49 - Business
Chapter 4. Understanding business objects v “Business object structure and relationships” v “Business object application-specific information” on page 39 This chapter describes how the connector processes business objects. To properly create or modify business objects for Siebel, you must understand...
Page 52 - ObjectEventId; information
Name = Siebel_BOInternalProduct Version = 1.0.0 AppSpecificInfo = ON=InternalProduct [Attribute] Name = Siebel_BCInternalProduct Type = Siebel_BCInternalProduct ContainedObjectVersion = 1.0.0 Relationship = Containment Cardinality = 1 MaxLength = 0 IsKey = false IsForeignKey = false IsRequired = fal...
Page 54 - Restrict
In some cases, PickList values are chosen based on more than one attribute. For example, where there is more than one Account with the same name, a Contact retrieve will get the first Account with that name if Account name is set as the only PickList value. To ensure that the correct data is retriev...
Page 56 - Siebel_BCBusinessAddress
Parameter Description From = ...; To = ... These are preprocessing instructions to the connector to set the To attribute to the value of the From attribute. The From attribute must be populated, while the True attribute is set only if it is null. The objects containing the attributes must have a one...
Page 61 - Modifying
Chapter 5. Creating business objects v “Modifying business object samples” v “Overview of Siebel ODA” on page 52 v “Installing and using Siebel ODA” on page 52 v “Using SiebelODA in Business Object Designer” on page 56 v “Reviewing the generated definition” on page 68 v “Adding information to the bu...
Page 65 - Before
When the installation is complete, the following files are installed in the directory on your system where you have installed the product: v ODA\Siebel\SiebelODA.jar v ODA\messages\SiebelODAAgent.xsd v ODA\Siebel\start_SiebelODA.bat (Windows only) v ODA/Siebel/start_SiebelODA.sh (UNIX only) v bin\CW...
Page 66 - Launching; UNIX
Understanding datatype mapping The following table lists the Siebel application datatypes and their corresponding WBI business object definition datatypes. These are used by the WBI Adapter for Siebel ODA only; the application regards all attribute values as strings. Table 7. Siebel application and ...
Page 71 - Selecting
Table 9. SiebelODA configuration properties (continued) Row number Property name Property type Description 9 TraceFileName String Full pathname of the file into which SiebelODA writes trace information. If the file does not exist, SiebelODA creates it in the specified directory. If the file already ...
Page 79 - Value
In the BO Properties window, enter or change the verb information. Click in the Value field and select one or more verbs from the pop-up menu. These are the verbs supported by the business object. Note: If a field in the BO Properties dialog box has multiple values, the field appears to be empty whe...
Page 81 - Name
business objects to see if they contain the correct application-specific information, and correct the information if necessary. When the SiebelODA generates business objects for Siebel integration objects or components, or business services, the generated business object does contain application-spe...
Page 82 - key
Table 10. Correspondence of data types (continued) DTYPE_CURRENCY DOUBLE Note: If an attribute’s data type is not one of those shown in Table 10, SiebelODA skips the column and displays a message stating that the column cannot be processed. Cardinality property SiebelODA sets the cardinality of all ...
Page 87 - Verb; VALCHANGE
Table 11. Business object level application text (continued) Parameter Description IC= The name of the Siebel integration component corresponding to this business object. BSN= The name of the business service used by this business object. When using application specific information, such as Siebel A...
Page 91 - Starting
Chapter 7. Running the connector v “Starting the connector” v “Stopping the connector” on page 80 Starting the connector A connector must be explicitly started using its connector start-up script . On Windows systems the startup script should reside in the connector ’s runtime directory: ProductDir ...
Page 104 - ILYNN
AgentTraceLevel The AgentTraceLevel property sets the level of trace messages for the application-specific component. The connector delivers all trace messages applicable at the tracing level set and lower. The default value is 0 . ApplicationName The ApplicationName property uniquely identifies the...
Page 105 - CommonEventInfrastructure
BiDi.Transformation The BiDi.Transformation property defines whether the system performs a bidirectional transformation at run time. If the property value is set to true , the BiDi.Application, BiDi.Broker, and BiDi.Metadata properties are available. If the property value is set to false , they are ...
Page 106 - Data
them to multiple collaboration instances simultaneously. This speeds delivery of business objects to the integration broker, particularly if the business objects use complex maps. Increasing the arrival rate of business objects to collaborations can improve overall performance in the system. To impl...
Page 107 - CONNECTORNAME
There is no default value. ControllerEventSequencing The ControllerEventSequencing property enables event sequencing in the connector controller. This property is valid only if the value of the RepositoryDirectory property is set to set to <REMOTE> ( BrokerType is ICS ). The default value is t...
Page 108 - WebSphere
DeliveryTransport The DeliveryTransport property specifies the transport mechanism for the delivery of events. Possible values are MQ for WebSphere MQ, IDL for CORBA IIOP, or JMS for Java Messaging Service. v If the value of the RepositoryDirectory property is set to <REMOTE>, the value of the...
Page 109 - DuplicateEventElimination; jms.ListenerConcurrency
This script is located in the \bin directory below the product directory ( <ProductDir> ). Using a text editor, 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 * ...
Page 110 - jms.MessageBrokerName; jms.NumConcurrentRequests; JMS
jms.MessageBrokerName The jms.MessageBrokerName specifies the broker name to use for the JMS provider. You must set this connector property if you specify JMS as the delivery transport mechanism (in the DeliveryTransport property). When you connect to a remote message broker, this property requires ...
Page 111 - MQ; Locale
jms.UserName the jms.UserName property specifies the user name for the JMS provider. A value for this property is optional. There is no default value. JvmMaxHeapSize The JvmMaxHeapSize property specifies the maximum heap size for the agent (in megabytes). This property is valid only if the value for...
Page 112 - LogAtInterchangeEnd; MaxEventCapacity; InterchangeSystem.txt
where: ll is a two-character language code (in lowercase letters) TT is a two-letter country or territory code (in uppercase letters) codeset is the name of the associated character code set (may be optional). By default, only a subset of supported locales are listed. To add other supported values t...
Page 113 - MonitorQueue; OADAutoRestartAgent
Note: To determine whether a connector has its own message file, see the individual adapter user guide. The default value is InterchangeSystem.txt . MonitorQueue The MonitorQueue property specifies the logical queue that the connector uses to monitor duplicate events. It is valid only if the value o...
Page 114 - PollEndTime; HH; PollFrequency; PollQuantity
PollEndTime The PollEndTime property specifies the time to stop polling the event queue. The format is HH:MM , where HH is 0 through 23 hours, and MM represents 0 through 59 minutes. You must provide a valid value for this property. The default value is HH:MM without a value, and it must be changed....
Page 115 - PollStartTime; RepositoryDirectory; ResponseQueue
v The connector processes the first BO attachment. The data handler is available for this MIME type, so it sends the business object to Visual Test Connector. v When it is polled for the second time, the connector processes the second BO attachment. The data handler is available for this MIME type, ...
Page 118 - CwBO; WsifSynchronousRequestTimeout; WAS; XMLNameSpaceFormat; short
v If the value of the RepositoryDirectory property is a local directory, the value is CwXML. v If the value of the RepositoryDirectory property is a remote directory, the value is CwBO . WsifSynchronousRequestTimeout The WsifSynchronousRequestTimeout property specifies the time in milliseconds that ...
Page 121 - ApplicationPassword; ArchiveProcessed
Table 16. Connector-specific configuration properties (continued) Name Meaning Possible values Default value ViewMode Retained for backward compatibility. An integer value that determines the permissions of the user. The value specified for this property is used unless a VM asi tag is specified at t...
Page 123 - SiebelLanguageCode; NONE; SupportNameValuePair; false; ViewMode
If ResonateSupport is set to true, the connector uses Attach and Detach calls to attach and detach from an existing session after each request has been processed. If ResonateSupport is set to false , the connector logs of after processing a certain number of requests. The default setting is false . ...
Page 126 - doVerbFor
Common Event Infrastructure event catalog to determine the definitions of appropriate events and their properties. The events must be defined in the event catalog for the consumer application to be able to consume the sending application’s events. The “Common Event Infrastructure event catalog defin...
Page 131 - except
Appendix D. Application Response Management This adapter is compatible with the Application Response Measurement application programming interface (API), an API that allows applications to be managed for availability, service level agreements, and capacity planning. An ARM-instrumented application c...
Page 133 - Index
Index A adapter 1 definition of 1 Adapter dependencies 10 Adapter Development Kit (ADK) 2 adapter environment 9 adapter framework 1 adapter platforms 9 AIX 9 Application Password 109 Application Response Measurement instrumentation, support for 119 Application Service Interface 73 application-specif...
Page 135 - Notices
Notices IBM may not offer the products, services, or features discussed in this document in all countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to stat...