ibm websphere adapter for...

IBM WebSphere Adapter for Siebel Business Applications 7.0.0.0 Quick Start Scenarios

December 15, 2009 of 132

Note: Before using this information and the product it supports, read the information in the “Notices” section, at the end of this document.

This edition applies to version 7, release 0, and modification 0 of IBM WebSphere Adapter for Siebel Business Applications and to all subsequent releases and modifications, until otherwise indicated in new editions.

© Copyright International Business Machines Corporation 2009. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.


Table of Contents

I B M W e b S p h e r e A d a p t e r f o r S i e b e l Business Applications ......................................................... Error! Bookmark not defined.

Table of Contents ............................................................................................3

Table of Figures...............................................................................................7

C h a p t e r 1 . Introduction ......................................................................11

1.1 Learning objectives ............................................................................................................. 11 1.2 Audience ............................................................................................................................. 11 1.3 Software prerequisites ........................................................................................................ 11 1.4 Scenarios in brief:................................................................................................................ 11 1.4.1 Outbound process using Siebel business service ........................................................... 12 1.4.2 Outbound process using Siebel business object ............................................................. 12 1.4.3 Inbound process using Siebel integration object ............................................................. 12 1.4.4 Inbound using Siebel business object.............................................................................. 13 1.4.5 Outbound using Siebel business service with specified integration object...................... 13 1.4.6 Inbound using Siebel business object with specific attribute selected............................. 13

C h a p t e r 2 . Preparing to run through the tutorials ...........................14

2.1 Extracting the sample files .................................................................................................. 14 2.2 Create an event table in Siebel ........................................................................................... 14 2.3 Create an authentication alias............................................................................................. 16 2.4 Creating the adapter project in WebSphere Integration Developer .................................... 21 2.5 Start the external service wizard ......................................................................................... 24

C h a p t e r 3 . Tutorial for outbound processing using Siebel business service ...........................................................................................29

3.1 Start the external service wizard ......................................................................................... 30 3.2 Setting connection properties for the external service wizard ............................................ 31 3.3 Selecting the Siebel business services............................................................................... 32 3.4 Generating business object definitions and related artifacts .............................................. 34 3.5 Service generation and deployment configuration.............................................................. 35 3.6 Configuring the adapter properties...................................................................................... 37 3.7 Deploying the adapter project to the test environment ....................................................... 38 3.8 Testing the adapter application ........................................................................................... 40

3.8.1 Running the Insert operation............................................................................................. 40


3.8.2 Running the QueryByExample operation.......................................................................... 44

C h a p t e r 4 . Tutorial for outbound processing using Siebel business object ...........................................................................................47

4.1 Start the external service wizard ......................................................................................... 48 4.2 Setting connection properties for the external service wizard ............................................ 49 4.3 Selecting the Siebel business objects................................................................................. 49 4.4 Generating business object definitions and related artifacts .............................................. 50 4.5 Service generation and deployment configuration.............................................................. 51 4.6 Configuring the adapter properties...................................................................................... 54 4.7 Deploying the adapter project to the test environment ....................................................... 55 4.8 Testing the adapter application ........................................................................................... 55

4.8.1 Running the Create operation ........................................................................................... 55 4.8.2 Running the Exists operation ............................................................................................ 58

C h a p t e r 5 . Tutorial for inbound processing using Siebel business service ...........................................................................................60

5.1 Start the external service wizard ......................................................................................... 61 5.2 Setting connection properties for the external service wizard ............................................ 62 5.3 Selecting the Siebel business services............................................................................... 64 5.4 Generating business object definitions and related artifacts .............................................. 65 5.5 Service generation and deployment configuration.............................................................. 66 5.6 Configuring the adapter properties...................................................................................... 68 5.7 Wiring the inbound interface ............................................................................................... 70 5.8 Deploying the adapter project to the test environment ....................................................... 73 5.9 Testing the assembled adapter application ........................................................................ 73

C h a p t e r 6 . Tutorial for inbound processing using Siebel business object ...........................................................................................75

6.1 Start the external service wizard ......................................................................................... 76 6.2 Setting connection properties for the external service........................................................ 76 6.3 Selecting the Siebel business objects................................................................................. 77 6.4 Generating business object definitions and related artifacts .............................................. 79 6.5 Service generation and deployment configuration.............................................................. 80 6.6 Configuring the adapter properties...................................................................................... 82 6.7 Wiring the inbound interface ............................................................................................... 83 6.8 Deploying the adapter project to the test environment ....................................................... 86 6.9 Testing the assembled adapter application ........................................................................ 86


C h a p t e r 7 . Tutorial for outbound processing using Siebel business service with specified integration object.....................................................88

7.1 Start the external service wizard ......................................................................................... 89 7.2 Setting connection properties for the external service wizard ............................................ 90 7.3 Selecting the Siebel business services............................................................................... 92 7.4 Generating business object definitions and related artifacts .............................................. 95 7.5 Service generation and deployment configuration.............................................................. 96 7.6 Configuring the adapter properties...................................................................................... 98 7.7 Deploying the adapter project to the test environment ....................................................... 99 7.8 Testing the adapter application ......................................................................................... 100

7.8.1 Running the Insert operation........................................................................................... 100 7.8.2 Running the Query operation .......................................................................................... 103

C h a p t e r 8 . Tutorial for inbound processing using Siebel business object with specific attribute selected .......................................................107

8.1 Start the external service wizard ....................................................................................... 109 8.2 Setting connection properties for the external service wizard .......................................... 109 8.3 Selecting the Siebel business objects............................................................................... 110 8.4 Generating business object definitions and related artifacts ............................................ 114 8.5 Service generation and deployment configuration............................................................ 115 8.6 Configuring the adapter properties.................................................................................... 117 8.7 Wiring the inbound interface ............................................................................................. 117 8.8 Deploying the adapter project to the test environment ..................................................... 121 8.9 Testing the assembled adapter application ...................................................................... 121

C h a p t e r 9 . Troubleshooting the tutorial .........................................123

9.1 Deployment failure ............................................................................................................ 123 9.2 Export project into EAR file ............................................................................................... 123

Deploying project through administrative console.................................................................... 124 Starting the application through administrative console........................................................... 127 9.3 Create record failed........................................................................................................... 127

C h a p t e r 1 0 . Appendix......................................................................128

10.1 Clearing the tutorial content ............................................................................................ 128 10.1.1 Business service ‘Siebel Contact’ – ‘Insert’ operation .................................................. 128 10.1.2 Business Service ‘Siebel Contact’ – ‘QueryByExample’ operation............................... 128 10.1.3 Business Object ‘Account – ESP’ – ‘Create’ operation................................................. 128


10.1.4 Business Object ‘Account – ESP’ – ‘Exists’ operation .................................................. 128

Notices..........................................................................................................129


Table of Figures

Figure 1: Choose Servers’ View..........................................................................................................17 Figure 2: Java Authentication and Authorization Service (JAAS) ........................................................18 Figure 3: Create a New Authentication Alias with User ID, Password and Description.......................19 Figure 4: Select Authentication Entries ................................................................................................20 Figure 5: Import adapter with WID........................................................................................................21 Figure 6: Import adapter RAR File........................................................................................................22 Figure 7: Connector Import window prompt .........................................................................................23 Figure 8: Confirm perspective switch ...................................................................................................23 Figure 9: Project Explorer's view in Business Integration perspective.................................................24 Figure 10: New External Service..........................................................................................................25 Figure 11: Select the Services Type or Registry ..................................................................................26 Figure 12: Select the imported adapter ................................................................................................27 Figure 13: Locate Siebel dependency jar files .....................................................................................28 Figure 14: Processing Direction ...........................................................................................................30 Figure 15: Discovery Configuration ......................................................................................................31 Figure 16: Discovery Configuration - Bidi Properties and Log Properties............................................32 Figure 17: Query Properties .................................................................................................................33 Figure 18: Selected Objects .................................................................................................................34 Figure 19: Configure Composite Properties .........................................................................................35 Figure 20: Service Generation and Deployment Configuration............................................................36 Figure 21: Service Location Properties window ...................................................................................37 Figure 22: Assembly diagram...............................................................................................................38 Figure 23: Open Test Module...............................................................................................................40 Figure 24: Type of Operation on Component.......................................................................................41 Figure 25: Add Property Object Element..............................................................................................41 Figure 26: Select Deployment Location ...............................................................................................43 Figure 27: Business Object Attributes ..................................................................................................43 Figure 28: Operation Type....................................................................................................................44 Figure 29: Add Element to Business Object.........................................................................................44 Figure 30: ID of Existing Record...........................................................................................................45 Figure 31: Select Deployment Location ...............................................................................................45 Figure 32: Invoke..................................................................................................................................46 Figure 33: Processing Direction ...........................................................................................................48


