IBM 4.6.x, User Manual

Page 1: ...IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter V ersion 4 6 x...

Page 2: ......

Page 3: ...IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter V ersion 4 6 x...

Page 4: ...ents about this document e mail doc comments us ibm com We look forward to hearing from you When you send information to IBM you grant IBM a nonexclusive right to use or distribute the information in...

Page 5: ...onfigurator 19 Starting Connector Configurator 20 Running Configurator from System Manager 21 Creating a connector specific property template 21 Creating a new configuration file 24 Using an existing...

Page 6: ...nectErrors 109 ConnectorID 110 ConnectString 110 DataBeanPoolSize 110 DataBeanRefreshInterval 110 EventProcessingSupport 110 PollAttributeDelimiter 110 PollQuantity 110 ResonateSupport 110 SiebelLangu...

Page 7: ...entative to discuss the configuration of your deployment site and for details on planning and evaluating these kinds of metrics given your specific configuration Audience This document is for WebSpher...

Page 8: ...ocumentation Note Important information about this product or the products documented in this guide or whatever works for your doc may be available in Technical Support Technotes and Flashes issued af...

Page 9: ...ajor changes listed below v The adapter now supports custom written business services v Support for the generation of WebSphere Business Integration business object definitions for custom business ser...

Page 10: ...x The connector delivered with IBM WebSphere Business Integration Adapter for Siebel eBusiness Applications has been internationalized For more information see Processing locale dependent data on pag...

Page 11: ...tant 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 releas...

Page 12: ...x Adapter for Siebel eBusiness Applications User Guide...

Page 13: ...ebel 7 5 Terminology The following terms are used in this document adapter The component in the WebSphere business integration system that provides components to support communication between an integ...

Page 14: ...ons An integration broker typically provides a variety of services that include the ability to route data a repository of rules that govern the integration process connectivity to a variety of applica...

Page 15: ...r handles each business object that it supports based on meta data encoded in the business object definition rather than on instructions hardcoded in the connector A business object corresponds to a S...

Page 16: ...n broker to recursively descend through the corresponding data in the database Business object RetrievalByContent When an integration broker asks the connector to retrieve a hierarchical business obje...

Page 17: ...e 1 is used by the connector during event subscription to build corresponding business objects and to send those objects to the connector framework for further processing Table 1 Events business compo...

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

Page 19: ...new event match an unprocessed event in the event table and the verb for the new event is Update while the verb for the unprocessed event is Create v If the business object name key and status for a...

Page 20: ...compatible with the IBMs Common Event Infrastructure a standard for event management that permits interoperability with other IBM WebSphere event producing applications If Common Event Infrastructure...

Page 21: ...MQ IntegratorV2 1 v WebSphere MQ Integrator BrokerV2 1 v WebSphere Business Integration Message BrokerV5 0 1 v WebSphere Application Server EnterpriseV5 0 2 in conjunction with WebSphere Studio Appli...

Page 22: ...t for the connector in Siebel This user account should have full access privileges and the login name should be the same as the ApplicationUserName configuration property The default value for the use...

Page 23: ...r as the integration broker or the Connector Configuration screen of System Manager ICS as the integration broker the Installer creates a customized wrapper for this connector manager script When the...

Page 24: ...e 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 from the Event business component The connector uses this inf...

Page 25: ...applet sif v ibmbo sif v ibmbc sif v ibmcreen sif When you apply WebSphere business integration system patch files in a Japanese environment edit all the patch files as follows Edit the first line of...

Page 26: ...them v If you are installing multiple connectors set and activate the Connector Id in the VB scripts 8 Apply the physical schema for the new tables to your local database You can do this by querying...

Page 27: ...uest Timeout current value is set to 600 This means that the connector will die after ten minutes Based on Siebel you can change this value to be as large as you want Creating the event and archive ta...

Page 28: ...ter 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...

Page 29: ...CONN user and add it to CW Responsibility and Administrative Responsibility 13 Test the application in your local environment Ensure that you have visibility to Event List View and that an event is ge...

Page 30: ...Timeout current value is set to 600 This means that the connector will die after ten minutes Based on Siebel you can change this value to be as large as you want 18 Adapter for Siebel eBusiness Applic...

Page 31: ...ion Message Broker collectively referred to as the WebSphere Message Brokers WMQI v WebSphere Application Server WAS If your adapter supports DB2 Information Integrator use the WMQI options and the DB...

