Download Print this page

IBM 4.6.x User Manual

Ibm user guide adapter for siebel ebusiness applications 4.6.x
Hide thumbs

Advertisement

Quick Links

IBM WebSphere Business Integration Adapters
Adapter for Siebel eBusiness Applications
User Guide
Adapter V ersion 4.6.x

Advertisement

loading

  Related Manuals for IBM 4.6.x

  Summary of Contents for IBM 4.6.x

  • Page 1 IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter V ersion 4.6.x...
  • Page 3 IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter V ersion 4.6.x...
  • Page 4 To send us your comments 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 any way it believes appropriate without incurring any obligation to you.
  • Page 5: Table Of Contents

    New in this release ......vii New in release 4.6.x .
  • Page 6 Chapter 6. Using the adapter with Siebel business services ... . . 73 Understanding business services . Verb processing with business services . Events detection with business services . Custom business service support . Chapter 7.
  • Page 7: About This Document

    Such issues are unique to every customer deployment and must be measured within or close to the exact environment where the adapter is to be deployed. You should contact your IBM services representative to discuss the configuration of your deployment site, and for details on planning and evaluating these kinds of metrics, given your specific configuration.
  • Page 8: Typographic Conventions

    Technical Support Technotes and Flashes issued after this document was published. These can be found on the WebSphere Business Integration Support Web site, http://www.ibm.com/software/integration/websphere/support/. Select the component area of interest and browse the Technotes and Flashes sections.
  • Page 9: New In This Release

    For backward compatibility, the adapter works with both the old and new component names. For example, the adapter will check first for IBM Events, and if found it will use it as the event store. If IBM Events is not © Copyright IBM Corp. 1997, 2004...
  • Page 10: New In Release 4.3.X

    The changes to this version of the connector support Siebel, version 7.5 and the Siebel connectivity DLL. New in release 4.1.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 page 7 and Appendix A, “Standard configuration properties for connectors,”...
  • Page 11 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...
  • Page 12 Adapter for Siebel eBusiness Applications User Guide...
  • Page 13: Chapter 1. Overview

    These references are synonymous with references to CW Event and CW Archive that appear in earlier versions, and with references to IBM Event and IBM Archive that appear in Siebel 7.5 Terminology The following terms are used in this document.
  • Page 14: Siebel Application Architecture

    Adapter Development Kit (ADK) A development kit that provides some samples for adapter development, including sample connectors and Object Discovery Agents (ODAs). connector The component of an adapter that uses business objects to send information about an event to an integration broker (event notification) or receive information about a request from the integration broker (request processing).
  • Page 15: Connector Architecture

    Connector architecture The connector has been designed following the meta-data design principles as outlined in the Connector Development Guide for Java. This means that existing application-specific business objects can be extended and customized and new business objects can be defined without requiring additional coding or customization in the connector code.
  • Page 16 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 processes hierarchical business objects recursively;...
  • Page 17 child container objects. In this case, only these objects in the Siebel application are processed while the others are left untouched. Business object deletion: When an integration broker asks the connector to delete a record, the record is removed from the underlying database. Only the parent needs to be deleted because the Siebel DeleteCascade feature deletes all of the children.
  • Page 18 Table 1. Events business component structure (continued) Fields Event Ts 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 object key specified in the Event business component), and retrieves the business object from the Siebel application.
  • Page 19 Table 2. Archiving behavior (continued) Archive processed setting Event processing status No subscription for business object Successful false Unsuccessful No subscription for business object Smart filtering Duplicate events are not saved in the event store. Before storing a new event as a record in the event store, the VB Script or eScript needs to query the event store for existing events that match the new event.
  • Page 20 Common Event Infrastructure This adapter is 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 support is enabled, events produced by the adapter can be received (or used) by another Common Event Infrastructure-compatible application.
  • Page 21: Chapter 2. Installing The Adapter

    Adapter platforms In addition to a broker, this adapter requires one of the following operating systems: v All operating system environments require the Java compiler (IBM JDK 1.4.2for Windows 2000) for compiling custom adapters v AIX: AIX 5.1 with Maintenance Level 4 AIX 5.2 with Maintenance Level 1.
  • Page 22 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 connector, you must do the following: v Install the Siebel 6.2.x, Siebel 7.0.x, Siebel 7.5.x, or Siebel 7.7x .jar files that will be used.
  • Page 23: Installing The Adapter And Related Files

    For information on installing WebSphere Business Integration adapter products, refer to the Installing WebSphere Business Integration Adapters guide located in the WebSphere Business Integration Adapters Infocenter at the following site: http://www.ibm.com/websphere/integration/wbiadapters/infocenter Verifying an installation This section describes the file structures after the product has been installed on a UNIX or Windows system.
  • Page 24: Event And Archive Tables

    Table 4. Installed Windows file structure for the connector Subdirectory of %ProductDir% \connectors\Siebel \connectors\Siebel\dependencies \connectors\messages \connectors\Siebel\Samples\Repository \repository\Siebel\ \lib \bin Installer adds an icon for the connector file to the WebSphere business integration menu. For a fast way to start the connector, create a shortcut to this file on the desktop.
  • Page 25 One new view, IBM Event List View v Two new applets, IBM Archive List Applet and IBM Event List Applet v One new screen IBM Events and one new screen view, IBM Event List view 5. Create a page tab as follows: a.
  • Page 26 Leave the inactive field unchecked. f. Go to the Page tab locale and create a new record for IBM Events. Add ENU for the Language Code and IBMEvents for text, if it does not exists. 6. Create a screen menu item as follows: a.
  • Page 27 v Siebel Sales Enterprise v The project for the business objects that you want to use Note: You should check in your locked projects only through the query. 14. Apply the physical schema to your development database. You can do this by querying for the two new tables, CX_IBM_ARCH_Q and CX_IBM_EVENT_Q, and select the current query to create a physical schema.
  • Page 28 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.
  • Page 29 v If you want to sort events by priority, edit the priority values in the business objects VB scripts before compiling them. v If you are installing is multiple connectors, set and activate the Connector Id in the VB scripts. Siebel 6 If you want to use the Additional Object Key field, you must set it in the VB script.
  • Page 30 Note: The Request 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. Adapter for Siebel eBusiness Applications User Guide...
  • Page 31: Chapter 3. Configuring The Connector

    For example, if WMQI is your broker, you run Connector Configurator directly, and not from within System Manager (see “Running Configurator in stand-alone mode” on page 20). © Copyright IBM Corp. 1997, 2004...
  • Page 32: Starting Connector Configurator

    Running Configurator in stand-alone mode You can run Connector Configurator independently and work with connector configuration files, irrespective of your broker. To do so: v From Start>Programs, click IBM WebSphere Business Integration Adapters>IBM WebSphere Business Integration Tools>Connector Configurator. v Select File>New>Connector Configuration.
  • Page 33: Running Configurator From System Manager

    Running Configurator from System Manager You can run Connector Configurator from System Manager. To run Connector Configurator: 1. Open the System Manager. 2. In the System Manager window, expand the Integration Component Libraries icon and highlight Connectors. 3. From the System Manager menu bar, click Tools>Connector Configurator. The Connector Configurator window opens and displays a New Connector dialog box.
  • Page 34 v To see the connector-specific property definitions in any template, select that template’s name in the Template Name display. A list of the property definitions contained in that template appears in the Template Preview display. 3. You can use an existing template whose property definitions are similar to those required by your connector as a starting point for your template.
  • Page 35 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.
  • Page 36: Creating A New Configuration File

    v Queue names may not have leading or embedded spaces. Creating a new configuration file When you create a new configuration file, you must name it and select an integration broker. You also select an operating system for extended validation on the file. The toolbar has a droplist called Target System that allows you to select the target operating system for extended validation of the properties.
  • Page 37: Using An Existing File

    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 template.
  • Page 38: Completing A Configuration File

    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 for the connector, or if a definition file is available under another extension.
  • Page 39: Setting The Configuration File Properties

    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 Configurator requires values for properties in these categories for connectors running on all brokers: v Standard Properties v Connector-specific Properties...
  • Page 40 v The Update Method field is displayed for each property. It indicates whether a component or agent restart is necessary to activate changed values. You cannot configure this setting. Setting standard connector properties To change the value of a standard property: 1.
  • Page 41 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.
  • Page 42 (using meta-objects) with their applications. For more information, see the Connector Development Guide for C++ or the Connector Development Guide for Java. If ICS is your broker To specify that a business object definition is supported by the connector, or to change the support settings for an existing business object definition, click the Supported Business Objects tab and use the following fields.
  • Page 43 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 business object you want from the list.
  • Page 44 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.
  • Page 45 For Windows: <ProductDir>\connectors\security\<connectorname>.jks v For UNIX: opt/IBM/WebSphereAdapters/connectors/security/<connectorname>.jks This path and file should be on the system where you plan to start the connector, that is, the target system. You can use the Browse button at the right only if the target system is the one currently running.
  • Page 46: Saving Your Configuration File

    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.
  • Page 47: Changing A Configuration File

    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: Implementing Adapters with WebSphere Application Server Changing a configuration file You can change the integration broker setting for an existing configuration file.
  • Page 48 <Property name="Locale" isRequired="true" updateMethod="component restart"> </Property> Adapter for Siebel eBusiness Applications User Guide <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>...
  • Page 49: Chapter 4. Understanding Business Objects

    These references are synonymous with references to CW Event and CW Archive that appear in earlier versions, and with references to IBM Event and IBM Archive that appear in Siebel 7.5 Business object structure and relationships...
  • Page 50 Specifying key attributes When developing a Siebel business object, always place the key attribute at the top of the object. This ensures that the connector has the key value before processing the rest of the object. Placing the key attribute elsewhere in the object may lead to processing errors.
  • Page 51: Business Object Application-Specific Information

    Table 6. Child object attributes (continued) Name Relationship IsKey IsForeignKey IsRequired Cardinality Business object application-specific information Application-specific information in business object definitions provides the connector with application-dependent instructions on how to process business objects. Because a meta-data-driven connector makes assumptions about how its supported business objects are designed, modifications to business objects must match the connector’s rules for the connector to process modified business objects correctly.
  • Page 52 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 = false AppSpecificInfo = [Attribute] Name = Siebel_BCProductDefect Type = Siebel_BCProductDefect ContainedObjectVersion = 1.0.0...
  • Page 53 Field names for a simple attributes application-specific information for simple business objects attributes must specify the name of the corresponding field in the Siebel business component. The application-specific information for this is: FN=fieldname For example, in the Siebel_BCAccount business object the application-specific information for the Main Phone attribute specifies that Main Phone Number is the corresponding field in the Siebel Account business component.
  • Page 54 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.
  • Page 55 Type = String AppSpecificInfo = FN=AccountId Name = Account Type = Siebel_BCAccount Relationship = Containment Cardinality = 1 IsForeignKey = false AppSpecificInfo = LFN=Account;PL=true;From=AccountId;To=AccountId [Siebel_BCAccount] Name = AccountId IsKey = true AppSpecificInfo = ... 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 key attribute to the key.
  • Page 56 Parameter From = ...; To = ... Field names for container attributes If the relationship between the parent and child objects is one-to-many, application-specific information for a container attribute referencing a child business object must specify the name of the Multi-Value Field related to the parent business component.
  • Page 57 Cardinality = n IsKey = false IsForeignKey = false AppSpecificInfo = MVL=Active;LFN=Street Address Another example for the child business object Siebel_BCOpportunity is shown here which has a many-to-many relationship to Siebel_BCContact or Association. In this case, on a Create operation, the connector searches for the business component using the populated fields of the business object in the container.
  • Page 58 IsKey = true IsFireignKey = false IsRequired - false AppspecificInfo = SF=QuoteId;DF=QuoteId Assigning the value of an attribute to another attribute Attribute application-specific information can be coded so that the connector obtains a value for an attribute and assigns it to another attribute before the second attribute is processed.
  • Page 59 two attributes: a key attribute and a single cardinality container attribute for the picked object. This set of attributes can be used to retrieve some or all of the attributes of the PickList business component that are not included in the PickList map.
  • Page 60 The adapter processes the RetrievebyContent verb similarly to the way it processes the Retrieve verb, except that it does not check to see that all keys are set on the inbound IBM business object. The adapter for Siebel supports wrapper business objects. See“Business object structure and relationships”...
  • Page 61: Chapter 5. Creating Business Objects

    Temp directory, and picking Account_PreDelete.svb for import into 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: © Copyright IBM Corp. 1997, 2004...
  • Page 62 a. Right-click on the Business Address 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 Business_Address_Write.svb, for import into the Bus Comp object and BusComp_WriteRecord procedure.
  • Page 63 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 Contact project. 5.
  • Page 64: Overview Of Siebel Oda

    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.
  • Page 65 Note: Except as otherwise noted, this document uses backslashes (\) as the convention for directory paths. For UNIX installations, substitute slashes (/) for backslashes. All IBM product pathnames are relative to the directory where the product is installed on your system.
  • Page 66 Note: The Windows Installer provides shortcuts to startup the ODAs it installs. If you have used this Installer to install SiebelODA, you will find a shortcut to start it under the menu Programs > IBM WebSphere Business Integration Adapters > Adapters > Object Discovery Agents.
  • Page 67 You configure and run SiebelODA using Business Object Designer. Business Object Wizard, which Business Object Designer starts, locates each ODA by the name specified in the AGENTNAME variable of each script or batch file. The default ODA name for this connector is SeibelODA. Running SiebelODA on multiple machines You can run multiple instances of the ODA, either on the local host or a remote host in the network.
  • Page 68: Using Siebeloda In Business Object Designer

    Table 8. Tracing levels (continued) For information on where you configure these values, see Table 9 on page 58. Using SiebelODA in Business Object Designer This section describes how to use Business Object Designer to generate business object definitions using SiebelODA. For information on launching Business Object Designer, see the Business Object Development Guide.
  • Page 69 Figure 2. Business Object Wizard, Select ODA screen To select the ODA: 1. Click the Find Agents button to display all registered or currently running ODAs in the Located agents field. Alternatively, you can find the ODA using its host name and port number. Note: If Business Object Wizard does not locate your desired ODA, check the setup of the ODA.
  • Page 70 Figure 3. Business Object Wizard, Configure Agent screen Configure the SiebelODA properties described in Table 9. Table 9. SiebelODA configuration properties number Property name UserName Password SiebelConnection String Language version DefaultBOPrefix FileLocation RepositoryName SiebelVersion Adapter for Siebel eBusiness Applications User Guide Property type Description String...
  • Page 71 Table 9. SiebelODA configuration properties (continued) number Property name TraceFileName TraceLevel MessageFile Important: Correct the name of the message file if the default value displayed in You can save these properties in a named profile so that you do not need to re-enter them each time you use SiebelODA.
  • Page 72 Figure 4. Business Object Wizard, Select Source screen This screen has two expandable options, Convert and Generate. If you need to convert old business objects into new ones, expand Convert. This displays the repository files that need to be converted (see Figure 5 ). Figure 5.
  • Page 73 If you need to generate new business objects, expand Generate. From there, you have three expandable options: Business objects, Integration objects, and Application services. For examples of these options expanded, see Figure 6, Figure 7 on page 62, and Figure 8 on page 62. When you expand a business object, you can select a business component for that object.
  • Page 74 Figure 7. Business Object Wizard, displaying Integration Objects expanded Figure 8. Business Object Wizard, displaying Application Services expanded Adapter for Siebel eBusiness Applications User Guide...
  • Page 75 Figure 9. Business Object Wizard, displaying Business Services Confirm selection of objects After you identify all the Siebel elements to be associated with 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.
  • Page 76 Figure 10. Business Object Wizard, confirming selecting of objects and components This window 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.
  • Page 77 Figure 11. Generating the business object definitions Provide additional information Because SiebelODA needs additional information about the verbs, Business Object Designer 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.
  • Page 78 Figure 12. Providing additional information for business object Figure 13. Providing additional information for integration object Adapter for Siebel eBusiness Applications User Guide...
  • Page 79 Figure 14. Providing additional information for application service Figure 15. Providing additional information for a custom-written business service 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.
  • Page 80: Reviewing The Generated Definition

    Save the business object definition After you provide all required information in the BO Properties dialog box and click OK, Business Object Designer displays the final dialog box in the wizard. In this dialog box, you can take any of the following actions: v Save the business object definition to the server (if InterChange Server is the integration broker).
  • Page 81 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-specific information for all attributes, including container attributes.
  • Page 82: Adding Information To The Business Object Definition

    Table 10. Correspondence of data types (continued) DTYPE_CURRENCY 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 simple attributes to 1 and the container attributes to n.
  • Page 83 Note: Because the 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 business objects...
  • Page 84 Adapter for Siebel eBusiness Applications User Guide...
  • Page 85: Chapter 6. Using The Adapter With Siebel Business Services

    Note: This chapter may include references to Event and Archive business components, business objects, and tables. These references are synonymous with references to CW Event and CW Archive that appear in earlier versions, and with references to IBM Event and IBM Archive that appear in Siebel 7.5 Understanding business services This section explains what a business service is and describes how to create business objects that support business services.
  • Page 86 The adapter constructs the property set for the incoming business object, which is the representation of the integration object. The following example describes how the adapter constructs the property set out of the IBM business object representing the integration object.
  • Page 87: Verb Processing With Business Services

    The current version of the adapter and ODA instead use the BSTYPE application-specific information tag. Determines the type of business service. v For EAI Siebel Adapter, where the IBM business object represents the Siebel integration object, the application-specific information should contain BSTYPE=GENERIC.
  • Page 88: Events Detection With Business Services

    The following example describes a process flow for using any of the verbs in Table 13 on page 75. Verbs of the IBM business object represent the Methods of the business service. Verb Processing: v Get the business service name...
  • Page 89 3. Takes the Siebel Message object, if present, as the child property set 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> +Request...
  • Page 90 Adapter for Siebel eBusiness Applications User Guide...
  • Page 91: Chapter 7. Running The Connector

    On Windows systems, from the Start menu Select Programs>IBM WebSphere Business Integration Adapters>Adapters>Connectors. By default, the program name is “IBM WebSphere Business Integration Adapters”. However, it can be customized. Alternatively, you can create a desktop shortcut to your connector.
  • Page 92: Stopping The Connector

    Note: For a WebSphere message broker or WebSphere Application Server on a Windows system, you must include the -c option followed by the name of the connector configuration file. For ICS, the -c is optional. v From Adapter Monitor (available only when the broker is WebSphere Application Server or InterChange Server), which is launched when you start System Manager You can load, activate, deactivate, pause, shutdown or delete a connector using...
  • Page 93: Chapter 8. Troubleshooting

    To enable the result set process to utilize the 2GB memory, your environment must use hardware that facilitates efficient memory utilization without excessive paging. © Copyright IBM Corp. 1997, 2004 connector will die after ten minutes. Based on Siebel, you can change...
  • Page 94 Adapter for Siebel eBusiness Applications User Guide...
  • Page 95: Appendix A. Standard Configuration Properties For Connectors

    TivoliTransactionMonitorPerformance Standard connector properties overview Connectors have two types of configuration properties: v Standard configuration properties, which are used by the framework v Application, or connector-specific, configuration properties, which are used by the agent © Copyright IBM Corp. 1997, 2004...
  • Page 96 These properties determine the adapter framework and the agent run-time behavior. This section describes how to start Connector Configurator and describes characteristics common to all properties. For information on configuration properties specific to a connector, see its adapter user guide. Starting Connector Configurator You configure connector properties from Connector Configurator, which you access from System Manager.
  • Page 97: Standard Properties Quick-Reference

    v System restart The new value takes effect only after you stop and restart the connector agent and the server. To determine how a specific property is updated, refer to the Update Method column in the Connector Configurator window, or see the Update Method column in Table 15 on page 85.
  • Page 98 Table 15. Summary of standard configuration properties (continued) Property name Possible values AgentConnections 1 through 4 AgentTraceLevel 0 through 5 ApplicationName Application name BiDi.Application 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 BiDi.Broker...
  • Page 99 Table 15. Summary of standard configuration properties (continued) Property name Possible values CommonEventInfrastruc true or false ture CommonEventInfrastruc A URL string, for tureURL example, corbaloc:iiop: host:2809. ConcurrentEventTrig 1 through 32,767 geredFlows ContainerManagedEvents Blank or JMS ControllerEventSequenc true or false ControllerStoreAndFor true or false wardMode ControllerTraceLevel...
  • Page 100 Table 15. Summary of standard configuration properties (continued) Property name Possible values jms.ListenerConcurrency 1 through 32767 jms.MessageBrokerName If the value of jms.FactoryClassName is IBM, use crossworlds.queue. manager. jms.NumConcurrent Positive integer Requests jms.Password Any valid password jms.TransportOptimized true or false jms.UserName...
  • Page 101 Table 15. Summary of standard configuration properties (continued) Property name Possible values LogAtInterchangeEnd true or false MaxEventCapacity 1 through 2147483647 MessageFileName Valid file name MonitorQueue Any valid queue name OADAutoRestartAgent true or false OADMaxNumRetry A positive integer OADRetryTimeInterval A positive integer in minutes PollEndTime HH = 0 through 23...
  • Page 102 Table 15. Summary of standard configuration properties (continued) Property name Possible values RequestQueue Valid JMS queue name ResponseQueue Valid JMS queue name RestartRetryCount 0 through 99 RestartRetryInterval A value in minutes from 1 through 2147483647 ResultsSetEnabled true or false ResultsSetSize Positive integer RHF2MessageDomain mrm or xml...
  • Page 103: Standard Properties

    Table 15. Summary of standard configuration properties (continued) Property name Possible values WireFormat CwXML or CwBO WsifSynchronousRequest 0 to any number Timeout (milliseconds) XMLNameSpaceFormat short or long Standard properties This section describes the standard connector configuration properties. AdapterHelpName The AdapterHelpName property is the name of a directory in which connector-specific extended help files are located.
  • Page 104 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 name of the connector application.
  • Page 105 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 hidden.
  • Page 106 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 implement concurrent processing for an entire flow (from a source application to a destination application), the following properties must configured: v The collaboration must be configured to use multiple threads by setting its...
  • Page 107 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 true. ControllerStoreAndForwardMode The ControllerStoreAndForwardMode property sets the behavior of the connector controller after it detects that the destination application-specific component is...
  • Page 108 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 DeliveryTransport property can be MQ, IDL, or JMS, and the default is IDL.
  • Page 109 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 * 256 MB).
  • Page 110 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 the following values: QueueMgrName:Channel:HostName:PortNumber where:...
  • Page 111 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 the RepositoryDirectory property is set to <REMOTE>.
  • Page 112 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 to the list, you modify the \Data\Std\stdConnProps.xml file in the <ProductDir>\bin directory.
  • Page 113 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 of the DeliveryTransport property is JMS and the value of the DuplicateEventElimination is true.
  • Page 114 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 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.
  • Page 116 RestartRetryCount The RestartRetryCount property specifies the number of times the connector attempts to restart itself. When this property is used for a connector that is connected in parallel, it specifies the number of times the master connector application-specific component attempts to restart the client connector application-specific component.
  • Page 117 This property is valid only if the value of DeliveryTransport is JMS. The default is <CONNECTORNAME>/SYNCHRONOUSRESPONSEQUEUE TivoliMonitorTransactionPerformance The TivoliMonitorTransactionPerformance property specifies whether IBM Tivoli Monitoring for Transaction Performance (ITMTP) is invoked at run time. The default value is false. WireFormat The WireFormat property specifies the message format on the transport: Appendix A.
  • Page 118 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 the connector waits for a response to a synchronous request.
  • Page 119: Appendix B. Connector Specific Properties

    Indicates whether the adapter processes the event or not. Can be used to switch off subscription services if necessary. © Copyright IBM Corp. 1997, 2004 Possible values True or False Any network failure or connectivity failure messages. These messages are separated by the ’;’...
  • Page 120 Table 16. Connector-specific configuration properties (continued) Name Meaning PollAttributeDelimiter In case of multiple name-value pairs in the object key, this value determines the delimiter between the keys. If not set, the default is; (semi-colon). PollQuantity Determines the number of events that gets processed with a pollForEvents call.
  • Page 121: Applicationpassword

    Table 16. Connector-specific configuration properties (continued) Name Meaning 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 the business object level.
  • Page 122: Connectorid

    ConnectorID A unique ID for the connector. This ID is useful to retrieve events for a particular instance of the connector. Default value is null. ConnectString A string used by the Siebel Java Data Bean to connect to the Siebel Object Manager. The value that you set depends on the version of Siebel that you are using.
  • Page 123: Siebellanguagecode

    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.
  • Page 124 Adapter for Siebel eBusiness Applications User Guide...
  • Page 125: Appendix C. Common Event Infrastructure

    Any doVerbFor call issued from the adapter agent v A gotApplEvent call from the adapter agent For another application (the “consumer application”) to receive the Common Event Infrastructure events generated by the adapter, the application must use the © Copyright IBM Corp. 1997, 2004...
  • Page 126: For More Information

    For more information about event definitions and how to query them, refer to the Common Event Infrastructure documentation that is available from the online IBM WebSphere Server Foundation Information Center. For WebSphere Business Integration adapters, the extended data elements that need to be defined in the event catalog are the keys of the business object.
  • Page 127 <property name="sourceComponentId" path="sourceComponentId" required="true"/> <property name="application" source application generating the event. Example is "SampleConnector#3.0.0" path="sourceComponentId/application" <property name="component" of the source component. path="sourceComponentId/component" required="true" defaultValue="ConnectorFrameWorkVersion#4.2.2"/> <property name="componentIdType" and meaning of the component path="sourceComponentId/componentIdType" required="true" defaultValue="Application"/> <property name="executionEnvironment" //Comment: Identifies the environment the application is running in...example is "Windows 2000#5.0"...
  • Page 128: Xml Format For "Stop Adapter" Metadata

    path="situation/situationType/situationQualifier" required="true" permittedValue="START_INITIATED" permittedValue="RESTART_INITIATED" permittedValue="START_COMPLETED" /> </eventDefinition> XML format for ″stop adapter″ metadata The metadata for “stop adapter” is the same as that for “start adapter” with the following exceptions: v The default value for the categoryName property is StopSituation: <property name="categoryName="...
  • Page 129: Xml Format For "Request" Or "Delivery" Metadata

    XML format for ″request″ or ″delivery″ metadata At the end of this XML format are the extended data elements. The extended data elements for adapter request and delivery events represent data from the business object being processed. This data includes the name of the business object, the key (foreign or local) for the business object, and business objects that are children of parent business objects.
  • Page 130 <property name="locationType" //Comment specifies the format and meaning of the location <property name="subComponent" //Comment:further distinction of the logical component-in this case the value is the name of the business object <property name="componentType" to characterize all instances of this component <property name="situation" //Comment: Defines the type of situation that caused the event to be reported <property name="categoryName"...
  • Page 131: Appendix D. Application Response Management

    Transaction Performance server). This does not have to be installed on the same system as the adapter. v IBM Tivoli Monitoring for Transaction Performance 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 resides.
  • Page 132 For more information Refer to the IBM Tivoli Monitoring for Transaction Performance documentation for more information. In particular, refer to the IBM Tivoli Monitoring for Transaction Performance User’s Guide for information about monitoring and managing the metrics generated by the adapter.
  • Page 133: Index

    2 ConnectorID 110 ConnectString 110 ContainedObjectVersion 38 container attributes 43 create requests 4 custom business services 73 © Copyright IBM Corp. 1997, 2004 DataBeanPoolSize 110 DataBeanRefreshInterval 110 datatype mapping 54 DefaultValue 38 delete requests 5 EAI Siebel Adapter 73...
  • Page 134 verbs, application specific information 48 verbs, key attributes 48 verbs, with business services 75 ViewMode 111 WebSphere business integration system 2 Windows 10 Adapter for Siebel eBusiness Applications User Guide...
  • Page 135: Notices

    Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.
  • Page 136: Programming Interface Information

    The licensed program described in this document and all licensed material available for it are provided by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or any equivalent agreement between us.
  • Page 137: Trademarks And Service Marks

    Trademarks and service marks The following terms are trademarks or registered trademarks of International Business Machines Corporation in the United States or other countries, or both: the IBM logo CICS CrossWorlds DB2 Universal Database...
  • Page 138 Adapter for Siebel eBusiness Applications User Guide...
  • Page 140 Printed in USA...