Professional Documents
Culture Documents
Integrating Siebel Using Web Services
Integrating Siebel Using Web Services
Integrating Siebel 7.8 x CRM using Web Services with WAS 6 and RAD 6 <Name> <Email> <Date>
8/2/2006
Introduction
Web Services Overview and Concepts Siebel Web Services Framework Siebel Web Services Support
Web Services Industry Standard Support Document-Literal and RPC-Literal binding support Custom SOAP header support One-Way operation support
8/2/2006
8/2/2006
System Prerequisites For Inbound Web Services Exposing ASI as Inbound Web Service Generating an Inbound Web Service WSDL File Exporting WSDL File in RAD Generating client proxy classes in RAD Creating a Web Application For Inbound Web Service Invocation in RAD Testing on WAS V6
4 8/2/2006 2006 IBM Corporation
Integration Objects
Overview Integration Object Instances Integration Object Structure Integration Object Builder Wizards Creating Integration Object using EAI Siebel Wizard
Cont
Creating Business Services in Siebel Tools Creating a Business Service in Siebel Client Business Service Export and Import Testing using Business Service Simulator
System Prerequisites for Outbound Web Services Creating a Web Service In RAD Create an Outbound Web Service And Outbound Web Services Administration Methods To Test Outbound Web Service
Business Service Simulator Workflow Process Simulator
8/2/2006
References
10
8/2/2006
in d F
D I D /U L S D W
Service broker
W S ubli s DL /UD h DI
Service provider
2006 IBM Corporation
8/2/2006
12
8/2/2006
b.
14
8/2/2006
15
8/2/2006
16
8/2/2006
18
8/2/2006
19
8/2/2006
21
8/2/2006
22
8/2/2006
23
8/2/2006
24
8/2/2006
25
8/2/2006
26
8/2/2006
27
8/2/2006
SOAP-RPC
SOAP-DOC
Null
N/A N/A N/A N/A Outbound Outbound Outbound
Inbound/Outbound Inbound/Outbound Inbound/Outbound Inbound/Outbound Inbound/Outbound Outbound Outbound Outbound Outbound Outbound N/A Outbound Outbound Outbound
28
8/2/2006
29
8/2/2006
30
8/2/2006
31
8/2/2006
32
8/2/2006
33
8/2/2006
34
8/2/2006
4.
Click the "Clear Cache" button after you have activated the Inbound Web Service and clear the cache.
35
8/2/2006
36
8/2/2006
e. f.
37
Select wsdl generated from the Siebel Client and Click Finish. Now, you can see the wsdl under wsdls folder
8/2/2006 2006 IBM Corporation
38
8/2/2006
d.
e.
Web Service wizard automatically launched Test Client to invoke Web Service
39
8/2/2006
40
8/2/2006
HTML Input
proxy
SOAP HTTP
41
8/2/2006
Integration Objects
Siebel integration objects are used to define the structure of the message (metadata) exchanged with the external systems. It is a generalized representation or model of a particular set of data. It is a schema of a particular thing. An integration object involves transporting data from one application to another. Each integration object created in Siebel Tools has to be based on one of the base object types. This property is used by adapters to determine whether the object is a valid object for them to process.
42
8/2/2006
Integration Objects
43
8/2/2006
Integration Objects
Integration Object Instances An integration object instance is actual data organized in the format or structure of the integration object. It is also referred to as a Siebel Message object.
44
8/2/2006
Integration Objects
Integration Object Structure
The Siebel integration object provides a hierarchical structure that represents a complex data type. An integration object consists of one Parent Integration Component, sometimes referred to as the root component or the primary integration component. The Parent Integration Component corresponds to the primary business component of the business object you chose as the model for your integration object. The Parent Integration Component can have both fields and child integration components. Each integration component can also have child integration components and fields. You may choose to inactivate components and fields. By inactivating components and fields, you can define the structure of the integration object\ instances entering or leaving the system.
45 8/2/2006 2006 IBM Corporation
Integration Objects
Account Integration Object
46
8/2/2006
Integration Objects
Integration Object Wizards
There are multiple wizards associated with integration objects in Siebel Tools that creates integration objects for internal use by the Siebel application, and for external systems based on Siebel Objects. Integration Object Builder wizard: This wizard lets you create a new object. It supplies the functionality for creating integration objects from Siebel business objects or integration objects based on representations of external business objects using XML Schema Definition (XSD) or Document Type Definition (DTD). To access this wizard in Siebel Tools: a. Navigate to the File->New Object for Wizard Dialog Box a. Select the EAI tab and double-click Integration Object to start the Integration Object Builder wizard.
47 8/2/2006 2006 IBM Corporation
Integration Objects
Integration Object Builder wizard
48
8/2/2006
Integration Objects
Integration Object Wizards
Generate XML Schema wizard: This wizard lets you choose an integration object and output XML schema in XML Schema Definition (XSD) standard, Document Type Definition (DTD), or Microsoft's XDR (XML Data Reduced) format. To access this wizard in Siebel Tools: a. Navigate to the Integration Objects list in Object Explorer b. Select an integration object and click Generate Schema
49
8/2/2006
Integration Objects
Integration Object Wizards
Generate XML Schema wizard:
50
8/2/2006
Integration Objects
Integration Object Wizards
Code Generator wizard: The third wizard lets you create a set of Java class files based on any available integration object or Siebel business service. To access this wizard in Siebel Tools:
a. b. Navigate to the Integration Objects list in explorer. Select an integration and click Generate Code
51
8/2/2006
Integration Objects
Integration Object Wizards
Code Generator wizard:
52
8/2/2006
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
Siebel Tools provides a wizard to walk you through creating an integration object. Steps to create a new Siebel integration object 1. Start Siebel Tools. Create a new project and lock it, or lock an existing project in which you want to create your integration object. Choose File > New Object... to display the New Object Wizards dialog box. Select the EAI tab and double-click the Integration Object icon.
2.
3.
53
8/2/2006
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
4. In the Integration Object Builder wizard:
Select the project you locked in. Select the EAI Siebel Wizard.
54
8/2/2006
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
5. Click Next and in the second page of the Integration Object Builder wizard:
Select the source object. This is the object model for the new Siebel integration object. Only business objects with Primary Business Components appear on this picklist. Type a unique name in the field for the new Siebel integration object and click Next.
55
8/2/2006
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
6. The next page of the wizard, the Integration Object Builder - Choose Integration Components page, displays the available components of the object you chose.
Deselect the components you would like the wizard to ignore. This means you will not be able to integrate data for that component between the Siebel application and another system.
56
8/2/2006
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
7. Next page displays the messages generated during the process. Review the messages and take the appropriate actions to address them.
8. 9.
Click Finish to complete the process of creating a new Siebel integration object. After creating integration objects in Siebel Tools, compile them into a new SRF file and copy the SRF file to the IEBSRVR_ROOT/OBJECTS directory.
8/2/2006 2006 IBM Corporation
57
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
Note: Once you create your integration object based on a Siebel business object, you should not change its integration component's External Name Context; otherwise, the synchronization process will not recognize the integration component and will remove it from the integration object. To view the fields that make up each integration component, select a component from the integration component list in Siebel Tools. The Integration Component Fields applet displays the list of fields for that component.
58
8/2/2006
Integration Objects
Integration Object Validation
Steps to validate your integration object 1. Select your integration object in Object Explorer of Siebel Tools 2. Click Validate, Validate Dialog will appear.
3. 4.
59
Click Start to start the validation Process Review the report and modify your integration object as needed
8/2/2006 2006 IBM Corporation
60
8/2/2006
61
8/2/2006
62
8/2/2006
63
8/2/2006
64
8/2/2006
3. 4. 5. 6. 7. 8.
65
66
8/2/2006
67
8/2/2006
2.
3.
68
8/2/2006
2. 3. 4.
5.
69
8/2/2006
70
8/2/2006
SAPSubsys
Workflow
XMLCnv
71
8/2/2006
2.
3.
72
8/2/2006
2. 3. 4.
73
2.
3.
Define methods for the business service in the Methods list applet.
Name: Name of the method. Inactive: Check if you do not want to use the method.
74
8/2/2006
5. 6.
From the link bar, select Scripts. Write your Siebel eScript or VB code in the Business Service Scripts list applet. Click Check Syntax to check the syntax of the business service script.
7.
75
8/2/2006
76
8/2/2006
77
8/2/2006
3.
78
8/2/2006
5.
6.
7.
79
8/2/2006
80
8/2/2006
3. 4. 5.
6.
81
8/2/2006
82
8/2/2006
10. Right-click the record and choose Edit Workflow Process. 11. Drag and drop shapes (palette items) from the palette to the design canvas to build the workflow diagram. 12. Add a Start step to the design canvas. All processes must have one and only one Start step. (See Figure ) 13. Add one or more middle steps to the design canvas. Processes can have one or more of any of the action step types, such as Business Service, Decision, Sub processes, Stop, Wait, Exceptions, and Siebel Operation. There can be multiples of each type of step.
83 8/2/2006 2006 IBM Corporation
84
8/2/2006
85
8/2/2006
86
8/2/2006
c.
Click OK.
87
8/2/2006
3.
Click the hyperlink Debug Workflow in the Name column of the My Inbox Items list.
The Workflow engine is invoked, and the thread is released. Control is moved to Siebel Tools.
4. 5.
Navigate back to Siebel Tools and click the Start button. If the first step executes as expected, click Next Step to execute the next step in the process.
To use the Watch window, right-click on the canvas and select Watch Window. You can use the Process Designer at any time to make changes to the step details, and then return to the Process Simulator to debug the process.
8/2/2006 2006 IBM Corporation
88
7.
89
8/2/2006
90
8/2/2006
2. 3.
4. 5.
91
8/2/2006
A workflow process can be invoked in the following ways: From the Process Simulator view. From a workflow policy. From a script. From a run-time event. From a user event. From a synthetic event. As a configured business service.
92
8/2/2006
93
8/2/2006
5.
Click Next and in the second page of the Integration Object Builder wizard:
Select the source object. Type a unique name in the field for the new Siebel integration object Click Next.
6.
The next page of the wizard, the Integration Object Builder - Choose Integration Components page, displays the available components of the object you chose.
Select the components and Click Next
7.
94
The next page displays messages generated during the process. Click Finish.
8/2/2006 2006 IBM Corporation
95
8/2/2006
11. With the business service selected, double-click the Business Services Methods folder in the Siebel Tools Object Explorer.
Choose Edit > New Record to create a new method. Type the name of the method in the Name field.
96
8/2/2006
13. With the business service as selected, right-click to display a pop-up menu.
Choose Edit Server Scripts. Select either Siebel eScript or Visual Basic for your scripting language. Type your script into the Script Editor.
97
8/2/2006
98
8/2/2006
2.
99
8/2/2006
4.
100
8/2/2006
6.
101
8/2/2006
102
8/2/2006
103
3.
When the client makes an actual call to the Web service, make sure that SWEExtSource is pointing to the correct virtual directory and named subsystem:
http://myserver/eai_anon_enu/start.swe&SWEExtCmd=Execute&SWEExtSource =SecureWebService&UserName=user&Password=pass
104
8/2/2006
105
8/2/2006
106
8/2/2006
107
8/2/2006
108
8/2/2006
109
8/2/2006
110
8/2/2006
5.
111
112
8/2/2006
Steps to import WSDL file using Siebel Tools 1. 2. 3. 4. Launch Siebel Tools. Create a new project and lock the project, or lock an existing project. Choose File > New Object... to display the New Object Wizards. Select the EAI tab and double-click Web Service. The WSDL Import Wizard appears:
113
8/2/2006
114
8/2/2006
This procedure generates three objects in the Siebel repository: 1. An outbound proxy business service corresponding to the Java bean class exposed as a Web Service . This business service has one or more methods corresponding to the exposed Java bean methods (defined as operations in the WSDL file). This service acts as a clientside implementation of the Web Service and includes the operations and the arguments to the operations defined in the WSDL document.
115
8/2/2006
3.
116
117
8/2/2006
118
8/2/2006
119
8/2/2006
3. 4.
120
8/2/2006
121
8/2/2006
3.
Click Run to run the business service. The Simulator runs the specified number of iterations and loops through the test cases in order. If you have defined multiple input arguments, you can choose to run only one argument at a time by clicking Run On One Input. The result appears in the Output Property Set applet.
8/2/2006 2006 IBM Corporation
4.
122
123
8/2/2006
124
8/2/2006
2. 3.
125
8/2/2006
5.
Restart the Siebel component after changing the Outbound Web Service definition to allow the changes to take effect.
126
8/2/2006
127
8/2/2006
128
8/2/2006
129
8/2/2006
130
8/2/2006
131
8/2/2006
132
8/2/2006
133
8/2/2006
2. 3.
134
8/2/2006
9.
135
8/2/2006
136
8/2/2006
Troubleshooting
Log Files Siebel Server Log Files: These log files are maintained in the log directory of the Siebel Server root installation, e.g., $SIEBSRVR_ROOT\log directory. In this location you will find the master server log files (<$Enterprise>.<$Siebel_Server>.log) and accompanying component specific log files as well (<Component_alias>_<TaskId>.log) e.g., or EAIObjMgr_enu_ws_15706.log. Siebel Web Server Extension or SWSE Log Files: These log files are maintained in the log directory of the Siebel Web Server Extension root installation for example $SWEAPP_ROOT\log. The files are named as ssYYMMDD.log.
137
8/2/2006
Troubleshooting
Siebel Service Argument Tracing
Web Services Tracing can be enabled on the Siebel Server to write all inbound and outbound SOAP documents to a log file. Steps to enable Web Services Tracing 1. Navigate to the Administration - Server Configuration screen > Servers view. The view that appears displays three different list applets. The top applet lists the Siebel Servers for the enterprise. The middle applet has three tabsComponents, Parameters and Events. The bottom applet has two tabsEvents and Parameters.
138
8/2/2006
Troubleshooting
Steps to enable Web Services Tracing
139
8/2/2006
Troubleshooting
Siebel Service Argument Tracing
Steps to enable Web Services Tracing 2. 3. In the top list applet, select the Siebel Server that you want to configure. In the middle applet, click the Components tab. This list applet contains the components for the Siebel Server selected in the top applet. Choose the relevant application object manager. In the bottom applet, click the Parameters tab. This list applet contains the parameters for the Component selected in the middle applet. Set the Log Level to 4 for any or all of the following Event Types.
4.
5.
140
8/2/2006
Troubleshooting
Siebel Service Argument Tracing
On the web service consumer application, following files are created by the WebService dispatcher when web service is invoked: OutboundDispatcher_input_args_<pid>.dmp OutboundDispatcher_output_args_<pid>.dmp The outut_args log shows your SOAP request and the input_args log shows the SOAP response. The SOAP response may be a SOAP fault message or empty file if your SOAP request was not valid. On the server, if your request is succesfully received and processed, you will see these two additional logs: InboundDispatcher_input_args_<pid>.dmp InboundDispatcher_output_args_<pid>.dmp The input_args log shows the inbound SOAP request received and the output_args log shows the SOAP response sent out. The SOAP response may be a SOAP fault message if your inbound request was not valid.
141 8/2/2006 2006 IBM Corporation
Troubleshooting
Troubleshooting Tips
Make sure that Siebel server environment, with the Siebel Web Server Extension (SWSE) set up, is up and running. Siebel Enterprise Application Integration (EAI) component group must be enabled. Make Sure that the Siebel Web Service invoked by the external application is active in the Web Services Administration View - for Inbound Web Service. Make Sure that the Address for the Siebel Web Service under Service Ports Applet in Web Services Administration View - for Inbound Web Service is correct (check for hostname, user and password in the address url).
142
8/2/2006
Troubleshooting
Troubleshooting Tips
Web services are loaded in srf, so make sure that srf in client\objects\enu is the same as srf in siebsrvr\objects\enu. If they are different, copy the client to the server and restart Siebel Server service. If there are more than one Siebel Server, then copy to each Siebel Server then restart all Siebel Servers. Enable Siebel service argument tracing to capture the Simple Object Access Protocol (SOAP) messages. Make sure to enable WebSvcOutboundArgTrc (Web Service Outbound Argument Tracing) and WebSvcInboundArgTrc (Web Service Inbound Argument Tracing) events to capture the inbound and outbound SOAP messages respectively. Check the logs generated after enabling Service Argument for SOAP Request and Response messages. Check for input arguments supplied to the web service proxy business service in case of Outbound Web Service.
143 8/2/2006 2006 IBM Corporation
References
Siebel SupportWeb http://supportweb.siebel.com
Under Self Service click on Browse/Search knowledge base In the left navigation pane click on Product Documentation or Technical Notes.
144
8/2/2006
References
RAD and WASV6 References http://publib.boulder.ibm.com/infocenter/wasinfo/v6r0/index.jsp?topic=/c om.ibm.websphere.base.doc/info/welcome_base.html http://www.redbooks.ibm.com/abstracts/sg246451.html?Open http://www.redbooks.ibm.com/abstracts/sg246449.html?Open/ RAD and WASV6 References
145
8/2/2006
Contacts
Falk, Walter WebSphere Business Development Email: wfalk@us.ibm.com Tel: 1-512-823-6911 Mobile: 1-512-589-8343
Attappilly,Anilkumar WebSphere Business Development Email: anilk@us.ibm.com Tel: 1-650-352-6263 Mobile: 1-650-430-2172
146
8/2/2006