ibm websphere adapter for siebel · 2011. 7. 22. · ibm websphere adapter for siebel business...

IBM WebSphere Adapter for Siebel Business Applications 7.5.0.0 Quick Start Scenarios

13th April, 2011 of 144

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 5, 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 2011. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

13th April, 2011 of 144

Table of Contents

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 test the scenarios ......................................14

2.1 Configuration prerequisites ................................................................................................. 14 2.2.1 Import event table in Siebel Application ............................................................................ 14 2.2.2 Create event table in Siebel Application manually............................................................ 14 2.2 Extracting the sample files .................................................................................................. 18 2.3 Create an authentication alias............................................................................................. 18 2.4 Creating the adapter project in WebSphere Integration Designer ...................................... 23 2.5 Start the external service wizard ......................................................................................... 26

C h a p t e r 3 . Scenario 1: Outbound processing using Siebel business service 31

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

3.8.1 Running the Insert operation............................................................................................. 43

13th April, 2011 of 144

3.8.2 Running the QueryByExample operation.......................................................................... 47

C h a p t e r 4 . Scenario 2: Outbound processing using Siebel business object 52

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

4.8.1 Running the Create operation ........................................................................................... 61 4.8.2 Running the Exists operation ............................................................................................ 64

C h a p t e r 5 . Scenario 3: Inbound processing using Siebel business service 67

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

C h a p t e r 6 . Scenario 4: Inbound processing using Siebel business object 82

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

13th April, 2011 of 144

C h a p t e r 7 . Scenario 5: Outbound processing using Siebel business service with specified integration object ..................................................................96

7.1 Start the external service wizard ......................................................................................... 97 7.2 Setting connection properties for the external service wizard ............................................ 98 7.3 Selecting the Siebel business services............................................................................... 99 7.4 Generating business object definitions and related artifacts ............................................ 103 7.5 Service generation and deployment configuration............................................................ 105 7.6 Configuring the adapter properties.................................................................................... 108 7.7 Deploying the adapter project to the test environment ..................................................... 109 7.8 Testing the adapter application ......................................................................................... 110

7.8.1 Running the Insert operation........................................................................................... 110 7.8.2 Running the Query operation .......................................................................................... 113

C h a p t e r 8 . Scenario 6: Inbound processing using Siebel business object with specific attribute selected...................................................................119

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

C h a p t e r 9 . Troubleshooting ............................................................135

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

Deploying project through administrative console.................................................................... 136 Starting the application through administrative console........................................................... 139 9.3 Create record failed........................................................................................................... 139

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

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

13th April, 2011 of 144

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

Notices..........................................................................................................141

13th April, 2011 of 144

Table of Figures

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

13th April, 2011 of 144

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

13th April, 2011 of 144

Figure 71: Generate Implementation, Java ..........................................................................................92 Figure 72: Default Package Selected...................................................................................................93 Figure 73: Add Trace Statements.........................................................................................................93 Figure 74: Processing Direction ...........................................................................................................97 Figure 75: Discovery Configuration ......................................................................................................98 Figure 76: Query Properties .................................................................................................................99 Figure 77: Selected Objects ...............................................................................................................100 Figure 78: Configuration Properties....................................................................................................101 Figure 79: Integration Object Selection ..............................................................................................101 Figure 80: Configuration for Query.....................................................................................................102 Figure 81: Integration objects for Query method................................................................................102 Figure 82: Object Selection ................................................................................................................103 Figure 83: Configure Composite Properties .......................................................................................104 Figure 84: Service Generation and Deployment Configuration..........................................................106 Figure 85: Service Location Properties window .................................................................................107 Figure 86: Assembly diagram.............................................................................................................108 Figure 87: Add Property Object Element............................................................................................110 Figure 88: Input SiebelMessage.........................................................................................................111 Figure 89: Select Deployment Location .............................................................................................112 Figure 90: Returned Object ................................................................................................................113 Figure 91: The structure of wrapper BO for supporting multiple output .............................................114 Figure 92: Input for query of Contact integration object .....................................................................115 Figure 93: Select Deployment Location .............................................................................................116 Figure 94: Return value of Contact integration object ........................................................................117 Figure 95: Input for query of Account integration object ....................................................................118 Figure 97: Processing Direction .........................................................................................................121 Figure 98: Discovery Configuration ....................................................................................................122 Figure 99: Configuration Properties for Account ................................................................................124 Figure 100: Select Attributes ..............................................................................................................125 Figure 101: Select Objects .................................................................................................................126 Figure 102: Configure Composite Properties ....................................................................................127 Figure 103: New Module dialog..........................................................................................................128 Figure 104: Service Location Properties ............................................................................................129 Figure 105: Java Component Added..................................................................................................130 Figure 106: Component Wired to Interface ........................................................................................131 Figure 107: Generate Implementation, Java ......................................................................................131 Figure 108: Default Package Selected...............................................................................................132