Page 32: ...ent If you are running the connector in a UNIX environment use Connector Configurator in Windows to modify the configuration file and then copy the file to your UNIX environment Some properties in the...

Page 33: ...n file Creating a connector specific property template To create a configuration file for your connector you need a connector specific property template as well as the system supplied standard propert...

Page 34: ...General Property Type Property Subtype Updated Method Description v Flags Standard flags v Custom Flag Flag The Property Subtype can be selected when Property Type is a String It is an optional value...

Page 35: ...o True To designate a property as dependent and to set the condition upon which it depends do this 1 In the Available Properties display select the property that will be made dependent 2 In the Select...

Page 36: ...eed to select an integration broker The broker you select determines the properties that will appear in the configuration file To select a broker v In the Integration Broker field select ICS WebSphere...

Page 37: ...he fields for each of the tabs of the Connector Configurator window as described later in this chapter Using an existing file You may have an existing file available in one or more of the following fo...

Page 38: ...b will display the connector properties associated with the selected broker The table shows Property name Value Type Subtype if the Type is a string Description and Update Method 3 You can save the fi...

Page 39: ...m 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 the sa...

Page 40: ...se the window and click Yes when prompted to save changes Alternatively click Save To File from either the File menu or the toolbar To get more information on a particular standard property left click...

Page 41: ...properties Application specific properties can be encrypted by selecting the Encrypt check box in the Connector specific Properties window To decrypt a value click to clear the Encrypt check box enter...

Page 42: ...tor Configurator window click Delete Row The business object is removed from the list display 3 From the File menu click Save to Project Deleting a business object from the supported list changes the...

Page 43: ...upports a list of business object definitions and their associated maps that are currently active in WebSphere InterChange Server This list appears when you select the Associated Maps tab The list of...

Page 44: ...or the changes to take effect Resources ICS The Resource tab allows you to set a value that determines whether and to what extent the connector agent will handle multiple processes concurrently using...

Page 45: ...e Keys the Generate Keys dialog box appears with the defaults for the keytool that will generate the keys v The keystore value defaults to the value you entered in Keystore Target System Absolute Path...

Page 46: ...t reside on the system For logging files log and txt are typical file extensions Data handlers The data handlers section is available for configuration only if you have designated a value of JMS for D...

Page 47: ...that pertain to the new broker you have selected Completing the configuration After you have created a configuration file for a connector and modified it make sure that the connector can locate the c...

Page 48: ...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 D...

Page 49: ...Multi Value Link MVL fields representing one to many relationships or they can have a simple link Business components can be associated in many to one relationships by means of PickLists Business comp...

Page 50: ...t double All types are treated as Strings MaxLength Applies to String types and represents the maximum length allowed for the attribute This is not used by the connector If the data is large it must b...

Page 51: ...usiness objects are designed modifications to business objects must match the connector s rules for the connector to process modified business objects correctly Therefore if you modify or create Siebe...

Page 52: ...es the application specific information consists of the name value pairs listed in the following table The name value pairs are order independent and are delimited by semicolons Parameter Description...

Page 53: ...mation so that the connector can use the attribute as a foreign key To specify a PickList for an attribute you need to include two attributes in the business object The first attribute identifies the...

Page 54: ...elds 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 the attributes after the Restric...

Page 55: ...nk Application specific information for container attributes For container attributes the application specific information contains the name value pairs listed in the following table The name value pa...

Page 56: ...in the Siebel application the corresponding WebSphere business integration system business object Siebel_BCAccount has a container attribute for the child business object Siebel_BCBusinessAddress The...

Page 57: ...ct Name ContactId Type String Cardinality 1 MaxLength 10 IsKey true IsForeignKey false IsRequired false AppSpecificInfo FN Id Name Name Name Siebel_BCOpportunity Type Siebel_BCOpportunity ContainedObj...

Page 58: ...rective can be specified only in the application specific information of an attribute on a child business object In other words it cannot be specified on a top level business object For example if a S...

Page 59: ...at the container attribute represents a PickList the From parameter is the pointer to the key attribute and the To parameter points to the key attribute of the Siebel_BCOpprotunity business object The...