Figure 34: Discovery Configuration ......................................................................................................49 Figure 35: Object Discovery and Selection ..........................................................................................50 Figure 36: Configure Composite Properties .........................................................................................51 Figure 37: Service Generation and Deployment Configuration............................................................52 Figure 38: Service Location Properties ................................................................................................53 Figure 39: Assembly Diagram and Properties View.............................................................................54 Figure 40: Operation Type....................................................................................................................55 Figure 41: Create a business object.....................................................................................................56 Figure 42: Select Deployment Location ...............................................................................................57 Figure 43: Return Output......................................................................................................................57 Figure 44: Setting Component, Interface or Operation ........................................................................58 Figure 45: Business Object Reference ID ............................................................................................58 Figure 46: Successful Status Returned................................................................................................59 Figure 47: Processing Direction ...........................................................................................................61 Figure 48: Discovery Configuration - Siebel Business Service ............................................................62 Figure 49: Discovery Configuration - Bidi Properties and Log Properties............................................63 Figure 50: Query Properties .................................................................................................................64 Figure 51: Configuration Properties For 'QueryByExample' ................................................................65 Figure 52: Configure Composite Properties .........................................................................................65 Figure 53: Service Generation and Deployment Configuration............................................................67 Figure 54: Service Location Properties ................................................................................................68 Figure 55: Assembly Diagram and Properties View.............................................................................69 Figure 56: Untyped Component Added................................................................................................70 Figure 57: Component Wired to Interface ............................................................................................70 Figure 58: Add Wire Window Prompt ...................................................................................................71 Figure 59: Generate Implementation....................................................................................................71 Figure 60: Default Package Selected...................................................................................................72 Figure 61: Add Trace Statements.........................................................................................................72 Figure 62: Trace Statement Captured..................................................................................................74 Figure 63: Processing Direction ...........................................................................................................76 Figure 64: Object Discovery and Selection ..........................................................................................77 Figure 65: Discovered and Selected Objects .......................................................................................78 Figure 66: Configure Composite Properties .........................................................................................79 Figure 67: Service Generation and Deployment Configuration............................................................80 Figure 68: Service Location Properties ................................................................................................81 Figure 69: Connection Properties.........................................................................................................82 Figure 70: Untyped Component Added................................................................................................83


Figure 71: Component Wired to Interface ............................................................................................83 Figure 72: Add Wire Window Prompt ...................................................................................................84 Figure 73: Generate Implementation, Java ..........................................................................................84 Figure 74: Default Package Selected...................................................................................................85 Figure 75: Add Trace Statements.........................................................................................................85 Figure 76: Trace Statement Captured..................................................................................................87 Figure 77: Processing Direction ...........................................................................................................89 Figure 78: Discovery Configuration ......................................................................................................90 Figure 79: Discovery Configuration - Bidi Properties and Log Properties............................................91 Figure 80: Query Properties .................................................................................................................92 Figure 81: Selected Objects .................................................................................................................92 Figure 82: Configuration Properties......................................................................................................93 Figure 83: Integration Object Selection ................................................................................................93 Figure 84: Configuration for Query.......................................................................................................94 Figure 85: Object Selection ..................................................................................................................94 Figure 86: Configure Composite Properties .........................................................................................95 Figure 87: Service Generation and Deployment Configuration............................................................96 Figure 88: Service Location Properties window ...................................................................................97 Figure 89: Assembly diagram...............................................................................................................98 Figure 90: Add Property Object Element............................................................................................100 Figure 91: Input SiebelMessage.........................................................................................................101 Figure 92: Select Deployment Location .............................................................................................102 Figure 93: Returned Object ................................................................................................................103 Figure 94: Values for Query ...............................................................................................................104 Figure 95: Select Deployment Location .............................................................................................105 Figure 96: Return Values....................................................................................................................106 Figure 97: Processing Direction .........................................................................................................109 Figure 98: Discovery Configuration ....................................................................................................110 Figure 99: Configuration Properties for Account ................................................................................111 Figure 100: Select Attributes ..............................................................................................................112 Figure 101: Select Objects .................................................................................................................113 Figure 102: Configure Composite Properties ....................................................................................114 Figure 103: New Module ....................................................................................................................115 Figure 104: Service Location Properties ............................................................................................116 Figure 105: Java Component Added..................................................................................................117 Figure 106: Component Wired to Interface ........................................................................................118 Figure 107: Add Wire Window Prompt ...............................................................................................118


Figure 108: Generate Implementation, Java ......................................................................................119 Figure 109: Default Package Selected...............................................................................................119 Figure 110: Add Trace Statements.....................................................................................................120 Figure 111: Export EAR file option .....................................................................................................123 Figure 112: Export EAR file ................................................................................................................124 Figure 113: Select Application Type...................................................................................................125 Figure 114: Install an application........................................................................................................125 Figure 115: Install the application.......................................................................................................126



C h a p t e r 1 . Introduction

The IBM WebSphere Adapter for Siebel Enterprise Business Applications® supports exchange of data with the Siebel enterprise information system (EIS) through two types of Siebel objects – Siebel business services and Siebel business objects. This guide provides tutorial scenarios that demonstrate how the adapter performs outbound and inbound operations using Siebel business services and business components.

1.1 Learning objectives

After completing a tutorial, you should be able to perform the following tasks:

• Create an adapter project in WebSphere Integration Developer

• Discover services and associated business objects from the EIS and make them part of the adapter project

• Create a deployable module that you install on WebSphere Process Server or WebSphere Enterprise Service Bus

• Test the module and validate the results

1.2 Audience

These tutorials are for integration developers who design, assemble, test, and deploy business integration solutions.

1.3 Software prerequisites

To use these tutorials, you must have the following applications installed:

WebSphere Integration Developer, version 7.0

WebSphere Process Server or WebSphere Enterprise Service Bus, version 7.0

Siebel 7.8, 8.0 or 8.1 driver

1.4 Scenarios in brief:

There are six scenarios:

i) Outbound using Siebel business service

ii) Inbound using Integration object

iii) Outbound using Siebel business object

iv) Inbound using Siebel business object

v) Outbound using Siebel business object with specified integration object

vi) Inbound using Siebel business object with specific attribute selected

The table in each scenario provides the details of the Siebel’s integration or business object and the operations to be performed on it.

1.4.1 Outbound process using Siebel business service

Business Service Siebel Contact

Integration Object Contact Interface

Event Methods QueryByExample (Tutorial 1)

There are two operations in this scenario, in order:

• Insert

The ‘Insert’ operation adds a hierarchy of ‘Contact Interface’ instances to the Siebel EIS using the ‘Siebel Contact’ business service. • QueryByExample

The ‘QueryByExample’ operation will retrieve the created ‘Contact Interface’ instance from the Siebel EIS.

1.4.2 Outbound process using Siebel business object

Business Object Account – ESP

Event Method Create

Exists (Tutorial 2)


• Create