13th April, 2011 of 144

Figure 109: Add Trace Statements.....................................................................................................132 Figure 110: Export EAR file option .....................................................................................................135 Figure 111: Export EAR file ................................................................................................................136 Figure 112: Select Application Type...................................................................................................137 Figure 113: Install an application........................................................................................................137 Figure 114: Install the application.......................................................................................................138

13th April, 2011 of 144

13th April, 2011 of 144

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 Application through two types of interfaces – 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 Designer

• Discover services and associated business objects from the Siebel application 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 Designer, version 7.5

WebSphere Process Server or WebSphere Enterprise Service Bus, version 7.5

Siebel 7.8 - 8.1.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 Application using the ‘Siebel Contact’ business service. • QueryByExample

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

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

• Exists

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

1.4.3 Inbound process using Siebel integration object

Integration Object Contact Interface

13th April, 2011 of 144

Event Method QueryByExample (Tutorial 3)

This scenario updates a hierarchy of ‘Contact Interface’ (not through adapter) instances in the scenario. 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 Application.

• Query

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

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.

13th April, 2011 of 144

C h a p t e r 2 . Preparing to test the scenarios

2.1 Configuration prerequisites

This section is for inbound scenario Tutorial 3, Tutorial 4, and Tutorial 6. If you don’t run these three scenarios, then you can skip this section first. This section explains how to setup a event store in Siebel Application. 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. Section

2.2.1 Import event table in Siebel Application To configure the Siebel application, you must create an event table and a Siebel business object. WebSphere Process Server contains resources that help you to create the event components and triggers. Locates the files at install_dir/ResourceAdapters/Scripts. The samples folder contains two folders: Siebel7.x.x and Siebel8.0. Each version has an Event_pkg folder, which contains a .sif file and a number of .js scripts. You use the .sif file to create the event components; it can add business objects, views, and all other Siebel objects to the Siebel repository. The .js scripts help you to create Siebel triggers. You can refer it to define your own trigger. To use the .sif file in Siebel Tools:

1. Open Siebel tools and click Tools > Import.

2. Import the .sif file.

3. Merge the differences between the .sif file and the Siebel repository.

4. Use the .js scripts to create Siebel triggers. The provided samples show how to create entries in the inbound table when new Account objects are created.

5. Recompile the repository into a Siebel repository file (.srf file).

6. Deploy the new Siebel repository file to the server.

2.2.2 Create event table in Siebel Application manually 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:

13th April, 2011 of 144

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

13th April, 2011 of 144

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 located at install_dir/ResourceAdapters/Scripts). 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:

13th April, 2011 of 144

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

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

13th April, 2011 of 144

2.2 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. These files can be extracted into the WebSphere Integration Designer and the artifacts can be used for reference purposes. The zip files and Siebel scripts accompany each sample scenarios of the tutorial.

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 Designer, switch to the Servers View by selecting Window > Show View > Servers.

13th April, 2011 of 144

Figure 1: Choose Servers’ View2.

3. To set the authentication alias, start the server. In the Servers tab in the lower-right pane of the WebSphere Integration Designer 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.

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

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

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

13th April, 2011 of 144

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.

13th April, 2011 of 144

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

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

13th April, 2011 of 144

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.

13th April, 2011 of 144

2.4 Creating the adapter project in WebSphere Integration Designer

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

1. Open WebSphere Integration Designer.

2. Select File -> Import.

Figure 5: Import adapter with WID

13th April, 2011 of 144

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.

13th April, 2011 of 144

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

13th April, 2011 of 144

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

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 Designer, select the Business Integration perspective by selecting Window->open perspective->other->Business Integration (Default).

