IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter Version 4.6.
IBM WebSphere Business Integration Adapters Adapter for Siebel eBusiness Applications User Guide Adapter Version 4.6.
Note! Before using this information and the product it supports, read the information in “Notices” on page 123 30September2004 This edition of this document applies to WebSphere Business Integration Adapter for Siebel eBusiness Applications (5724-H43), Version 4.6. To send us your comments about this document, e-mail doc-comments@us.ibm.com. We look forward to hearing from you.
Contents About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v What this document includes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v What this document does not include . . . . . . . . . . . . . . . . . . . . . . . . . . . v Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . v Typographic conventions . . . . . . . . . . . . . . . . . . . . . . .
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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 75 76 76 Chapter 7.
About this document The IBMR WebSphereR 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 components for business integration.
v For general adapter information; for using adapters with WebSphere message brokers (WebSphere MQ Integrator, WebSphere MQ Integrator Broker, WebSphere Business Integration Message Broker); and for using adapters with WebSphere Application Server: http://www.ibm.com/websphere/integration/wbiadapters/infocenter v For using adapters with InterChange Server: http://www.ibm.com/websphere/integration/wicserver/infocenter http://www.ibm.
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 is modified so that it can process business services where the request contains only simple attributes and no SiebelMessage container attribute.
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. New in release 4.3.x Updated in July, 2003. The adapter can now use WebSphere Application Server as an integration broker. For further information, see “Adapter environment” on page 9.
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.
x Adapter for Siebel eBusiness Applications User Guide
Chapter 1.
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). A connector consists of the connector framework and the connector’s application-specific component.
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. The following diagram illustrates the Siebel connector architecture.
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; that is, it performs the same steps for each child business object until it has processed all individual business objects.
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. If any of the required attributes are missing from the inbound business object, the delete fails.
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 object key specified in the Event business component), and retrieves the business object from the Siebel application.
Table 2.
the meaning of the data. The Java runtime environment within the Java Virtual Machine (JVM) represents data in the Unicode character code set. Unicode contains encodings for characters in most known character code sets (both single-byte and multibyte). Most components in the WebSphere business integration system are written in Java. Therefore, when data is transferred between most Server Access components, there is no need for character conversion.
Chapter 2. Installing the adapter v “Adapter environment” v “Installing the adapter and related files” on page 11 v “Verifying an installation” on page 11 v “Event and archive tables” on page 12 This chapter describes how to install the WebSphere® Business Integration Adapter for Siebel eBusiness Applications. Note: This chapter includes references to Event and Archive business components, business objects, and tables.
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. v Verify the existence of a user account in the application.
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.
Table 4. Installed Windows file structure for the connector Subdirectory of %ProductDir% Description \connectors\Siebel Contains the connector CWSiebel.jar and the start_Siebel.bat files. Contains the patch files for event management in the Siebel eBusiness applications. This folder should also contain the Siebel .jar files. Contains the relevant message file, SiebelConnector.
v The number of events for each polling interval v Whether the connector archives unsubscribed and unprocessed events v The unique ID of the connector, which is important when multiple connectors poll the same table Creating the event and archive tables in Siebel, versions 7.5 and 7.7 This procedure uses the Siebel Sales Enterprise application as an example. Substitute all references to Siebel Sales Enterprise with the name of the Siebel application in use.
6. 7. 8. 9. 10. 11. 12. 13. 14 b. Right-click and select New Record from the menu. c. Enter IBM 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 the application. e. 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.
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. Make sure that you leave the table space and index space blank. 15. Activate the queried tables in the development database. 16.
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 each file from: to: Replace all instances of the “ENU” language setting with “JPN.” If you use the search and replace function of your text editor, make sure you use quotation marks around the language setting to make sure no similar words (for example, MENU) are replaced.
9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 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. Apply the physical schema for the new tables to your local database.
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.
Chapter 3. Configuring the connector This chapter describes how to install and configure the adapter using Connector Configurator.
Connector configuration properties include both standard configuration properties (the properties that all connectors have) and connector-specific properties (properties that are needed by the connector for a specific application or technology). Because standard properties are used by all connectors, you do not need to define those properties from scratch; Connector Configurator incorporates them into your configuration file as soon as you create the file.
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. 4.
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. If you do not see any template that displays the connector-specific properties used by your connector, you will need to create one.
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 you entered in the Property Value dialog box. After a value has been created and appears in the grid, it can be edited from within the table display.
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.
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. Select the template you want to use and click OK. 4. A configuration screen appears for the connector that you are configuring. The title bar shows the integration broker and connector name.
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. 3. In the directory display, navigate to the appropriate connector definition file, select it, and click Open.
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.
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. Click in the field whose value you want to set. 2. Either enter a value, or select one from the drop-down menu if it appears. Note: If the property has a Type of String, it may have a subtype value in the Subtype column.
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 hot button does not appear, no Extended Help was found for that property. 5. Choose to save or discard changes, as described for “Setting standard connector properties” on page 28.
(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.
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. The Message Set ID is an optional field for WebSphere Business Integration Message Broker 5.0, and need not be unique if supplied.
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 explicitly bind an associated map. Explicit binding is required only when more than one map exists for a particular supported business object.
By default, Privacy is turned off. Check the Privacy box to enable it. The Keystore Target System Absolute Pathname is: v For Windows: \connectors\security\.jks v For UNIX: opt/IBM/WebSphereAdapters/connectors/security/.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.
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. Click the Trace/Log Files tab. 2. For either logging or tracing, you can choose to write messages to one or both of the following: v To console (STDOUT): Writes logging or tracing messages to the STDOUT display.
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.
String ja_JP ko_KR zh_CN zh_TW fr_FR de_DE it_IT es_ES pt_BR en_US en_GB en_US 36 Adapter for Siebel eBusiness Applications User Guide
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 the object relationships within the Siebel architecture. Note: This chapter includes references to Event and Archive business components, business objects, and tables.
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. The key attribute for an object is its RowId in Siebel.
Table 6. Child object attributes (continued) Name Name of the child object Relationship If the child is a container attribute, this is set to Containment. This attribute has to be set on the primary business component. Not used. If set to True, the child is expected to have a representation in the parent business object. During Create verb processing, the primary business component is required to be present. A check is made to see if this component is present in the inbound business object.
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.
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.
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 retrieved, you can restrict the PickList by more than one field.
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 = ...
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-to-one relationship. This is used in a Retrieve operation and to specify which child record needs to be fetched.
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. If the connector finds a matching object, it associates it with the parent business component.
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. This functionality is used in a Retrieve operation and is primarily used on container attributes to specify which record for the child should be retrieved.
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. For example, the Siebel_BCQuote business object might be designed to include two attributes to specify a PickList relationship between Quote and Opportunity. As shown below, OpportunityId is the key attribute, and Opportunity is the PickList object.
v Mapping of the key attribute when it is a business object request from the collaboration to the connector should follow the same guidelines for simple attributes as described above. v Mapping of the container attribute should be keys only if keys are known. v If the PickList object will be created, map all the required attributes as specified for the PickList object. v On a Delete operation, set the key attribute to a space and the PickList container attribute to null.
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 business object definition” on page 70 Modifying business object samples Business object samples are provided with the connector component of the adapter. All objects must have Siebel triggers on them for polling.
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. c. Import the second VB code by selecting import from the File menu, choosing the Temp directory, and picking Business_Address_PreDelete.
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. Add the Siebel VB script to the Contact business component as follows: a. Right-click on the Contact business component, and select Edit BasicScripts from the menu. This launches the script editor. b.
2. Save the Siebel VB file in a temporary directory. For example, use Temp as the directory name. 3. Give the CWCONN account the System Administrator responsibility within Siebel. 4. In your Siebel Tools environment, check out and lock the Asset Management project. 5. Add the Siebel VB script to the Asset Mgmt - Asset business component as follows: a. Right-click on the Asset Mgmt - Asset business component, and select the Edit Basic Scripts from the menu. This launches the script editor. b.
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 v v v ODA\Siebel\start_SiebelODA.bat (Windows only) ODA/Siebel/start_SiebelODA.sh (UNIX only) bin\CWODAEnv.bat (Windows only) bin/CWODAEnv.sh (UNIX only) Note: If ICS is your broker, CWODAEnv.bat must be modified to reflect the version of ICS. For ICS version 4.2.x, change CWVERSION to 4.2.
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.
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. Each instance runs on a unique port.
Table 8. Tracing levels (continued) 5 v Indicates the ODA initialization values for all of its properties v Traces a detailed status of each thread that SiebelODA spawned v Traces the business object definition dump 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.
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. 2. Select the desired ODA from the displayed list. Business Object Wizard displays your selection in the Agent’s name field. 3. Click Next.
Figure 3. Business Object Wizard, Configure Agent screen Configure the SiebelODA properties described in Table 9. Table 9. SiebelODA configuration properties Row number Property name Property type Description 1 2 3 UserName Password SiebelConnection String String String String Siebel application login name Siebel application password Connect string to log into the Siebel application. Examples: For Siebel 7.x: //machinename/enterprisename/objectmanager /servername For Siebel 7.
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 exists, SiebelODA appends to it. By default, SiebelODA creates a trace file named SiebelODAtrace.txt in the ODA\Siebel subdirectory of the product directory.
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.
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. Similarly, when you expand an integration object, you can select an integration component for that object.
Figure 7. Business Object Wizard, displaying Integration Objects expanded Figure 8.
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. Chapter 5.
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. When the selection is correct, click Next. Generate the business object definition After you confirm the Siebel elements, the next dialog box informs you that Business Object Designer is generating the business object definition.
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. Figure 12 on page 66 illustrates these screens. Chapter 5.
Figure 12. Providing additional information for business object Figure 13.
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. 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.
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). v Save the business object definition to a file (for any integration broker).
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.
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 simple attributes to 1 and the container attributes to n. The user should change the cardinality of the container attributes wherever it is needed.
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.
72 Adapter for Siebel eBusiness Applications User Guide
Chapter 6. Using the adapter with Siebel business services v “Understanding business services” v “Verb processing with business services” on page 75 v “Events detection with business services” on page 76 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.
Note: The adapter distinguishes between IBM objects representing business objects to Siebel, and IBM business objects representing Siebel integration objects by application-specific information ″BSN=″. See Table 11. Processing business objects that support business services The adapter constructs the property set for the incoming business object, which is the representation of the integration object.
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 Account or Siebel Contact, the specific business service must be present. When using other integration objects, the Siebel Enterprise Applications Integration (EAI) must be present.
Table 13. Verbs supported by business services (continued) Verb Description QueryByExample (or Query in the Queries for objects based on the example object case of EAI Siebel Adapter) provided. This operation can be treated as a Retrieve by content operations. QueryById If the object with the keys exists, it is queried or retrieved. These operations can be treated as Retrieve operations.
properties. If present, the SiebelMessage container attribute provides the integration object. The adapter can process the business object with or without the existence of the SiebelMessage container attribute. The adapter does the following: 1. Instantiates a new property set 2. Sets the simple attribute vales as the properties of the new property set 3.
78 Adapter for Siebel eBusiness Applications User Guide
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\connectors\connName where connName identifies the connector. On UNIX systems the startup script should reside in the ProductDir/bin directory.
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 this tool.
Chapter 8. Troubleshooting This chapter describes error messages that you may encounter when running the connector and possible fixes for those errors. MAX_LOG_FILE_SIZE error on UNIX When running the connector on UNIX, you may receive the following error message: Using default value UNLIMITED for configuration parameter MAX_LOG_FILE_SIZE in subsystem LOGGING. This error message may result from the following conditions: v The OS agent is not running. v Incorrect information in the InterchangeSystem.
82 Adapter for Siebel eBusiness Applications User Guide
Appendix A. Standard configuration properties for connectors This appendix describes the standard configuration properties for the connector component of WebSphere Business Integration adapters.
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.
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. There are three locations in which a standard property can reside. Some properties can reside in more than one location. v ReposController The property resides in the connector controller and is effective only there.
Table 15. Summary of standard configuration properties (continued) Update method Property name Possible values Default value AgentConnections 1 through 4 1 Component restart Notes AgentTraceLevel 0 through 5 0 Dynamic if broker is ICS; otherwise Component restart ApplicationName Application name The value specified for the connector application name Component restart BiDi.
Table 15. Summary of standard configuration properties (continued) Update method Property name Possible values Default value CommonEventInfrastruc ture true or false false Component restart Notes CommonEventInfrastruc tureURL A URL string, for example, corbaloc:iiop: host:2809. No default value. Component restart This property is valid only if the value of CommonEvent Infrastructure is true.
Table 15. Summary of standard configuration properties (continued) Update method Property name Possible values Default value jms.ListenerConcurrency 1 through 32767 1 Component restart This property is valid only if the value of jms.TransportOptimized is true. jms.MessageBrokerName If the value of jms.FactoryClassName is IBM, use crossworlds.queue. manager. crossworlds.queue. manager Component restart This property is valid only if the value of DeliveryTransport is JMS . jms.
Table 15. Summary of standard configuration properties (continued) Update method Property name Possible values Default value LogAtInterchangeEnd true or false false Component restart Notes This property is valid only if the value of Repository Directory is set to and the value of BrokerType is ICS. MaxEventCapacity 1 through 2147483647 2147483647 Dynamic This property is valid only if the value of Repository Directory is set to and the value of BrokerType is ICS.
Table 15. Summary of standard configuration properties (continued) Property name Possible values Default value Update method RequestQueue Valid JMS queue name /REQUESTQUEUE Component restart This property is valid only if the value of DeliveryTransport is JMS ResponseQueue Valid JMS queue name /RESPONSEQUEUE Component restart This property is valid only if the value of DeliveryTransport is JMS.
Table 15. Summary of standard configuration properties (continued) Property name Possible values Default value Update method WireFormat CwXML or CwBO CwXML Agent restart The value of this property must be CwXML if the value of RepositoryDirectory is not set to . The value must be CwBO if the value of RepositoryDirectory is set to . WsifSynchronousRequest Timeout 0 to any number (milliseconds) 0 Component restart This property is valid only if the value of BrokerType is WAS.
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. This name is used by the system administrator to monitor the integration environment. This property must have a value before you can run the connector.
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. The default value is false. BrokerType The BrokerType property identifies the integration broker type that you are using. The possible values are ICS, WMQI (for WMQI, WMQIB or WBIMB), or WAS.
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.
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 (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 unavailable.
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 , the value of the DeliveryTransport property can be MQ, IDL, or JMS, and the default is IDL. v If the value of the RepositoryDirectory property is a local directory, the value can be only JMS.
This script is located in the \bin directory below the product directory (). 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). If the process memory grows larger than this limit, page swapping can occur, which can adversely affect the performance of your system. v Set the value of the IPCCBaseAddress property to 11 or 12.
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: QueueMgrName is the name of the queue manager. Channel is the channel used by the client.
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 . The default value is 128m. JvmMaxNativeStackSize The JvmMaxNativeStackSize property specifies the maximum native stack size for the agent (in kilobytes).
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 \bin directory. For more information, refer to the Connector Configurator appendix in this guide.
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.
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. If the adapter runtime detects: v PollStartTime set and PollEndTime not set, or v PollEndTime set and PollStartTime not set it will poll using the value configured for the PollFrequency property.
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, so it sends the business object to Visual Test Connector. v Once it is accepted, the third BO attachment should be transmitted.
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. The default value is 3.
Possible values are mrm and xml. The default value is mrm. SourceQueue The SourceQueue property designates the JMS source queue for the connector framework in support of guaranteed event delivery for JMS-enabled connectors that use a JMS event store. For further information, see “ContainerManagedEvents” on page 94. This property is valid only if the value of DeliveryTransport is JMS, and a value for ContainerManagedEvents is specified. The default value is /SOURCEQUEUE.
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.
Appendix B. Connector specific properties Connector-specific configuration properties provide information needed by the connector at runtime. Connector-specific properties also provide a way of changing static information or logic within the connector without having to recode and rebuild the agent. The following table lists the connector-specific configuration properties for the connector. See the sections that follow for explanations of the properties. Table 16.
Table 16. Connector-specific configuration properties (continued) Name Meaning Possible values Default value 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). Determines the number of events that gets processed with a pollForEvents call. Indicates if Resonate has been installed with the Siebel server.
Table 16. Connector-specific configuration properties (continued) Name Meaning Possible values ViewMode Retained for backward An integer value. Refer to VM asi compatibility. An integer for details. 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. Default value ApplicationPassword Password for the application user account. There is no default value.
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. There is no default value for this property. DataBeanPoolSize An integer that indicates the maximum number of beans in the data bean pool.
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. SiebelLanguageCode Three letter NLS character set code used by Siebel for the languages supported. Default is US English with enu as the NLS representation.
112 Adapter for Siebel eBusiness Applications User Guide
Appendix C. Common Event Infrastructure WebSphere Business Integration Server Foundation includes the Common Event Infrastructure Server Application, which is required for Common Event Infrastructure to operate. The WebSphere Application Server Foundation can be installed on any system (it does not have to be the same machine on which the adapter is installed.
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 definitions” appendix of this document contains XML format metadata showing, for WebSphere Business Information adapters, the event descriptors and properties the consumer application should search for.
PAGE 128path="situation/situationType/situationQualifier" required="true" permittedValue="START_INITIATED" permittedValue="RESTART_INITIATED" permittedValue="START_COMPLETED" /> 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: PAGE 129XML 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.
required="true"/> PAGE 131Appendix 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 can participate in IBM Tivoli Monitoring for Transaction Performance, allowing collection and review of data concerning transaction metrics.
For example, the name of a transaction for an event delivery for creation of an employee might be EVENT DELIVERY CREATE EMPLOYEE. Another might be SERVICE REQUEST UPDATE ORDER.
Index A D 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-specific information 39 application-specific information, for container attributes 43 application-specific information, for simple attributes 40 ApplicationUserName 109 AppSpecificInfo 38 archive table 12 ArchivePr
V verbs, application specific information 48 verbs, key attributes 48 verbs, with business services ViewMode 111 75 W WebSphere business integration system 2 Windows 10 122 Adapter for Siebel eBusiness Applications User Guide
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 state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead.
Burlingame, CA 94010 U.S.A Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. The licensed program described in this document and all licensed 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. Any performance data contained herein was determined in a controlled environment.
However, this information may also contain diagnosis, modification, and tuning information. Diagnosis, modification and tuning information is provided to help you debug your application software. Warning: Do not use this diagnosis, modification, and tuning information as a programming interface because it is subject to change.
126 Adapter for Siebel eBusiness Applications User Guide
Printed in USA
