Professional Documents
Culture Documents
Web Services Siebel PDF
Web Services Siebel PDF
<Name>
<Email>
<Date>
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
Siebel Web Services Inbound and Outbound
Integration Objects
Overview
Integration Object Instances
Integration Object Structure
Integration Object Builder Wizards
Creating Integration Object using EAI Siebel
Wizard
Siebel Business Services
Overview
Business Service Structure
Property Sets
UDDI Service
registry broker P
iF n d DD I W S ubli
DL s
/UD h
LD /U
DI
Service W S SOAP
SOAP Service
requestor Bind/Invoke provider
Web Service Provider creates a Web Service and publishes its interface and
access information (WSDL file) to the service registry. UDDI protocol is used to
publish the Web Services.
Web Service Broker is responsible for making the Web service interface and
implementation access information available to any potential service requestor.
Web Service Requestor locates entries into the broker registry by find
operations and then binds to the service provider in order to invoke one of its
Web Services.
Web Service broker is optional. Web Service provider can directly send Web
Service interface and access information to the Web Service requestor.
To specify the structure of XML used in the body of SOAP messages Web
Services use an XML Schema Definition (XSD) standard.
It is set of business services, interfaces and components that can be used to:
XML Schema.
Inbound
If the Business Service Workflow method does not have any output
arguments, it is a one-way operation.
Outbound
If the service proxy method has no output arguments, it is a one-way
operation.
-ASIs are version and schema independent so you can use the same
ASI invocations across different Siebel versions
Other interfaces can be built using the ASI Framework, but are not
considered to be ASIs. Only Siebel prebuilt ASIs are supported
across releases.
Inbound ASI
Inbound ASI
Inbound ASIs
The SOAP fault block returns any inbound error messages, as defined by the
SOAP 1.1 specification.
The faultcode contains either a Client or Server value, and the faultstring
contains a description of the error. The error message <siebel:errormsg>
details the problems with the request.
Outbound ASIs
If an error occurs during an outbound ASI that has been exposed as a Web
Service, the business service raises the error and returns the SOAP fault
message as the output method argument, soap:fault, for the application to
process.
3. Generate the WSDL that describes the web service and save this file.
a. Click the Generate WSDL button
b. Download popup asking where to save the file will be displayed.
c. Change the FileName to a meaningful value and save the file.
4. Click the "Clear Cache" button after you have activated the Inbound
Web Service and clear the cache.
e. Select wsdl generated from the Siebel Client and Click Finish.
f. Now, you can see the wsdl under wsdls folder
c. On the next panel, the WSDL file is preselected, press Next and follow the
instructions in the Wizard and at the end click Finish.
d. All the generated java files can be viewed under the project folders.
e. Web Service wizard automatically launched Test Client to invoke Web Service
Export the Web Project developed in RAD as War file and deploy it on
WAS V6.
getContactProxy
JSP Result
Page
Siebel
Data
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.
Integration Objects
Integration Objects
Integration Object Instances
Integration Objects
Integration Object Structure
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.
Integration Objects
Account Integration Object
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).
Integration Objects
Integration Object Builder wizard
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.
Integration Objects
Integration Object Wizards
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. Navigate to the Integration Objects list in explorer.
b. Select an integration and click Generate Code
Integration Objects
Integration Object Wizards
Integration Objects
Creating Integration Objects Using the EAI Siebel Wizard
2. Choose File > New Object... to display the New Object Wizards dialog
box.
3. Select the EAI tab and double-click the Integration Object icon.
Integration Objects
Integration Objects
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.
Integration Objects
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.
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.
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.
Integration Objects
Integration Object Validation
Business components and business objects are objects that are typically tied
to specific data and tables in the Siebel data model.
Business services can simplify the task of moving data and converting data
formats between the Siebel application and external applications.
Business services can also be used outside the context of Siebel eAI to
accomplish other types of tasks( such as performing a standard tax
calculation, a shipping rate calculation, or other specialized functions).
Methods take arguments that can be passed into the object programmatically
or, in the case of Siebel eAI, declaratively by way of workflows.
You can build your own business service and its functionality in
Siebel Tools and Siebel Client.
2. Select and lock the project you want to associate your business service
with.
7. Type the name of the project you locked in Step B, in the Project field.
8. Choose the appropriate class for your business service, from the Class
picklist.
65 8/2/2006 2006 IBM Corporation
Business Product Technical Enablement AIM Services
Business services contain related methods that provide the ability to perform
a particular task or set of tasks.
1. Select the business service in Siebel Tools for which you want to write a
script.
4. Select either Siebel eScript or Visual Basic for your scripting language.
Service_PreInvokedMethod is selected as the event handler.
User properties, also known as User Props, are optional variables that you
can use to define default values for your business services.
When a script or control invokes your business service, one of the first tasks
the service performs is to check the user properties to gather any default
values that will become input arguments to the service's methods.
2. Choose Edit > New Record to create a blank user property record.
4. Type a value in the Value field. The value can be an integer, a string, or a
Boolean.
1. From the application-level menu, choose Navigate > Site Map >
Administration - Business Service > Methods.
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.
4. Define method arguments for the methods in the Method Arguments list
applet.
Name: Name of the method argument.
Type : The type of the business service method argument. Valid values
are Output, Input, and Input/Output.
Optional: Check if you do not want this argument be optional.
Inactive: Check if you do not want to use the argument.
6. Write your Siebel eScript or VB code in the Business Service Scripts list
applet.
7. Click Check Syntax to check the syntax of the business service script.
You can also import a business service from an external XML file by clicking
the Import Service button in the Business Service list applet
4. Enter the number of iterations you want to run the business service.
Specify the input parameters for the Business Service Method in the
Input Property Set applet. Multiple Input Property Sets can be defined
and are identified by specifying a Test Case #.
5. If the Input Property Set has multiple properties, these can be specified
by clicking on the glyph in the Property Name field. Hierarchical Property
Sets can also be defined by clicking on the glyph in the Child Type field.
6. 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.
15. Illustrate the flow and paths of the process by dragging and dropping
connector arrows between the steps.
16. To validate Workflow Process for any errors, right click on the canvas
and then click Validate as shown in Fig.
Note: An end point on a connector is white if it is not successfully
connected to a step. Be sure that both ends of all connectors are red,
indicating that it is successfully connecting two steps.
c. Click OK.
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.
5. 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.
88 8/2/2006 2006 IBM Corporation
Business Product Technical Enablement AIM Services
6. Continue stepping through the workflow process and verifying the results
of each step in the Watch window until the process completes.
7. When you are finished, click the Stop button to terminate the simulation.
Select the workflow process in the Object List Editor and click Deploy.
1. Launch the Siebel Tools Application. Select the Project option from the
tree view.
2. Right click on the Project Table/Grid and select New Record. This will
create an empty record. Enter the name of the project My Account.
Enter the language (e.g. ENU for English). Make sure the Locked field is
checked.
3. Go to File New Object This will bring up the New Object Wizards
window. Click on EAI tab and select Integration Object and Click ok.
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
10. Select the Business Services object in the Tools Object Explorer in
Siebel Tools.
a. Choose Edit > New Record to create a new business service.
b. Type a name for your business service in the Name field and name of project
you locked.
c. Choose the appropriate class for your business service, from the Class
picklist:
Data transformation business services must use the
CSSEAIDTEScriptService class.
Other business services will typically use the CSSService class.
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.
12. With your business service selected, double-click the Business Service
Method Arg folder, in the Tools Object Explorer, to display the Business
Service Method Args list.
Choose Edit > New Record to create a blank method
argument record.
Type the name and Display Name of the argument.
Enter the data type in the Data Type field.
Check the Optional check box if you do not want the argument to
be required for the method.
Choose a Type for the argument
14. Go to Tools Compile Projects This will bring up the Object Compiler
window.
Select the project (created in Step 2) and click on Compile. The
compilation process may take several minutes.
1. Launch Siebel Client and Navigate to View -> Site Map ->Web Service
Administration ->Inbound Web Services.
3. Create new Service Port in Service Port Launch Siebel Client and
Navigate to View -> Site Map ->Web Service Administration ->Inbound
Web Services.
4. When clicking on the Type field a Pick Applet pops-up with the Business
Service already registered to be exposed as Web Service. To expose
new Business Services, click new button and then the implementation
type and select name of Business Service have be selected.
5. Finally, in the Operation List Applet, create a new record for each method
of the Business Service to be published.
Testing on WAS V6
Siebel 7.7 introduces support for the UserName Token mechanism of the
WS-Security specification, which allows Siebel applications to send and
receive user credentials in a standards-compliant manner
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
The UserName token mechanism provides a Web Service with the ability to
operate without having the username and password in its URL or having to
pass a session cookie with the HTTP request.
2. A Web Service based on a Java bean can be easily created using the
Web Service wizard in RAD. Go to File->New->Other. In the Select
panel select Web Services->Web service, then click Next.
2. In next panel, select the Java Bean created under the project
3. Next, select Service Project and EAR project.
4. Next is the Web Service Java Bean identity panel. Select the
appropriate Style and Use. Click Next. Notice that several WSDL files
are being generated.
6. WSDLs and other binding files generated by the wizard can be viewed
under project. Export the wsdl corresponding to Java Bean you created
(ConversionBean.wsdl) to be imported into Siebel Tools.
2. Create a new project and lock the project, or lock an existing project.
3. Choose File > New Object... to display the New Object Wizards.
4. Select the EAI tab and double-click Web Service. The WSDL Import
Wizard appears:
Select the Project where you want the objects to be held after they are
created from the WSDL document.
Specify the WSDL document that contains the Web Service or Web Services
definition that you want to import.
Specify the file where you want to store the run-time data extracted from the
WSDL document or accept the default.
Specify the log file where you want errors, warnings, and other information
related to the import process to be logged or accept the default.
1. Restart the Siebel Server with a recompiled version of the SRF file that
includes the new objects created by the Web Services Import Wizard.
2. Navigate to the Administration - Web Services screen > Outbound Web
Services view in Siebel Client.
3. In the Outbound Web Services list applet, click Import to bring up the EAI
Web Service Import dialog box.
4. Specify the export file created by the Web Services Import Wizard.
5. Click Import to import the Web Service definition into the database
2. Enter the number of iterations you want to run the business service:
Specify the input parameters for the Business Service Method in the
Input Property Set applet. Multiple Input Property Sets can be defined
and are identified by specifying a Test Case #.
If the Input Property Set has multiple properties, these can be specified
by clicking on the glyph in the Property Name field. Hierarchical
Property Sets can also be defined by clicking on the glyph in the Child
Type field.
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.
4. The result appears in the Output Property Set applet.
122 8/2/2006 2006 IBM Corporation
Business Product Technical Enablement AIM Services
Workflow Process for Outbound Web Service can be created and tested using
Workflow Process Simulator following the same steps as described under
WorkFlow Process slides. Use Business Service created for Outbound Web
Service using Siebel WSDL Import Wizard.
The input to the local business service is a property set that represents the
SOAP request.
Once the SOAP request is inside the local business service, additional SOAP
headers may be added to address infrastructure requirements.
This is done by direct modification of the input property set.
1. In the Siebel client, navigate to the Web Services Administration view via
the Site Map.
2. Select Outbound Web Services from the Web Services Administration view.
4. In the Service Ports list applet, change the Transport and Address columns
as follows:
a. Select Local Business Service in the Transport column.
b. Enter the name of the local business service in the Address column.
5. Restart the Siebel component after changing the Outbound Web Service
definition to allow the changes to take effect.
With UserName tokens, the URL does not reveal the user credentials:
http://webserver/eai_anon_enu/start.swe?SWEExtSource=SecureWebS
ervice&SWEExtCmd=Execute
The Inbound Web Services View in Siebel Client provides an interface for
associating operations with authentication types.
The applet shown in figure can be defined as requiring no authentication, or
requiring a UserName Token with username and password provided in clear
text.
The following table lists SOAP headers to invoke different types of sessions,
and pass authentication credentials
2. In the top list applet, select the Siebel Server that you want to configure.
3. In the middle applet, click the Components tab. This list applet contains
the components for the Siebel Server selected in the top applet.
6. Set the Log Level to 4 for any or all of the Event Types.
8. Select the EAI Object Manager component, and select the Component
Parameters tab.
Both Siebel Inbound and Outbound Web Services are typically cached into
memory on the Siebel Server.
The Web Services cache stores all the global administration information that
can be manipulated in the Inbound and Outbound Web Service adminis-
-tration views in Siebel Client
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.
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.
Troubleshooting
Steps to enable Web Services Tracing
Troubleshooting
Siebel Service Argument Tracing
2. In the top list applet, select the Siebel Server that you want to configure.
3. 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.
4. In the bottom applet, click the Parameters tab. This list applet contains
the parameters for the Component selected in the middle applet.
5. Set the Log Level to 4 for any or all of the following Event Types.
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
Business Product Technical Enablement AIM Services
Troubleshooting
Troubleshooting Tips
Make sure that Siebel server environment, with the Siebel Web Server
Extension (SWSE) set up, is up and running.
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).
Troubleshooting
Troubleshooting Tips
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.
References
Contacts