13th April, 2011 of 144

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

Figure 10: New External Service

13th April, 2011 of 144

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

13th April, 2011 of 144

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

Figure 12: Select the imported adapter

13th April, 2011 of 144

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.

13th April, 2011 of 144

C h a p t e r 3 . Scenario 1: Outbound processing using Siebel business service

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.

13th April, 2011 of 144


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

13th April, 2011 of 144

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

13th April, 2011 of 144

3. Click Advanced. The Additional properties and Bidi Properties sections appear.

Figure 16: Discovery Configuration - Bidi Properties and Log Properties

o Sometime adapter may not be able to connect to Siebel server due to using a unsupported codepage setting. You can change it in Code page under Additional properties. Adapter will change the code page of JVM temporary during the discovery and recover original setting after that. For more detail about supported code pages, please refer to Siebel Java Data Bean document.

o If you need Bi-directional text transformation feature, then click Bidi transformation, then select the proper settings.

13th April, 2011 of 144

4. Click Next.

Note: For troubleshooting, select Change logging properties for wizard to select the location for the log file output and logging level.

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

13th April, 2011 of 144

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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

13th April, 2011 of 144

5. Click Finish.

6. Click Yes to save the file changes.

13th April, 2011 of 144

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

13th April, 2011 of 144

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 a Siebel application import. Install this SCA module in WebSphere Integration Designer integration test client.

1. Add the SCA module you created to the server using the Servers View in WebSphere Integration Designer. 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 Designer 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 Application that is built in previous section. Follow these steps to insert a record in Siebel Application:

13th April, 2011 of 144

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

Figure 23: Open Test Module

13th April, 2011 of 144

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

13th April, 2011 of 144

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. You need assign a random character for Id field. Otherwise, an error ‘No user key can be used for the Integration Component instance ‘Contact’. (SBL-EAI-04397)

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 for the rest fields. Click

Continue in the Events tab.

7. Select the your 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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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 Application and set the same against the Id attribute of the SiebelMessage element added.

13th April, 2011 of 144

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.

6. Click Continue in the Events tab.

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

13th April, 2011 of 144


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

13th April, 2011 of 144

Figure 32: Invoke

The execution of the QueryByExample operation is successfully completed.

13th April, 2011 of 144

C h a p t e r 4 . Scenario 2: Outbound processing using Siebel business object

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.

13th April, 2011 of 144





13th April, 2011 of 144


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


13th April, 2011 of 144

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.

13th April, 2011 of 144


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.

13th April, 2011 of 144

13th April, 2011 of 144


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

2. Specify the username and password and click Next. Refer to the following window.


13th April, 2011 of 144

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.

13th April, 2011 of 144



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.

13th April, 2011 of 144


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 Designer integration test client.

1. Add the SCA module you created earlier to the server using the Servers View in WebSphere Integration Designer. 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 Designer 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

13th April, 2011 of 144

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.



13th April, 2011 of 144


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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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



13th April, 2011 of 144

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.

13th April, 2011 of 144

C h a p t e r 5 . Scenario 3: Inbound processing using Siebel business service

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.

13th April, 2011 of 144



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


13th April, 2011 of 144


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

13th April, 2011 of 144

3. Click Advanced. The Additional properties and Bidi Properties sections appear.

Figure 49: Discovery Configuration - Bidi Properties and Log Properties

o Sometime adapter may not be able to connect to Siebel server due to using a unsupported codepage setting. You can change it in Code page under Additional properties. Adapter will change the code page of JVM temporary during the discovery and recover original setting after that. For more detail about supported code pages, please refer to Siebel Java Data Bean document.

o If you need Bi-directional text transformation feature, then click Bidi transformation, then select the proper settings.

13th April, 2011 of 144

5. Click Next.

Note: For troubleshooting, select Change logging properties for wizard to select the location for the log file output and logging level.



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

3. Click OK.


13th April, 2011 of 144

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'

13th April, 2011 of 144

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 properties panel, select Using security properties from the activation specification. Specify the password to recall the existing connection properties and click Next. Refer to the following window.

13th April, 2011 of 144


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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

5.7 Wiring the inbound interface

This section describes how to build a 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 Java Component and click on the assembly diagram window.