The ‘Create’ operation adds a hierarchy of the business object ‘Account - ESP' instances to the Siebel EIS.

• Exists

The ‘Exists’ operation confirms that a particular ‘Account - ESP’ instance exists in the Siebel EIS.

1.4.3 Inbound process using Siebel integration object

Integration Object Contact Interface


Event Method QueryByExample (Tutorial 3)

This scenario updates a hierarchy of ‘Contact Interface’ (not through adapter) instances in the EIS. For the corresponding update, an event gets added automatically (through Siebel script) to the event component. The adapter will poll the event from the event component & retrieve the updated instance hierarchy based on the information available in the event.

1.4.4 Inbound using Siebel business object

Business Object Account

Event Method Create, update, delete (Tutorial 4)

This scenario retrieves a hierarchy of updated instances of ‘Account’. For the corresponding update, an event is added automatically (through Siebel script triggers) to the event component. The adapter polls the event from the event component & retrieves the updated instance based on the information available in the event.

1.4.5 Outbound using Siebel business service with specified integration object

Business Object EAI Siebel Adapter

Event Method Insert

Query (Tutorial 5)


• Insert

The ‘Insert’ operation adds a hierarchy of the business object ‘Oppty Contact (PRM ANI)' instances to the Siebel EIS.

• Query

The ‘Query’ operation confirms that a particular ‘Oppty Contact’ instance exists in the Siebel EIS.

1.4.6 Inbound using Siebel business object with specific attribute selected

Business Object Account

Event Method Create, update, delete (Tutorial 6)

This scenario retrieves a hierarchy of updated instances of ‘Account’. For the corresponding update, an event is added automatically (through Siebel script triggers) to the event component. The adapter polls the event from the event component & retrieves the updated instance based on the information available in the event.


C h a p t e r 2 . Preparing to run through the tutorials

2.1 Extracting the sample files

Replicas of the artifacts that you create when using the external service wizard are provided as sample files for your reference. Use these files to verify that the files you create with the external service wizard are correct. The artifacts generated as part of the tutorials are located in the ‘referencefiles’ folder within the samples folder. These artifacts can be used for comparison purposes whenever you run the tutorials and generate your own artifacts. The names of the replica files for the six tutorials are, Tutorial1.zip, Tutorial2.zip, Tutorial3.zip, Tutorial4.zip, Tutorial5.zip, and Tutorial6.zip. All these tutorial files are located at ‘/samples/referencefiles’. These files can be extracted into the WebSphere Integration Developer and the artifacts can be used for reference purposes. The zip files and Siebel scripts accompany each sample scenarios of the tutorial.

2.2 Create an event table in Siebel

To do the following steps you need to be familiar with Siebel tools functionality. For detail information on any of the steps, refer to Siebel tools documentation. This procedure uses the Siebel Sales Enterprise application as an example. For convenience, whenever we say Siebel application, it means Siebel Sales Enterprise application in the following chapter. IBM events are used as Event table name in this example. This name can be changed based on the end user needs. To create ‘Event table’ and ‘Object’ in Siebel Business Applications, perform the following procedure in Siebel tools:

1. Create IBM project, and lock your project. You need to complete all Siebel customizations under this new project (except for event triggers).

2. If you are installing multiple adapters, you need to create multiple tables and associated objects with different names.

3. To use a New Object Wizard, create a stand-alone table CX_IBM_EVENT.

4. Create the columns in your new table:


Column Name/

User Name

Type Length Physical Type Required Nullable Status

DESCRIPTION Data (public) 255 Varchar Active

EVENT_ID Data (public) 30 Varchar Active

CONNECTOR_ID Data (public) 255 Varchar Active

EVENT_TYPE Data (public) 20 Varchar Active

OBJECT_KEY Data (public) 255 Varchar Active

OBJECT_NAME Data (public) 255 Varchar Active

PRIORITY Data (public) 10 Number Active

STATUS Data (public) 20 Number Active

XID Data (public) 255 Varchar Active

5. Create a new Business Component (BC) IBM Events based on your new table. All

fields are single value fields.

6. In addition to the BC, create a new field, Event Time Stamp, and map it to CREATED column from CX_IBM_EVENT. The ‘Type’ of this field should be DTYPE_UTCDATETIME.

7. Create a new Business Object (BO) IBM Events.

8. Associate IBM Events BC to IBM Events BO.

9. Create IBM Event List Applet based on IBM Events BC.

10. Create IBM Event List View based on IBM Events BO.

11. Create IBM Events Screen and associate it to the IBM Event List View in the Screen View.

12. Create a page tab as follows:

a. Access the Application > Siebel Sales Enterprise > Page tab

b. Right-click and select New Record from the menu

c. Enter IBM Events as the screen name and IBM Events for the Text-String Override

d. Leave the inactive field unchecked

13. Create a screen menu item as follows:

a. Access the Application > Siebel Sales Enterprise > Screen Menu Item

b. Right-click and select new record


c. Enter IBM Events as the screen name and IBM Events for the Text–String Override.

d. Leave the inactive field unchecked.

14. Create a new Business Object Schema Version for IBM project and associate it to Schema Version BC.

15. Apply the physical schema for the new tables in your local database. You can do this by querying on the new table, CX_IBM_EVENT. Select the current query to create a physical schema. Make sure that you leave the table space and index space blank.

16. Activate the new schema using Activate.

17. Add or modify the Siebel VB or e-scripts for the BC that corresponds to the business objects used at your site. Siebel scripts triggers event notification for BO (Samples are in the Sample folder). If you are planning to use multiple connectors, make sure the correct name is specified in the Siebel script. In Siebel script, you need to ensure that the event will not get created for the adapter user name to prohibit the ping-pong effect.

18. Compile the updated and locked projects in your local database to create a new Siebel repository (.srf) file.

19. Open Siebel Sales Enterprise in your local database. You need to have administrative privileges to perform the following:

a. Create a new view called IBM Event List View

b. Create a new responsibility called IBM Responsibility for IBM Event List View.

c. Add the employees or teams who are responsible for receiving events to the newly created IBM Responsibility.

d. Create the IBMCONN (or your adapter user name) user and add it to IBM Responsibility and Administrative Responsibility.

20. Test the application in your local environment. Ensure that you have the visibility to IBM Event List View and that an event is generated in the view after you create a record in supported object. For example, create a new account in Siebel and check if a new account event appears in the IBM Event List View.

21. Check in the new and updated projects into your development server

22. Activate the new tables in the development database.

23. Compile a new Siebel.srf file and deploy it on the server.

Note: Enable Enterprise Application Integration by selecting:

Site map > Server Administration > Component Group and Enable

To set Siebel JAVA Bean:

1. Select Site Map >Server Admin > Components (Sales Object Manager).

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

2.3 Create an authentication alias

Using an authentication alias eliminates the need to store the password in clear text in an adapter configuration property, where it might be visible to others. (The authentication alias needs to be set because the adapter uses the username and password to connect to the database.) Follow


these steps to set the authentication alias in WebSphere Process Server administrative console. This authentication alias is used later while generating the artifacts for the module.

1. In WebSphere Integration Developer, switch to the Servers View by selecting Window > Show View > Servers.

Figure 1: Choose Servers’ View

2. To set the authentication alias, start the server. In the Servers tab in the lower-right pane of the WebSphere Integration Developer window, right-click the server, and then select Start. If a new server entry needs to be added, right-click on the blank space in the Servers view and choose New.

3. When the server is started, right-click the server, and then select Run administrative console.

4. Log in to the administrative console by clicking Log in. The User ID is optional and is meant for recalling the session configuration settings.

5. In the administrative console, select Security → Global security → Authentication → Java Authentication and Authorization Service → J2C Authentication data.


Figure 2: Java Authentication and Authorization Service (JAAS)

• In the list of J2C authentication aliases that is displayed, click New.

• In the Configuration tab, type the name of the authentication alias in the Alias field.