Page 60: ...roperty is not used and should be left blank or omitted when creating business object definitions Multiple record retrieval The adapter processes the RetrievebyContent verb similarly to the way it pro...

Page 61: ...eDelete sbv and Business_Address_Write svb Siebel 7 Account sbl or Account js The Siebel VB files are located in the Common Siebel Dependencies Siebel_VB directory 2 Save the files in a temporary dire...

Page 62: ..._PreDelete svb Siebel 7 Quote sbl Quote js 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 di...

Page 63: ...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 ch...

Page 64: ...v Select Product Id and set the value to Required Note WebSphere business integration components track the Products by their Product Id and not their Name 7 You will not be able to test the object un...

Page 65: ...s installed on your system Before using SiebelODA Before you can run SiebelODA you must copy the required Siebel application s jar files to the ProductDir connectors Siebel dependencies directory The...

Page 66: ...used when you create business object definitions using the Business Services option Hierarchy Container or String depending on the populated content if any of the Integration Object field Integration...

Page 67: ...e message file but does not actually create the file If the file displayed as part of ODA configuration does not exist change the value to point to an existing file v You can copy the existing message...

Page 68: ...d which configures and runs the ODA There are six steps in Business Object Wizard to generate business object definitions using an ODA After starting the ODA do the following to start the wizard 1 Ope...

Page 69: ...our desired ODA check the setup of the ODA 2 Select the desired ODA from the displayed list Business Object Wizard displays your selection in the Agent s name field 3 Click Next Specify configuration...

Page 70: ...glish 5 DefaultBOPrefix String Prefix that the ODA applies to the name of each business object definition for the Siebel document If you do not specify a business object prefix the ODA does not prepen...

Page 71: ...a message and error file named SiebelODAAgent txt Important The error and message file must be located in the ODA messages subdirectory of the product directory Use this property to verify or specify...

Page 72: ...ects into new ones expand Convert This displays the repository files that need to be converted see Figure 5 Figure 4 Business Object Wizard Select Source screen Figure 5 Business Object Wizard screen...

Page 73: ...an integration object you can select an integration component for that object When you expand an application service however a corresponding integration object is already selected Note If an integrat...

Page 74: ...Figure 7 Business Object Wizard displaying Integration Objects expanded Figure 8 Business Object Wizard displaying Application Services expanded 62 Adapter for Siebel eBusiness Applications User Guide...

Page 75: ...ith the generated business object definitions Business Object Designer displays the dialog box with only the selected objects and components Figure 10 on page 64 illustrates this dialog box Figure 9 B...

Page 76: ...ness object definition After you confirm the Siebel elements the next dialog box informs you that Business Object Designer is generating the business object definition If a large number of Component I...

Page 77: ...r displays the BO Properties window for each of the generation types you chose business objects integration objects and application services which prompts you for the information Figure 12 on page 66...

Page 78: ...Figure 12 Providing additional information for business object Figure 13 Providing additional information for integration object 66 Adapter for Siebel eBusiness Applications User Guide...

Page 79: ...bject Note If a field in the BO Properties dialog box has multiple values the field appears to be empty when the dialog box first displays Click in the field to display a drop down list of its values...

Page 80: ...further modifications see the Business Object Development Guide Figure 16 illustrates this dialog box Reviewing the generated definition The business object definition that SiebelODA generates contai...

Page 81: ...ties This section describes the properties that SiebelODA generates for each attribute Important Any user edits described in the following sections refer to business object generation only not to busi...

Page 82: ...s own Id values while creating a record AppSpecificInfo Property The user should edit this property if container attributes have not been generated and ensure the correctness if container attributes h...

Page 83: ...calculated fields in Siebel Application do not correspond to a column they are not being generated by the ODA These fields can be manually added to the Business Object Definition Chapter 5 Creating bu...

Page 84: ...72 Adapter for Siebel eBusiness Applications User Guide...

Page 85: ...s services on the other hand are not tied to specific objects but rather operate on objects to achieve a particular goal The adapter supports EAI Siebel Adapter a generic business service provided by...

Page 86: ...arent componet name can be obtained from the application specific information v instantiate a new property set for type Parent Component v set type as parent object type v set different properties v d...

Page 87: ...object the application specific information should contain BSTYPE ASI v For custom written business services where the IBM business object represents the service the application specific information...

Page 88: ...usiness services except that the name of the business object and the verb change The triggers should be written on the business object on which the integration object is based The trigger should popul...