3. The new element Component1 is added.

Figure 56: Assembly Diagram

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

Figure 57: Component Wired to Interface

13th April, 2011 of 144

5. In the Add Wire window, click OK.

Figure 58: Add Wire Window Prompt

Figure 59: Generate Implementation

13th April, 2011 of 144

6. Right click on Component1, select Generate Implementation in the popup dialog, select the default package and click OK.

Figure 60: Default Package Selected

7. Add the System.out.println statement in the emit methods of the class file Component1Impl.java, in order to trace the flow of process.

Figure 61: Add Trace Statements

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

13th April, 2011 of 144


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


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. Check out more trigger setup in section 2.

Event Component Attribute Name Attribute Value

Object Name IOContactInterfaceICContactContact

Event Type Update

Status 0

Object key Name = SampleTest

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 Contact record in the EIS.

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

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.

13th April, 2011 of 144

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 service Siebel Contact and its integration object Contact Interface. You can also confirm by checking the event component using the Siebel client that the corresponding event record is deleted.

13th April, 2011 of 144

C h a p t e r 6 . Scenario 4: Inbound processing using Siebel business object

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.

13th April, 2011 of 144



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.

13th April, 2011 of 144



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

13th April, 2011 of 144

5. Select the business component Account and click Add.

Figure 64: Discovered and Selected Objects

6. Click Next.

13th April, 2011 of 144


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.

13th April, 2011 of 144


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.

13th April, 2011 of 144


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.

13th April, 2011 of 144


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

13th April, 2011 of 144

Note: If you have a different name of Event store, please click Advanced, and change the value of Siebel business object name for event store property. For more information about event store, please refer to chapter 2. You can also indicate the code page setting for the runtime, please note that this is a global change for the server, so it may affect other applications on the same server. Be cautious to use this option. Please check inform center for more detail for code page property.

Figure 68: 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.

13th April, 2011 of 144



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

2. Select Java Component and add on the assembly diagram window. Then the new element Component1 is added.

Figure 69: Assembly Diagram

3. Link the new element Component1 with the SiebelInboundInterface export as shown below.


13th April, 2011 of 144

4. Right-click the new element Component1. Select Generate Implementation, and default package. Then click OK. The class file, Component1Impl.java gets generated.

Figure 71: Generate Implementation, Java

13th April, 2011 of 144

5. In the Generate Implementation window, ensure


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


7. Save the class file and then the project.


13th April, 2011 of 144




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 similar to the following table:


Object Name BOAccountBCAccountBG

Event Type Create

Status 0

Object Key Id=1-XDF

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

C h a p t e r 7 . Scenario 5: Outbound processing using Siebel business service with specified integration object

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.

13th April, 2011 of 144





13th April, 2011 of 144


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. For more options in Advanced, please refer to Section 3.2.

4. Click Next.

13th April, 2011 of 144



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.

13th April, 2011 of 144

Figure 77: Selected Objects

5. Select Insert and Query of EAI Siebel adapter discovered objects and the

Configuration Properties panel is displayed.

13th April, 2011 of 144

Figure 78: Configuration Properties

6. Expand Insert.

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

Figure 79: Integration Object Selection

8. Expand Query.

9. Check Use wrapper for multiple integration objects, then we can use the multiple integration objects for query method. This is a new feature in version 7.5. Adapter will generate a wrapper after metadata discovery.

13th April, 2011 of 144

Figure 80: Configuration for Query

10. Click Add to add integration objects Oppty Contact (PRM ANI), and Account (PRM ANI) to the Integration Objects list like below.

Figure 81: Integration objects for Query method.

11. Click OK.

13th April, 2011 of 144

Figure 82: Object Selection

12. Click Next.



13th April, 2011 of 144

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.

13th April, 2011 of 144


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.

13th April, 2011 of 144


13th April, 2011 of 144

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 85: 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.

13th April, 2011 of 144



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 86: 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.

13th April, 2011 of 144





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.

13th April, 2011 of 144


This section illustrates how to test business services with the test component of WebSphere Integration Designer. 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 hierarchical child 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 87: Add Property Object Element

13th April, 2011 of 144

4. Set the required values like Id, FirstName and LastName values as required of the SiebelMessage below. Unset all values as shown in below.