• Specify the user ID and password that are required to establish a connection to the database.

• Optionally type a description for the alias.

• Click OK. The newly created alias is displayed. Note the full name of the alias, which includes the node name. This full name is used in subsequent configuration window.

• Click Save.


Figure 3: Create a New Authentication Alias with User ID, Password and Description

6. A message is displayed to confirm and save changes to the master configuration. Click Save.


Figure 4: Select Authentication Entries

Note: You have created an authentication alias that is used to configure the adapter properties. Restart the server for the changes to take effect.


2.4 Creating the adapter project in WebSphere Integration Developer

To import the RAR file into the project, follow these steps:

1. Open WebSphere Integration Developer.

2. Select File -> Import.

Figure 5: Import adapter with WID


3. In the Import window, select ‘RAR file’ option and click Next.

Figure 6: Import adapter RAR File

4. In the Connector Import window, do the following:

In the Connector file field, click Browse to locate the folder that contains the adapter file, i.e. CWYEB_SiebelAdapter.rar.

Leave the default values as is for the other fields. The connector module is self-named according to the adapter. WebSphere Process Server v7.0 is the expected target runtime.

Click Finish.


Figure 7: Connector Import window prompt

5. Click No to the question asked next as there is no need to change the J2EE perspective.

Figure 8: Confirm perspective switch

6. Select Window->Open Perspective->Other->Java. Confirm that the adapter is installed in WebSphere Integration Developer.


Figure 9: Project Explorer's view in Business Integration perspective

This completes import of RAR file to adapter.

2.5 Start the external service wizard

1. In WebSphere Integration Developer, select the Business Integration perspective by selecting Window->open perspective->other->Business Integration (Default).


2. Select File-> New-> Other -> Business Integration-> External Service.

Figure 10: New External Service


3. In the Select the Servic Type or Registry window, select Adapters-> Siebel, and click Next. This selection creates a service to connect to an external system.

Figure 11: Select the Services Type or Registry


4. Select IBM WebSphere Adapter for Siebel Business Applications (IBM 7.0.0.0) -> CWYEB_SiebelAdapter, from the Select an Adapter window and click Next.

Figure 12: Select the imported adapter


5. In the Locate the Required Files and Libraries window, click Browse to locate Siebel library JAR files to satisfy the connection dependencies. The version of JAR files should match the version on the server.

Figure 13: Locate Siebel dependency jar files

The steps performed until now with the wizard are common for all scenarios. The sub-sequent steps vary based on the type of processing that is accomplished for the scenarios.



C h a p t e r 3 . Tutorial for outbound processing using Siebel business service

Scenario The following sections describe how to set up the outbound processing through Siebel business service contact, Siebel Contact. This operates on the integration object Contact Interface.

This scenario has the following four steps:

1) Send the request to Siebel Enterprise server for invoking insert method of Contact Interface to create a record

2) After creating the record, the adapter gets the response from Siebel Enterprise server and converts it to a Business Object

3) Send the request to Siebel Enterprise server for invoking QueryByExample method of Contact Interface to query record created

4) The adapter gets the response Business Object again and the response shows the record exists or not.

The artifacts generated by this process are contained in tutorial1.zip.

Tutorial File Contents

Tutorial Folders Descriptions

SiebelBSContactOut Generated artifacts, such as XML Schema (xsdWeb Services Definition Language (WDL).

SiebelBSContactOutApp EAR application artifacts, such as deployment descriptors.

tutorial1.zip

SiebelBSContactOutWeb Web module artifacts.


To set connection properties for the external service wizard, follow the steps in Start the external service wizard part in section 2.

1. Continuing with the wizard, in the Processing Direction window, select Outbound.

Figure 14: Processing Direction


3.2 Setting connection properties for the external service wizard

To set connection properties for the external service wizard, follow the steps:

1. Selecting ‘Outbound’ processing type, displays Discovery Configuration window. Change or retain the connection properties displayed as shown in the following figure. In Type of Siebel objects to discover field, select Siebel Business Services.

2. Add a prefix for business object names as needed.

Figure 15: Discovery Configuration


3. Click Advanced. the Bidi Properties section of the window is displayed.

Figure 16: Discovery Configuration - Bidi Properties and Log Properties

4. Select Bidi transformation.

5. Select Implicit or Visual as Bidi ordering schema.

6. In Text direction list, select LTR (Left to Right) or RTL (Right to left) or contextually in one of the directions.

7. Select Change logging properties for wizard to select the location for the log file output and logging level.

8. Click Browse to change the output location of the log file.

9. Click Next.

3.3 Selecting the Siebel business services

1. In the Object Discovery and Selection window, click Edit Query.

2. In the Query Properties window, enter the name of the business service. For example, Siebel Contact for Siebel business service.

3. Click OK.


Figure 17: Query Properties

4. In the Object Discovery and Selection window, click Run Query.

5. Expand Siebel Contact to display the methods supported against the business service.

6. Select Insert and QueryByExample in Siebel Contact.


Figure 18: Selected Objects

7. Click Next.

3.4 Generating business object definitions and related artifacts

Follow the steps to generate business object definitions:

1. In the Configure Composite Properties window, specify the folder to store generated business objects. Leave the other properties, Business object namespace, and Generate a business graph for each business object with their default values.

2. Select Generate business objects with shorter names.


Figure 19: Configure Composite Properties

3. Click Next.

3.5 Service generation and deployment configuration

Follow the steps to configure deployment type on the server:

1. In the Service generation and deployment configuration window, select Using security properties from the managed connection.

2. Specify the password to recall other properties and click Next. Refer to the following window.


Figure 20: Service Generation and Deployment Configuration

3. In the Service Location Properties window, click New next to Module filed or choose a preexisting module. Specify the name of the module.


4. Click Browse to locate the folder where you want to store the generated WebSphere business objects. Otherwise, leave it empty and the objects are stored to the projects top-level folder by default.

Figure 21: Service Location Properties window

5. Click Finish.

6. Click Yes to save the file changes.

3.6 Configuring the adapter properties

The properties are configured earlier when the business objects and artifacts were generated. If any configuration changes are required, you can make them by using the Assembly Editor.

Delete the space

1. In the Business Integration perspective, open the Assembly Diagram under the project and select the SiebelOutboundInterface.

2. Right-click and select Properties View to display the Properties view and click the Binding tab.


3. You can configure the activation specification properties by clicking the Connection and ResourceAdapter tab.

Figure 22: Assembly diagram

4. Click Save to save the project with the changes. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelOutboundInterface.

3.7 Deploying the adapter project to the test environment

The result of running the external service wizard is a SCA module that contains an EIS import. Install this SCA module in WebSphere Integration Developer integration test client.


1. Add the SCA module you created to the server using the Servers View in WebSphere Integration Developer. Right-click the server, and select Add and remove projects.

2. Select the project in the Available Projects view. Click Add. The project gets added to the Configured Projects on the right panel.

3. Click Finish. The SCA module is installed and started on the server.

Note: If you have any problems installing the application using the previously described approach, you can export the project as an EAR file and then install and start it through the WebSphere Process Server administrative console. For more information, check out the troubleshooting sections 9.1, 9.2, and 9.3.


3.8 Testing the adapter application

You test the adapter application through the WebSphere Integration Developer integration test client. The following sections provide information on how to execute the two operations, Insert and QueryByExample, against the business service Siebel Contact.

3.8.1 Running the Insert operation This section describes how to use test client to insert a record in Siebel EIS that is built in previous section. Follow these steps to insert a record in Siebel EIS:

1. In the Business Integration profile, select the module, right-click and select Test > Test Module.

Figure 23: Open Test Module


2. In the Events window, select insertSiebelContact for the Operation property in Detailed Properties tab.

Figure 24: Type of Operation on Component

3. Right-click the SiebelMessage attribute, and select Add Elements.

Figure 25: Add Property Object Element

4. Set the values as required against the attributes of the SiebelMessage element.

Note: Under the SiebelMessage instance, Id, FirstName, and LastName are mandatory attributes.


Also the container attributes, RelatedOrganization and RelatedSalesRep are mandatory. For the remaining attributes, it is not required to set the values and if there is a specific need in your environment to set any of the other attributes, you may set values for it. The following values provided are sample ones that may or may not be valid in your environment. Get the valid values for the attributes by checking existing EIS records for the Contact integration object.

Attribute Name Attribute Value Id 001 FirstName TestFirstName LastName TestLastName

Create Instances for the two container attributes, RelatedOrganization and Related-SalesRep.

RelatedOrganization:

Attribute Name Attribute Value Organization Default Organization

RelatedSalesRep:

Attribute Name Attribute Value Login <USERNAME> Position Siebel Administrator

Where <USERNAME> is the name you use to login to Siebel. For example, sadmin

5. Select the value ‘null’ for the container attributes (mandatory) under the SiebelMessage instance with the exception of RelatedOrganization and RelatedSalesRep.

6. Right-click the selected attributes list and select Set To>Unset. Note that the following windoes does not show all the non-required attributes. (Do this for the simple non-required attributes within the instances of the container attributes, RelatedOrganization and RelatedSalesRep).

7. Click Continue in the Events tab.

8. Select the appropriate WebSphere Process Server instance and click Finish to run the operation.


Figure 26: Select Deployment Location

If the process is successful, the resultant business objects with the key values are returned. Note down the Id key value as it can be used later in the QueryByExample operation. It is also needed for clearing the sample content created.

Figure 27: Business Object Attributes

The execution of the Insert operation is successfully completed.


3.8.2 Running the QueryByExample operation This section describes how to use QueryByExample to retrieve the record that is created. Follow these steps:

1. In Business Integration profile, select the module, right-click and select Test > Test Module.

2. In the Events window, select querybyexampleSiebelContact as the Operation property in the Detailed Properties tab.

Figure 28: Operation Type

3. Right-click the SiebelMessage, and click Add Elements.

Figure 29: Add Element to Business Object

4. Get the Id key value from any existing Contact record in the Siebel EIS and set the same against the Id attribute of the SiebelMessage element added.

Note: Do not use the following values as given. The Id that was generated earlier against the Insert operation is given in the following figure. You can use the following values if


you have completed the ‘Insert’ operation prior to running this operation. If you have not completed the ‘Insert’ operation, get the Id from any existing record in Siebel application.

Figure 30: ID of Existing Record

5. Select the simple attributes other than Id using Shift key and right-click on the attributes list. Select Set To->Unset.


7. Select the appropriate WebSphere Process Server instance and click Finish to execute the operation.



When the execution is successful, the resultant business object hierarchies with the attribute values are returned as shown in the window.

Figure 32: Invoke

The execution of the QueryByExample operation is successfully completed.



C h a p t e r 4 . Tutorial for outbound processing using Siebel business object

Scenario The following sections describe how to use an application SCA component to raise create an ‘exists’ request to Siebel business object account, Account - ESP.


1) Send the request to Siebel Enterprise server for creating an Account-ESP record