Page 89: ...When the business service method is executed the OutputPropertySet is obtained and populates the Response business object IBM business object corresponding to a business service Siebel_BS Name Reques...

Page 90: ...78 Adapter for Siebel eBusiness Applications User Guide...

Page 91: ...a local configuration file if the adapter is using JMS transport You can invoke the connector startup script in any of the following ways v On Windows systems from the Start menu Select Programs IBM W...

Page 92: ...ting Adapters with WebSphere Message Brokers v For WebSphere Application Server refer to Implementing Adapters with WebSphere Application Server Stopping the connector The way to stop a connector depe...

Page 93: ...ean allows you to change the logging timeout value To reset the logging timeout value in Siebel JAVABean 1 Select Site Map Server Admin Components Sales Object Manager 2 In the lower applet go to Comp...

Page 94: ...82 Adapter for Siebel eBusiness Applications User Guide...

Page 95: ...nd on which integration broker you use You choose the integration broker using Connector Configurator After you choose the broker Connector Configurator lists the standard properties you must configur...

Page 96: ...tion file 4 Command line The default length of a property field is 255 characters There is no limit on the length of a STRING property type The length of an INTEGER type is determined by the server on...

Page 97: ...a quick reference to the standard connector configuration properties Not all connectors require all of these properties and property settings may differ from integration broker to integration broker S...

Page 98: ...Broker Any valid combination of these bidirectional attributes 1st letter I V 2nd letter L R 3rd letter Y N 4th letter S N 5th letter H C N ILYNN five letters Component restart This property is valid...

Page 99: ...ontrollerTraceLevel 0 through 5 0 Dynamic This property is valid only if the value of RepositoryDirectory is set to REMOTE and the value of BrokerType is ICS DeliveryQueue Any valid JMS queue name CON...

Page 100: ...DeliveryTransport is JMS and the value of BrokerType is ICS jms UserName Any valid name Component restart This property is valid only if the value of Delivery Transport is JMS JvmMaxHeapSize Heap size...

Page 101: ...ue of Repository Directory is set to REMOTE and the value of BrokerType is ICS OADMaxNumRetry A positive integer 1000 Dynamic This property is valid only if the value of Repository Directory is set to...

Page 102: ...unlimited Component restart Used only by connectors that support DB2II This property is valid only if the value of ResultsSetEnabled is true RHF2MessageDomain mrm or xml mrm Component restart This pr...

Page 103: ...are located The directory must be located in ProductDir bin Data App Help and must contain at least the language directory enu_usa It may contain other directories according to locale The default valu...

Page 104: ...This property is valid only if the BiDi Transformation property value is set to true The default value is ILYNN implicit left to right on off nominal BiDi Broker The BiDi Broker property specifies th...

Page 105: ...nfigurator appendix in this guide CommonEventInfrastructure The Common Event Infrastructure CEI is a simple event management function handling generated events The CommonEventInfrastructure property s...

Page 106: ...EMOTE The default value is 1 ContainerManagedEvents The ContainerManagedEvents property allows a JMS enabled connector with a JMS event store to provide guaranteed event delivery in which an event is...

Page 107: ...nt becomes unavailable after the connector controller forwards a service call request to it the connector controller fails the request If this property is set to false the connector controller begins...

Page 108: ...gent side performance WebSphere MQ provides faster performance on the application specific component side Using WebSphere MQ the connector polling thread picks up an event places it in the connector q...

Page 109: ...aranteed event delivery The default value is false EnableOidForFlowMonitoring When the value of this property is true the adapter runtime will mark the incoming ObjectEventID as a foreign key for flow...

Page 110: ...is reached new service calls are blocked and must wait for another request to complete before proceeding The default value is 10 jms Password The jms Password property specifies the password for the...

Page 111: ...abytes This property is valid only if the value for the RepositoryDirectory property is set to REMOTE The default value is 1m ListenerConcurrency The ListenerConcurrency property supports multithreadi...

Page 112: ...r fatal errors occur For example when a connector loses its connection to the application if the value of LogAtInterChangeEnd is true an e mail message is sent to the specified message recipient This...

Page 113: ...t to REMOTE the value of BrokerType is ICS The default value is false OADMaxNumRetry The OADMaxNumRetry property specifies the maximum number of times that the WebSphere MQ triggered Object Activation...

