Integration Platform Technologies: Siebel Enterprise Application Integration > Web Services > Consuming External Web Services Using Siebel Web Services >
Creating an Outbound Web Service Based on a WSDL File
Consumption of external Web services is accomplished using the WSDL Import Wizard in Siebel Tools. The following procedure describes how to use this wizard to read an external WSDL document.
Note the following restrictions on WSDL import:
- Importing a WSDL containing a cyclic reference, that is, a complex type definition having a member of the same type as itself, is not supported.
- The WSDL Import Wizard expects each schema to have a unique target namespace. Using the same namespace for more than one schema will generate an error.
- Importing a WSDL with a mix of different SOAP operation styles (for example, RPC and Document) within one service port binding is not supported. Modify the WDL to have a service port binding defined for each SOAP operation style.
To create an outbound Web service based on a WSDL file
- In Siebel Tools, create a new project and lock the project, or lock an existing project.
- From the File menu, choose New Object to display the New Object Wizards dialog box.
- Click the EAI tab, and then 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.
- (Optional) Select the Process Fault Schema checkbox, and specify an existing Fault Integration Object Name, to create and reuse SOAP fault integration objects.
NOTE: SOAP fault integration objects are prepended with Fault_.
For more information on SOAP fault integration objects, see About SOAP Fault Schema Support.
- Click Next.
A summary of your import information, as well as any errors, appears.
- (Optional) Select the Deploy the Integration Object(s) and the Proxy Business Service(s) checkbox to deploy these objects to the Siebel run-time database.
Deployed integration objects are shown in the Administration - Web Services screen, Deployed Integration Objects view in the Siebel client. Deployed business services are shown in the Administration - Business Services screen in the Siebel client.
NOTE: If you deploy integration objects while the Siebel Server is running, then you must subsequently clear the Web services cache in the Administration - Web Services screen, Inbound (or Outbound) Web Services view.
- Click Finish to complete the process of importing the business service into the Siebel repository.
This procedure generates three objects in the Siebel repository:
- An outbound proxy business service of CSSWSOutboundDispatcher class. This service acts as a client-side implementation of the Web service and includes the operations and the arguments to the operations defined in the WSDL document.
NOTE: For RPC services, the order of input arguments is important. You can set the order through the Preferred Sequence property of the business service method argument in Siebel Tools. By specifying this parameter, the outbound dispatcher makes sure that the sequence parameters for an operation are in the correct order. The Preferred Sequence property is only supported with outbound services.
- Integration objects, representing input and output parameters of the service methods, if any of the operations require a complex argument (XML Schema) to be passed. If the service does not use complex arguments, then no integration object definitions will be created.
- A Web service administration document (XML file) containing the run-time Web service administration data to be imported into the Siebel Web Client, using the Outbound Web Services view of the Administration - Web Services screen.
The purpose of the document is to allow administrators to modify run-time parameters such as the URL and encoding rules. The data contained within the document is used by the Web Services Dispatcher to assemble the SOAP document, to set any HTTP headers required (for example, soapAction), and to route the request to the correct URL. For information, see To import run-time data about external Web services.
Importing Run-Time Data About External Web Services
The WSDL Import Wizard exports the data to a file that you can import to the run-time database (the Web services address) using the Outbound Web Services view.
To import run-time data about external Web services
- Restart the Siebel Server (or Siebel Mobile Web Client) with a recompiled version of the SRF file that includes the new objects created by the Web Services Import Wizard.
NOTE: You do not have to update your SRF file at design time. However, the service definition must exist in the SRF file during run time.
- Navigate to the Administration - Web Services screen, Outbound Web Services view.
- In the Outbound Web Services list applet, click Import to display the EAI Web Service Import dialog box.
- Specify the export file created by the Web Services Import Wizard.
- Click Import to import the Web service definition into the database.