3) Send exist request to Siebel Enterprise server for checking the record created

4) The adapter gets the response Business Object again and the response shows the record exists or not.

The artifacts generated by above process are contained in tutorial2.zip



SiebelBOAcctOut Generated artifacts, such as XML Schema Definitions (xsd), Web Services Definition Language (WDL), Service Component Architecture (SCA) module file and etc.

SiebelBOAcctOutApp EAR application artifacts, such as deployment descriptors.

tutorial2.zip

SiebelBOAcctOutWeb Web module artifacts.


You can set the connection properties for external service wizard using the following steps.

1. Selecting Outbound processing type displays Discovery Configuration window. Change or retain the connection properties displayed as shown in the following window. In Type of Siebel objects to discover field, select Siebel Business Objects.


4.3 Selecting the Siebel business objects


2. In the Query Properties window, provide the name (or the starting characters in the name) of the business object, Account – ESP.

3. Click OK.


Figure 35: Object Discovery and Selection

4. Click Run Query. The business object gets listed.

5. Expand Account - ESP tree node to list the business components.

6. Select the business component Account and click Add.

7. Click Next.


Follow these steps to generate business object definitions:

1. In the Configure Composite Properties window:

Specify the value as ‘out’ in the Folder field, for example. This is where the generated WebSphere business objects are stored. Do not change the Namespace value and do not edit the Operations list.



2. Click Next.


1. In the Service Generation and Deployment Configuration window, select Using security properties from the managed connection.

2. Specify the password to recall other properties and click Next. Refer to the following window.



3. In the Service Location Properties window, create a new module by clicking New next to the Module field.

4. In the Integration Project window, select Create a module project and click Next.

5. Type a module name in the New Module field and click Finish.


6. In the Folder field, type intf. The corresponding folder is created under the module. The generated .import and .wsdl files are stored in this folder.

Figure 38: Service Location Properties

7. Click Finish.




1. In the Business Integration perspective, open the Assembly Diagram under the project and select the SiebelOutboundInterface.

2. Right-click and select Properties View, and click the Binding tab.


Figure 39: Assembly Diagram and Properties View

4. Click Save to save the project with the changes. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelOutboundInterface.



The result of running the external service wizard is a SCA module that contains an EIS import. Install this SCA module in the WebSphere Integration Developer integration test client.

1. Add the SCA module you created earlier to the server using the Servers View in WebSphere Integration Developer. Right-click the server, and select Add and remove projects.


3. Click Finish. The SCA module is installed and starts on the server.

Note: If you have any problems installing the application using the previously described approach, you can export the project as an EAR file and then install and start it through the WebSphere Process Server administrative console. For more information, check out the troubleshooting sections 9.1, 9.2, and 9.3.


The adapter application is tested using WebSphere Integration Developer integration test client. The following sections will provide information on how to execute the two operations, Create and Exists, against the business object, Account - ESP.

4.8.1 Running the Create operation This section describes how to use test client to perform a test on ‘create’ operation. You can create one new record and verify it in next sub-section.


2. In the Events window, select the operation createBOAccountU45ESPBCAccount in the Operation field.

Figure 40: Operation Type


3. Set the verb to Create by selecting it from the Value list.

Figure 41: Create a business object

4. Provide the sample values for the following business object attributes. Note: You do not need to set the attributes with the same values as given in the following table. Instead, you can provide your own valid values.

Attribute Name Possible sample value Currency Code USD InternalOrgFlag N Name TestBOSample PartyTypeCode A PartyUID W

5. Select the value null for the container attributes under BOAccountU45ESPBCAccount

(mandatory).

6. Select the simple attributes that do not need to be set using Shift or Ctrl keys and right-click on the selected attributes list. Select Set To->Unset.





When the process is successful, the resultant business objects with the key values are re-turned. Note down the Id key value as it can be used later in the Exists operation. It is also needed for clearing the sample content created.

Figure 43: Return Output

The execution of the Create operation is successfully completed.


4.8.2 Running the Exists operation This section illustrates how to use test client to perform a test on ‘exist’ operation and to verify the record you created.


2. In the Events window, select the operation existsBOAccountU45ESPBCAccount in the Operation field.

Figure 44: Setting Component, Interface or Operation

3. Set an existing Account ID key value in the EIS to the ID attribute in the business object.

Note: Do not use the following values as given. The AccountId that was generated earlier against the Insert operation is displayed in the following window. You can do the same, if you had done the Insert operation prior to running this operation, or get the AccountId from any existing record in the EIS.

Figure 45: Business Object Reference ID




When the process is successful, the resultant business object of type SiebelExistsResult is returned. This business object has a single Boolean type variable. The value, true will be returned if the object is present in the Siebel EIS and false if the object is not existing in Siebel EIS.

