Training Introduction to Webservices

Title
DC/ SC/ Geo/Practice: Telecom
Name of the project: Sonofon 4L Support
Name of the author: Rohit Tatwawadi
Date Created: December 2008

11 February 2009
Audience:
Siebel Developers who need to use webservices to
interact with other application.

Purpose:
To understand basics of webservices and how outbound
webservices are implemented in Siebel.
Applicable for version Siebel 7.x

11 February 2009
 Agenda
What are Web Services
Why Web Services
Advantages and disadvantages of Web Services
Web Services Platform Elements
Web Services Types
Implementation of Outbound Web Services
What are DTOs?
Invoking Web Service
Troubleshooting tips

11 February 2009
 What are Webservices
A s/w system designed to support interoperable Machine to Machine
interaction over a network.
In common usage terms, it refers to Client and Server that communicate
using XML messages that follow SOAP Standerds.

11 February 2009
 Why Webservices
Using Web Services, different platforms can interact and exchange data.
Using Web Servises, your application can publish its functions, messages
and data to the rest of the world.
Web services use XML to code and uncode your data, and SOAP to
transport it using open protocols.

11 February 2009
 Advantages of Webservices

Web services provide interoperability between various software

applications running on different platforms.
Web services use open standards and protocols. Thus easy to use and
understand.
Web services easily allow software and services from different companies
and locations to be combined easily to provide an integrated service.
Web services allow the reuse of services and components within an
infrastructure.

11 February 2009
 Disadvantages of Webservices

Web services suffer from poor performance compared to other distributed

computing approaches such as RMI, CORBA, or DCOM.
By utilizing HTTP, web services can evade existing firewall security
measures whose rules are intended to block or audit communication
between programs on either side of the firewall.

11 February 2009
 Webservices Platform Elements
There are three basic platform elements.
-- SOAP
-- WSDL
-- UDDI

11 February 2009
 What is SOAP?
SOAP stands for Simple Object Access Protocol
SOAP is a communication protocol
SOAP is for communication between applications
SOAP is a format for sending messages
SOAP is designed to communicate via Internet
SOAP is platform independent
SOAP is language independent
SOAP is based on XML

SOAP is about applications communicating directly with each other over

the Internet in a very rich way.
SOAP is a protocol for exchanging XML -based messages over Computer
Networks, normally using HTTP/HTTPS
There are several different types of messaging patterns in SOAP, but by far
the most common is the Remote Procedure Call (RPC) pattern, in which
one network node (the client) sends a request message to another node
(the server) and the server immediately sends a response message to the
client.

11 February 2009
 What is WSDL
WSDL stands for Web Services Description Language
WSDL is an XML document
WSDL is used to describe Web services
WSDL is also used to locate Web services

The Web Services Description Language (WSDL) is an XML format

published for describing Web Services.
A WSDL document describes Web Service operations, input and output
parameters, and how a client application connects to the Web Service.

11 February 2009
 What is UDDI
UDDI is a directory service where businesses can register and search
for Web services.

UDDI stands for Universal Description, Discovery and Integration

UDDI is a directory for storing information about web services
UDDI is a directory of web service interfaces described by WSDL
UDDI communicates via SOAP

UDDI is an open industry initiative enabling businesses to discover

each other and define how they interact over the Internet..

11 February 2009
 Webservices Types
InBound Web Services
-- Inbound Web Sevices allows an external system to call Siebel Published
Web Service.
-- Business Service or Business Process can be published as Web Service
and generate WSDL that external system can Import.

Outbound Web Services.

-- Outbound Web Service is published by external system.
-- External application provides WSDL to be imported in Siebel.

11 February 2009
 Implementation Outbound Web
Services in Siebel
WSDL will be provided by external application.
Import this WSDL in Siebel Tools using WSDL Import Wizard.
Steps to Import WSDL using Import Wizard
1. Start Siebel Tools.
2. Create a new project and lock the project, or lock an existing project in
which you want to create your integration object.
3. Choose File > New Object... to display the New Object Wizards.
4. Select the EAI tab, select the Web Service icon, and click OK. The
WSDL Import Wizard appears.
5. Select the Project where you want the objects to be held after they are
created from the WSDL document.
6. Specify the WSDL document that contains the Web Service or Web
Services definition that you want to import.
7. Specify the file where you want to store the run-time data extracted
from the WSDL document.
8. Click Next to view and verify a summary of your import information.
9. Click Finish to complete the process of importing the business service
into the Siebel repository.

11 February 2009
 Implementation Outbound Web
Services in Siebel
This procedure generates three objects in Siebel repository
1. An outbound proxy business service of CSSWSOutboundDisptacher
class.
2. One or more integration objects representing input and output
parameters of the service methods.
3. An XML document containing the run-time parameters that should be
imported into the Siebel client.

After this you will have to write one custom business service which will
define DTO and make a call to outbound BS.

In the next two slides, screen shots of Integration Objects and Business
Services in Siebel Tools are shown.

11 February 2009
11 February 2009
11 February 2009
 What are DTOs?

Data Transfer Objects (DTO), formerly known as Value Objects or VO,

are a design pattern used to transfer data between software application
subsystems.

11 February 2009
 To Import Runtime Data about
external Webservice
The WSDL Import Wizard exports the data to a file that you must import
to the runtime database (the Web Services address) using the Outbound
Web Services screen.
1. Restart the Siebel Server (or Mobile Web Client) with a recompiled
version of the .srf file that includes the new objects created by the Web
Services Import Wizard.
2. From the application-level menu, choose View > Site Map > Web
Services Administration> Outbound Web Services view.
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.

Next slide shows the screen shot of Webservices Administration screen.

11 February 2009
 InBound Web Services
-- Inbound Web Sevices allows an external system to call Siebel Published
Web Service.
-- Business Service or Business Process can be published as Web Service
and generate WSDL that external system can Import.

Outbound Web Services.

-- Outbound Web Service is published by external system.
-- External application provides WSDL to be imported in Siebel.

11 February 2009
 Invoking Web Service using
Workflow or scripting
Developer gets WSDL
WSDL Import Wizard is called
WSDL Import Wizard generates definitions for outbound proxy,
Integration Objects, and administrative entries.
The outbound webservice proxy is called with request property set
The request is converted to an outbound SOAP request and sent
to external application.
The external application returns SOAP response.
SOAP response is converted to property set that can be
processed by the calling function.

11 February 2009
 Troubleshooting tips
You can enable Web Services Tracing on the server to write all Inbound
and Outbound soap documents to a log file.
To enable web services tracing
1. From Application level menu, go to site map Server Administration
2. Go to Servers View
3. Select server event configuration tab
4. Set the log level parameter to 4 for following event types
Web Services Inbound Aurgument tracing
Web Services Outboud Aurgument Tracing
Web Services Inbound
Web Services Outbound
1. Navigate to Component View
2. Select EAI Object Managet Component, and select component parameter
tab
3. Set the Enable Business Service Aurgument Tracing parameter to True
4. Restart the server component.

11 February 2009
Thank You

11 February 2009