Page 114: ...property v The number of milliseconds between polling actions a positive integer v The word no which causes the connector not to poll Enter the word in lowercase v The word key which causes the connec...

Page 115: ...ry from which the connector reads the XML schema documents that store the metadata for business object definitions If the integration broker is ICS this value must be set to set to REMOTE because the...

Page 116: ...is valid only if the value of the DeliveryTransport property is JMS and the value of BrokerType is WMQI The default value is false ResultsSetSize The ResultsSetSize property defines the maximum number...

Page 117: ...f the value of DeliveryTransport is JMS The default value is CONNECTORNAME SYNCHRONOUSREQUESTQUEUE SynchronousRequestTimeout The SynchronousRequestTimeout property specifies the time in milliseconds t...

Page 118: ...request If the response is not received within the specified time the connector moves the original synchronous request message and an error message to the fault queue This property is valid only if th...

Page 119: ...the system has been configured to handle multiple connectors An integer value denoting the connector ConnectString A string used by the Siebel Java Data Bean to connect to the Siebel Object manager p...

Page 120: ...d Default is US English with ENU as the NLS representation With Siebel 7 the languages supported with their language codes is listed below Italian Std ITA Japanese JPN Korean KOR Norwegian NOR Bokmal...

Page 121: ...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...

Page 122: ...gSupport is set to true the adapter processes an event If EventProcessingSupport is set to false the adapter does not process the event The default value is true PollAttributeDelimiter When multiple n...

Page 123: ...ir Used to determine the event object key format If this is set to true or if it is not set the object key value must be a name value pair with an between name and value If this is set to false only o...

Page 124: ...112 Adapter for Siebel eBusiness Applications User Guide...

Page 125: ...here Application Server Application Client 5 0 2 5 1 or 5 1 1 WebSphere Application Server Application Client 5 1 1 is provided with WebSphere Business Integration Server Foundation 5 1 1 Note Common...

Page 126: ...you are writing another application your application can use event catalog interfaces to query against the event definition For more information about event definitions and how to query them refer to...

Page 127: ...ubComponent Comment further distinction of the logical component path sourceComponentId subComponent required true defaultValue AppSide_Connector AgentBusinessObjectManager property name componentType...

Page 128: ...pe situationQualifier required true permittedValue STOP_INITIATED permittedValue ABORT_INITIATED permittedValue PAUSE_INITIATED permittedValue STOP_COMPLETED XML format for timeout adapter metadata Th...

Page 129: ...by Common Event Infrastructure required true property name localInstanceId Comment Value is business object verb business object name app name business object identifier required false property name s...

Page 130: ...edValue CreateSituation permittedValue DestroySituation permittedValue OtherSituation property name situationType Comment Specifies the type of situation and disposition of the event path situation si...

Page 131: ...v 5 2 Fixpack 1 This must be installed on the same system on which the adapter is installed and configured to point to the system on which the IBM Tivoli Monitoring for Transaction Performance server...

Page 132: ...re Application Server can select which of these metrics to display for which adapter events by configuring Discovery Policies and Listener Policies for particular transactions from within the Tivoli M...

Page 133: ...l 110 datatype mapping 54 DefaultValue 38 delete requests 5 E EAI Siebel Adapter 73 event catalog for Common Event Infrastructure 114 event processing 12 event table 12 EventProcessingSupport 110 even...

Page 134: ...lication specific information 48 verbs key attributes 48 verbs with business services 75 ViewMode 111 W WebSphere business integration system 2 Windows 10 122 Adapter for Siebel eBusiness Applications...

Page 135: ...NOT LIMITED TO THE IMPLIED WARRANTIES OF NON INFRINGEMENT MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE Some states do not allow disclaimer of express or implied warranties in certain transacti...

Page 136: ...iers of those products This information may contain examples of data and reports used in daily business operations To illustrate them as completely as possible the examples may include the names of in...

Page 137: ...al Database Domino IMS Informix iSeries Lotus Lotus Notes MQIntegrator MQSeries MVS OS 400 Passport Advantage SupportPac WebSphere z OS Microsoft Windows Windows NT and the Windows logo are trademarks...

Page 138: ...126 Adapter for Siebel eBusiness Applications User Guide...

Page 139: ......

Page 140: ...Printed in USA...