Figure 46: Successful Status Returned

The process of the Exists operation is successfully completed.



C h a p t e r 5 . Tutorial for inbound processing using Siebel business service

Scenario This scenario describes how to set up the inbound processing through Siebel integration object Contact Interface. This integration object comes under the Siebel business service Siebel Contact.

Note: You should finish Section 2.2 before this Chapter.

This scenario has the following three steps:

1) User adds a new Account record through Siebel Application, and this action will activate the trigger to add a new event in the event table

2) Siebel adapter will poll the event from Siebel server periodically. If a new event is found, it will be captured and fetched from the server

3) Adapter converts the event into a Business Object and delivers it to the destination SCA component.




SiebelBSContactIn Generated artifacts, such as XML Schema Definitions (xsd), Web Services Definition Language (WDL), Service Component Architecture (SCA) module file and etc.

SiebelBSContactInApp EAR application artifacts, such as deployment descriptors.

tutorial3.zip

SiebelBSContactInWeb Web module artifacts.



1. Continuing with the wizard, in the Processing Direction window, select Inbound.




To set connection properties for the external service wizard using the following steps.:

1. In the Discovery Configuration window, besides setting the connection properties retain the other fields as shown in the following window.


Figure 48: Discovery Configuration - Siebel Business Service


3. Click Advanced. The Bidi Properties section of the window is displayed.







9. Click Next.




2. In the Query Properties window, specify the name of the business service as Siebel Contact.

3. Click OK.


4. Click Run Query to display the business service.

5. Expand Siebel Contact. It will list all the methods supported against the business ser-vice.

6. Select QueryByExample and click Add. It displays Configuration Properties window.


7. Set the Event Method property to QueryByExample and click OK.

Figure 51: Configuration Properties For 'QueryByExample'

8. Click Next.


Follow these steps to generate business object definitions:

1. In the Configure Composite Properties window, specify the business object namespace and folders name if it is different than the default, to store the artifacts. As an option, generate a business graph for each business object as part of the artifacts.


2. Click Next.



You can configure runtime parameters and deployment options using the following steps.

1. In the Service generation and deployment configuration window, select Using security properties from the managed connection. Specify the password to recall the existing connection properties and click Next. Refer to the following window.



2. In the Service Location Properties window, create a new module by clicking New next to the Module field.

3. In the New Business Integration Project window, select Module option and click Next.

4. Type a module name in the New Module field and click Finish.


5. Specify intf as a value in the Folder field. The corresponding folder is created under the module. This is the folder where the generated .export and .wsdl files are stored.


6. Click Finish to end the external service wizard process.



1. In the Business Integration perspective, open the assembly diagram under the project and select the SiebelInboundInterface project.

2. Open the Properties view and click the Binding tab.


3. Configure the activation specification properties by clicking the Connection and ResourceAdapter tab.

Figure 55: Assembly Diagram and Properties View

4. Save the project.

Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelInboundInterface project.


5.7 Wiring the inbound interface

This section describes how to build a runnable application with interface generated earlier.

1. In the Business Integration perspective, open the assembly diagram under the project and select the SiebelInboundInterface project.

2. Select Untyped Component and click on the assembly diagram window.

3. The new element Component1 is added.

Figure 56: Untyped Component Added

4. Link the new element Component1 with the SiebelInboundInterface project.

Figure 57: Component Wired to Interface


5. In the Add Wire window, click OK.

Figure 58: Add Wire Window Prompt

6. Right-click the new element Component1 and select Generate Implementation -> Java. The class file, Component1Impl.java gets generated.

Figure 59: Generate Implementation


7. In the Generate Implementation window, ensure default package is selected and click OK.

Figure 60: Default Package Selected

8. Add the System.out.println statement in the emit methods of the class file Compo-nent1Impl.java, in order to trace the flow of process.

Figure 61: Add Trace Statements

9. Save the class file and then the project. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelInboundInterface project.





2. In the Available Projects, select the project. Click Add. The project gets added to the Configured Projects panel on the right hand side.

3. Click Finish.

4. The SCA module gets added successfully to the server.

Note: If you have any problems installing the application using the previously described approach, you can export the project as an EAR file and then install and start it through the WebSphere Process Server administrative console. For more information, check out the troubleshooting sections.

5.9 Testing the assembled adapter application

This section describes how to test and verify the inbound application.

1. Create a new record in the event component in the Siebel application using the information shown in the following table.

Note: If you provided a prefix in the connection properties, you have to use the same prefix for the Object Name field. The Object Key value provided is a sample one. You need to set an appropriate name by selecting the existing Account record in the EIS.

2. In the Administrative Console window, select Applications -> Enterprise Applica-tions.

3. Confirm that the application has started successfully – a message is displayed at the top

of the window and also the status against the application will change from to . If the application is not started, then start it.

4. Select the Console tab at the bottom of the window to check the WebSphere Process Server log information.

5. Assuming the event was successfully polled and delivered by the adapter, you can see the trace statement added earlier in the class on the console window.


Figure 62: Trace Statement Captured

This concludes the successful polling and delivery of an event by the adapter using the business service Siebel Account and its integration object Account Interface. You can also confirm by checking the event component using the Siebel client that the corresponding event record is deleted.


C h a p t e r 6 . Tutorial for inbound processing using Siebel business object

Scenario The following section describes how to set up inbound processing through the Siebel business object.






The artifacts generated through this scenario are contained in tutorial4.zip.



SiebelBOAcctIn Generated artifacts, such as XML Schema Definitions (xsd), Web Services Definition Language (WDL), Service Component Architecture (SCA) module file and etc.

SiebelBOAcctInApp EAR application artifacts, such as deployment descriptors.

tutorial4.zip

SiebelBOAcctInWeb Web module artifacts.




1. Continuing with the wizard, in the Processing Direction window select Inbound.


6.2 Setting connection properties for the external service

Follow the section Start the external service wizard in Chapter 3.




2. In the Query Properties window, provide the name (or the starting characters in the name) of the business object, Account and click OK.

Figure 64: Object Discovery and Selection

3. Click Run Query.

4. The business object is listed. Expand the Account to get the list of business components under the Account business object.


5. Select the business component Account and click Add.

Figure 65: Discovered and Selected Objects

6. Click Next.



To configure the composite properties that apply to all selected objects, you have to provide a business object namespace and a folder for storing the generated business objects.

1. Specify the value as ‘out’ in the Folder field, for example. This is where the generated WebSphere business objects are stored. Do not change the Namespace value and do not edit the Operations list.


2. Click Next.



1. In the Service Generation and Deployment Configuration window, select Using security properties from the managed connection. Specify the password to recall other properties and click Next. Refer to the following window.



2. In the Service Location Properties window, click New next to the Module field.

3. In the Integration Project window, select the option, Module and click Next.

4. Specify the value intf in the Folder field. The corresponding folder is created under the module. This is the folder where the generated .import and .wsdl files are stored.


5. Select a module name in the Module field and click Finish to end the external service wizard process.


Note: If you decide to connect directly, click Advanced to configure the properties as shown in the following window.

Figure 69: Connection Properties



1. In the Business Integration perspective, open the assembly diagram under the project and select the SiebelInboundInterface export.

2. Open the Properties view and click Binding tab under it. You can configure the activation specification properties by clicking the Connection and ResourceAdapter tab

3. Click Save.




1. In Business Integration perspective, open the assembly diagram within the project and select the SiebelInboundInterface export.

2. Select Untyped Component and click on the assembly diagram window.

3. The new element Component1 is added.

Figure 70: Untyped Component Added

4. Link the new element Component1 with the SiebelInboundInterface export as shown in the following window.


5. In the Add Wire window, click OK.



6. Right-click the new element Component1. Select Generate Implementation -> Java.

The class file, Component1Impl.java gets generated.

Figure 73: Generate Implementation, Java