Note: You need assign a random character for Id field. Otherwise, an error ‘No user key can be used for the Integration Component instance ‘Contact’. (SBL-EAI-04397)

Figure 88: Input SiebelMessage


13th April, 2011 of 144



13th April, 2011 of 144

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 Query operation. It is also needed for clearing the sample content created.

.

Figure 90: Returned Object

The execution of the Insert operation is successfully completed.

7.8.2 Running the Query operation This section shows how to query the integration object ‘Oppty Contact (PRM ANI)' and ‘Account (PRM ANI)’ instances. It also shows how to use the multiple integration objects feature in version 7.5 for business service. 1. In Business Integration profile, select the module, right-click and select Test > Test

Module.

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

3. Right-click the SiebelMessage attribute and click Add Elements. Then you will see that there is two integration objects Contact and Account under the wrapper.

13th April, 2011 of 144

Figure 91: The structure of wrapper BO for supporting multiple output

13th April, 2011 of 144

4. Insert a new element under Contact through right click with Add new Element.

5. Set the Id value returned from previous Insert operation sample in last section. Then unset the rest fields through right click with Set To -> Unset.

Figure 92: Input for query of Contact integration object



13th April, 2011 of 144


8. Get the result of like below.

13th April, 2011 of 144

Figure 94: Return value of Contact integration object

We can also execute the operational for Account integration object.

1. Create a new request with the button.

2. Set value of input as shown below. Unset all field in the request.

Note: Unset all field in Account integration object means to query all instances exist in the Siebel application.

13th April, 2011 of 144

Figure 95: Input for query of Account integration object



When the process is successfully complete, all Account instances will be returned. The process of the Query operation is successfully completed.

13th April, 2011 of 144

C h a p t e r 8 . Scenario 6: Inbound processing using Siebel business object with specific attribute selected

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.









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

tutorial6.zip

SiebelAccountAttributeInApp EAR application artifacts, such as deployment descriptors.

13th April, 2011 of 144

SiebelAccountAttributeInWeb Web module artifacts.

13th April, 2011 of 144


Follow the section Start the external service wizard in Chapter 3

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


13th April, 2011 of 144


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.

13th April, 2011 of 144



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.

13th April, 2011 of 144

Figure 98: Configuration Properties for Account

13th April, 2011 of 144

7. Select Name and Location for the business object, and click OK. (Field Id is imported automatically.)

Figure 99: Select Attributes

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

13th April, 2011 of 144

Figure 100: Select Objects

The business component is added to the selected object column.

13th April, 2011 of 144




1. Change Generate business objects with shorter names to generate a shorter name of XSD schema.

Note: With this option, the generated schema name is Account. Otherwise the schema name is BOAccountBCAccount. This is a useful option if customer want short name for schema.

2. Click Next.

13th April, 2011 of 144


Based on the J2C Authentication alias created earlier on WebSphere, specify it as a Using security properties form the activation specification in Deployment Properties property group on Service generation and deployment configuration dialog. Then, the connection properties can be used instead, enter the password as all other properties are recalled. After that, click Next.

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

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

Figure 102: New Module dialog

13th April, 2011 of 144

3. Specify SiebelAccountAttributeIn for the Module name. The result as shown below.


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

13th April, 2011 of 144



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 104: Java Component Added

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

13th April, 2011 of 144


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

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

Figure 106: Generate Implementation, Java

13th April, 2011 of 144

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.


13th April, 2011 of 144

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


Object Name BOAccountBCAccountBG

Event Type Create

Status 0

Object Key Id=1-7DG4

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.

13th April, 2011 of 144

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 112: Trace Statement Captured

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.

13th April, 2011 of 144

C h a p t e r 9 . Troubleshooting

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 Designer 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 109: 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,

13th April, 2011 of 144

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 110: 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 Designer.

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

13th April, 2011 of 144

Figure 111: Select Application Type

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

Figure 112: 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.

13th April, 2011 of 144

Figure 113: 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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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.

13th April, 2011 of 144

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

13th April, 2011 of 144

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

13th April, 2011 of 144

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 Oracle Corporation in the United States, other countries, or both.*

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

13th April, 2011 of 144

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

13th April, 2011 of 144

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 siebel · 2011. 7. 22. · ibm websphere adapter for siebel business...

Documents