7. In the Generate Implementation window, ensure default package is selected and click OK.


8. Add the System.out.println statement in the emit methods of the class file, Compo-nent1Impl.java, in order to trace the flow of process as shown in the following windows.


9. Save the class file and then the project.






2. In the Available Projects, select the project and click Add. The project gets added to the Configured Projects panel on the right hand side.

3. Click Finish.

4. The SCA module gets added successfully to the server.



1. Create a new record in the event component in the Siebel application. The event record information is shown in the following table:

Note: If you have provided a prefix in the connection properties, use the same prefix for the Object Name property. The Object Key is an example value. You need to set an appropriate Id by selecting the existing Account record in the EIS.

2. In the Administrative Console window, select Applications->Enterprise Applications.

3. Confirm that the application is started successfully – a message displays at the top of the window

and also the status against the application will change from to .

4. Select the Console tab in the window at the bottom to check the WebSphere Process Server log information.

5. Assuming the event was successfully polled and delivered by the adapter, you should see the trace statement added earlier in the class, on the console window.



This concludes the successful polling and delivery of an event by the adapter using the business object ‘Account’. You can also confirm by checking the event component using the Siebel client – the corresponding event record is deleted.



C h a p t e r 7 . Tutorial for outbound processing using Siebel business service with specified integration object

Scenario The following section describes how to set the outbound processing through Insert and Query method of Siebel business service EAI Siebel Adapter. For some Siebel business services, you can specify integration object type. Oppty Contact (PRM ANI) is used as an example in this scenario.


1) Send an Insert request to Siebel Enterprise server for creating a new record


3) Send a Query request to Siebel Enterprise server to get the record created

4) Then the adapter gets the response Business Object again.




SiebelMessageOutbound Generated artifacts, such as XML Schema Definitions (xsd), Web Services Definition Language (WDL)

SiebelMessageOutboundApp EAR application artifacts, such as deployment descriptors.

tutorial5.zip

SiebelMessageOutboundWeb Web module artifacts.


To set connection properties for the external service wizard, follow the steps:

1. In Discovery Configuration window change the connection properties displayed if necessary. The type of Siebel objects to be discovered for this scenario is Siebel Business Services.




3. Click Advanced. The Bidi Properties section of the window is displayed.







9. Click Next.




2. In the Query Properties window, provide the name (or the starting characters in the name) of the business service, EAI Siebel Adapter and click OK.


3. Click Run Query.

4. The business service is listed. Expand the EAI Siebel Adapter. It will list all the methods supported against the business service.

Figure 81: Selected Objects


5. Select Insert and Query of EAI Siebel adapter discovered objects and the Configuration Properties panel is displayed.

Figure 82: Configuration Properties

6. Expand Insert.

7. Select Integration Object Oppty Contact (PRM ANI) for SiebelMessage – Input / Output.

Figure 83: Integration Object Selection

8. Expand Query.


9. Select Integration Object Oppty Contact (PRM ANI) for SiebelMessage – Input / Output.

Figure 84: Configuration for Query

10. Click OK.

Figure 85: Object Selection

11. Click Next.




1. Type xsd in Folder for example. This is where the generated WebSphere business

objects are stored. Leave the Business object namespace and Generate a business graph for each business object fields with the default values. Select Generate the business objects with shorter names.


2. Click Next.



1. In Deployment properties, select Using security properties from the managed connection.

2. In Connection properties, enter the password to recall all other properties. Click Next. Refer to the following figure.



3. In the Service Location Properties window, select New next to Module field or choose a preexisting module.

4. Type the Name of the module.

Figure 88: Service Location Properties window

5. Click Browse to select the Folder, where you want to store the generated WebSphere business objects. If you leave the Folder field empty, the objects are stored in the projects top level folder by default.

6. Click Finish.




1. In Business Integration perspective, open the assembly diagram under the project and select the SiebelOutboundInterface import.

2. Right-click and select Properties View, and click the Binding tab.


Figure 89: Assembly diagram

4. Click Save to save the project when done with the changes. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelOutboundInterface project.






3. Click Finish. The SCA module is installed and started on the server.

Note: If you have any problems installing the application using the previously described approach, you can export the project as an EAR file and then install and start it through the WebSphere Process Server administrative console. For more information on how to do the same, refer the troubleshooting sections 9.1, 9.2, and 9.3.



You test the adapter application through the WebSphere Integration Developer integration test client. The following subsections provide information on how to execute the two operations, Insert and Query, against the business service EAI Siebel Adapter.

7.8.1 Running the Insert operation This section describes how to add a hierarchy of the business object ‘Oppty Contact (PRM ANI)' instances through Insert operation.

1. In Business Integration profile, select the module, right-click and select Test > Test Module.

2. In the Events window, select the operation insertEAISiebelAdapter against the Operation field.

3. Right-click the SiebelMessage attributes and click Add Elements.

Figure 90: Add Property Object Element


4. Set the values as required against the attributes of the SiebelMessage element. Unset all values as displayed in the following windows.

Figure 91: Input SiebelMessage



When the process is successful, the resultant business objects with the key values are re-turned. Note down the Id key value as it can be used later in the Exists operation. It is also needed for clearing the sample content created.

.

Figure 93: Returned Object

The execution of the Query operation is successfully completed.

7.8.2 Running the Query operation This section shows how to query the business object ‘Oppty Contact (PRM ANI)' instances created in previous section. 1. In Business Integration profile, select the module, right-click and select Test > Test

Module.


2. In the Events window, select the operation queryEAISiebelAdapterI against the Operation field.

3. Right-click the SiebelMessage attribute and click Add Elements.

4. Set values as displayed in the following window:

Figure 94: Values for Query




When the process is successfully complete, the resultant business object hierarchy with the attribute values filled is returned as displayed in the following window.

Figure 96: Return Values

The process of the Query operation is successfully completed.



C h a p t e r 8 . Tutorial for inbound processing using Siebel business object with specific attribute selected

Scenario The following section describes how to set the inbound processing through Siebel business object Account and only the needed attributes for the business object are selected.









tutorial6.zip SiebelAccountAttributeIn Generated artifacts, such as XML Schema Definitions (xsd), Web Services Definition Language (WDL), Service Component Architecture (SCA) module file and etc.

SiebelAccountAttributeInApp EAR application artifacts, such as deployment descriptors.

SiebelAccountAttributeInWeb Web module artifacts.



Follow the section Start the external service wizard in Chapter 3

1. Continuing with the wizard, in Processing Direction select Inbound.



In Discovery Configuration window change the connection properties displayed if necessary. The type of Siebel objects to be discovered for this scenario is Siebel Business Objects.



Note: Make sure the check box Prompt for additional configuration settings when adding a business object is selected.



2. In the Query Properties window, type the name (or the starting characters in the name) of the business object, for example Account. Click OK.


3. Click Run Query.

4. The business object is listed. Expand ‘Account’ to get the list of business components under the business object, Account.

5. Select the business component, Account and click Add.

6. In the Configuration Properties window, you can select the attributes of the business component and by default all the attributes are selected.

Figure 99: Configuration Properties for Account


7. Select Name and Location for the business object, and click OK.

Figure 100: Select Attributes

Note: If you do not select the required attributes, like primary key of the business object, you will get errors at runtime.


Figure 101: Select Objects

The business component is added to the selected object column.





1. Type out for Folder. This is where the generated WebSphere business objects are stored. Do not change the Namespace value. Do not edit the Operations list.

2. Click Next.



Based on the J2C Authentication alias created earlier on WebSphere, specify it as a J2C Authentication Data Entry on Service generation and deployment configuration window. Alternatively, the connection properties can be used instead, enter the password as all other properties are recalled. In this Sample, we specify user name and password directly in the connection properties. Click Next after specifying the values. Refer to the following windows

1. In the Service Location Properties window, click New in the Module field.

2. In the New Business Integration Project window, select Module to create a module project and click Next.

Figure 103: New Module


3. Specify a value against the Folder property, ‘intf’ for example. The corresponding folder is created under the module. This is the folder where the generated .import and .wsdl files are stored.


4. Select a module name in the Module field and click Finish to end the external service wizard process.




1. In Business Integration perspective, open the assembly diagram under the project and select the SiebelInboundInterface export.

2. Open the Properties view and click Binding tab. Make sure you have set correct properties for inbound.

3. Click Save to save the project when done with the changes. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelInboundInterface project.


1. In Business Integration perspective, open the assembly diagram under the project and select the SiebelInboundInterface export.

2. Select Java, and click on the assembly diagram window. 3. The new element Component1 is added.

Figure 105: Java Component Added


4. Link the new element Component1 with the SiebelInboundInterface export as shown in the following windows.


5. The Add Wire window shows up. Click OK.



6. Double-click Component1 to get a default JAVA implementation and click Yes.

Figure 108: Generate Implementation, Java

7. In the Generate Implementation window, ensure default package is selected. Click OK.



8. Add the System.out.println statement in the emit methods of the class file, Component1Impl.java, in order to trace the flow of process as shown in the following window.


9. Save the class file and then the project. Note: While saving the project, ensure that you select the assembly diagram window that contains the SiebelInboundInterface project.




1. Add the SCA module you created earlier to the server using the Servers View in WebSphere Integration Developer. Right-click the server, and then select Add and remove projects.

2. In the Available Projects, select the project and click Add. The project gets added to the Configured Projects on the right pane.

3. Click Finish.

4. The SCA module is successfully installed and started on the server.



1. Create a new record in the event component in the Siebel application using the event record information as shown in the following table.

Event Component Attribute Attribute Value

Object name BOAccountBCAccountBG

Event Type Create

Status 0

Object Key 1D=1-7EG4

Note: If you have provided a prefix in the connection properties, use the same prefix for the Object Name field. The Object Key is an example value. You need to set an appropriate Id by selecting any existing Account record in the EIS.

2. In the Administrative Console window, select Applications > Enterprise Applications.

3. Confirm that the application is started successfully. A message will be displayed at the top of the

window and also the ‘Status’ against the application will change from to .

4. Select the Console tab in the window at the bottom to check the WebSphere Process Server log information.

5. Assuming the event was successfully polled and delivered by the adapter, you can see the trace statement added earlier in the class on the console window.



This concludes the successful polling and delivery of an event by the adapter using the business object Account. You can also confirm by checking the event component using the Siebel client that the corresponding event record is deleted from the same.


C h a p t e r 9 . Troubleshooting the tutorial

9.1 Deployment failure

The following sections provide information on the alternative approach to deploy the project into WebSphere Process Server, if there are issues with WebSphere Integration Developer deployment.

9.2 Export project into EAR file

To export the project into an EAR file, do the following:

1. Confirm that there are no errors by building the project.

2. Right-click the project and select Export->EAR File.

Figure 111: Export EAR file option

3. In the EAR Export window, select the EAR project for example, SiebelBSAcctOutApp and provide the absolute path including the EAR file name for example,


SiebelBSAcctOutApp.ear against the Destination field. Select all options that have check-boxes and click Finish. The EAR file is saved in the specified destination folder.

Figure 112: Export EAR file

Deploying project through administrative console Deploying the adapter project through the administrative console consists of the following steps:

1. Click Servers view at the bottom right hand side window of the WebSphere Integration Developer.

2. If the project is not already started, right-click on WebSphere Process Server instance and start the server.

3. Confirm that the server is up by checking the status. It should be listed as ‘started’.

4. Right-click the server and select Administration->Run administrative console. The administrative console window is displayed.

5. Click login in the administrative console.

6. Select Applications -> Application Types -> WebSphere enterprise applications


Figure 113: Select Application Type

7. In the Enterprise Applications window, select Install option.

Figure 114: Install an application

8. In the Path to the new application window, choose the system where the EAR file was saved and browse to the corresponding folder on the system. Select the EAR file from the folder where you saved earlier and click open.

9. Click Next.


Figure 115: Install the application

10. In the Install New Application window, click Summary. 11. Click Finish.

12. The project is installed. When installation is finished, you will get a confirming message about the successful installation of the application.

13. Click Save to Master Configuration option in the same window where the message is printed.

Click Save in the Enterprise Applications window.


The application is now installed and saved successfully.

Starting the application through administrative console 1. In the Enterprise Applications window, select the check-box next to the installed

application.

2. Click Start.

3. Confirm that the application is started successfully. A message will be displayed at the

top of the window and also the ‘Status’ against the application will change from to

9.3 Create record failed

In an outbound scenario which requires a business object to be created, the ID is not required as input value because it is automatically generated. Another possible cause would be creating a duplicate record; hence, a DuplicateRecordException is thrown.


C h a p t e r 1 0 . Appendix

10.1 Clearing the tutorial content

This section lists business object and operations that are used in the tutorial. You can find the usage of objects in this tutorial quickly.

10.1.1 Business service ‘Siebel Contact’ – ‘Insert’ operation You should have noted down the ‘Account Id’ generated earlier against the business service ‘Insert’ operation (Section 3.8.1). Using Siebel client, you can delete the corresponding ‘Account’ record.

10.1.2 Business Service ‘Siebel Contact’ – ‘QueryByExample’ operation Not applicable. The ‘QueryByExample’ operation (Section 3.8.2) retrieves an existing record and does not create or update any sample content in the Siebel EIS.

10.1.3 Business Object ‘Account – ESP’ – ‘Create’ operation You should have noted down the Id generated earlier against the business object, ‘Create’ operation (Section 4.8.1). Using Siebel client, you can delete the corresponding ‘Account’ record.

10.1.4 Business Object ‘Account – ESP’ – ‘Exists’ operation Not applicable. The ‘Exists’ operation (Section 4.8.2) checks for the existence of a record and does not create or update any sample content in the Siebel EIS.


Notices

This information was developed for products and services offered in the U.S.A.

IBM may not offer the products, services, or features discussed in this document in other 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. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matter described in this document. The furnishing of this document does not grant you any license to these patents. You can send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation

North Castle Drive

Armonk, NY 10504-1785

U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia Corporation Licensing

2-31 Roppongi 3-chome, Minato-ku

Tokyo 106-0032, Japan

The following paragraph does not apply to the United Kingdom or any other country where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR


PURPOSE. Some states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication.

IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those 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.

IBM may use or distribute any of the information you supply in any way it believes appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation Department

2Z4A/SOM1 294 Route 100

Somers, NY 10589-0100 U.S.A.

Information concerning non-IBM products was obtained from the suppliers of those products, their published announcements or other publicly available sources. IBM has not tested those products and cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of those products.

This information contains examples of data and reports used in daily business operations. To illustrate them as completely as possible, the examples include

The names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, which illustrate programming techniques on various operating platforms. You may copy, modify, and distribute


these sample programs in any form without payment to IBM, for the purposes of developing, using, marketing or distributing application programs conforming to the application programming interface for the operating platform for which the sample programs are written. These examples have not been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these programs.

If you are viewing this information softcopy, the photographs and color illustrations may not appear. Programming interface information

Programming interface information, if provided, is intended to help you create application software using this program.

General-use programming interfaces allow you to write application software that obtains the services of this program's tools.

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. Trademarks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol (® or ™), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A complete and current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml

Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.

Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or both.

Siebel is trademarks or registered trademarks of Oracle Corporation in the United States, other countries, or both.

Java and all Java based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.*

UNIX is a registered trademark of The Open Group in the United States and other countries.


http://www.ibm.com/legal/copytrade.shtml


Other company, product, or service names may be trademarks or service marks of others.

This product includes software developed by the Eclipse Project (http://www.eclipse.org).

ibm websphere adapter for...

Documents