Versioning Load Plans Exporting, Importing and Versioning Load Plans

Working with Web Services in Oracle Data Integrator 15-3

15.3 Oracle Data Integrator Run-Time Services

Oracle Data Integrator Run-Time Services are web services that enable users to leverage Oracle Data Integrator features in a service-oriented architecture SOA. These web services are invoked by a third-party application manage start scenarios developed with Oracle Data Integrator. How to perform the different ODI execution tasks with the ODI Run-Time Services such as executing a scenario, restarting a session, listing execution contexts and scenarios is detailed in Section 20.11, Managing Executions Using Web Services . Section 20.11 also provides examples of SOAP requests and responses.

15.4 Invoking Third-Party Web Services

This section describes how to invoke third-party web services in Oracle Data Integrator. This section includes the following topics: ■ Section 15.4.1, Introduction to Web Service Invocation ■ Section 15.4.2, Using the OdiInvokeWebService Tool ■ Section 15.4.3, Web Service Invocation in Integration Flows

15.4.1 Introduction to Web Service Invocation

Web Services can be invoked: ■ In Oracle Data Integrator packages or procedures using the OdiInvokeWebService tool: This tool allows you to invoke any third party web service, and save the response in a XML file that can be processed with Oracle Data Integrator. ■ For testing Data Services: The easiest way to test whether your generated data services are running correctly is to use the graphical interface of the OdiInvokeWebService tool. See Section 15.4.2, Using the OdiInvokeWebService Tool for more information.

15.4.2 Using the OdiInvokeWebService Tool

The OdiInvokeWebService tool invokes a web service using the HTTP or HTTPS protocol and is able to write the returned response to an XML file, which can be an XML payload or a full-formed SOAP message including a SOAP header and body. The OdiInvokeWebService tool invokes a specific operation on a port of a web service whose description file WSDL URL is provided. If this operation requires a SOAP request, it is provided either in a request file or in the tool command. The response of the web service request is written to an XML file that can be used in Oracle Data Integrator. How to create a web service request is detailed in Section 15.4.3, Web Service Invocation in Integration Flows . Note: If the web service operation is one-way and does not return any response, no response file is generated. 15-4 Oracle Fusion Middleware Developers Guide for Oracle Data Integrator This tool can be used as a regular Oracle Data Integrator tool in a tool step of a package and also in procedures and knowledge modules. See Section 10.3.1.4, Adding Oracle Data Integrator Tool Steps for information on how to create a tool step in a package and Appendix A.5.22, OdiInvokeWebService for details on the OdiInvokeWeb Service tool parameters. The OdiInvokeWebService tool provides an Advanced editor for generating its code. This Advanced editor is available when using the OdiInvokeWebService tool in a package or when performing a Data Service test. In this Advanced editor you can: ■ Connect to the WSDL ■ Specify parameters for the tool in addition to the parameters specified in the Properties pane ■ Select a specific operation on the automatically selected port and specify request parameters in the SOAP editor ■ Invoke a Web Service ■ Consult the Web service response in the SOAP editor Figure 15–2 gives an overview of the Advanced Editor. Figure 15–2 OdiInvokeWebService Advanced Editor This image shows the Advanced editor of the OdiInvokeWebService tool. The Advanced Editor consists of the sections described in Table 15–1 . Note: When using the XML payload format, the OdiInvokeWebService tool does not support the SOAP headers of the request. In order to work with SOAP headers, for example for secured web service invocation, use a full SOAP message and modify manually the SOAP headers. Working with Web Services in Oracle Data Integrator 15-5 Table 15–1 Advanced Editor Sections Section Icon Name Location in Figure Description Web Service Description File WSDL URL top Enter here the WSDL location Port left The port of the web service is set by default. If more than one port is available for the web service, select the appropriate port. Invoke Web Service toolbar icon Invokes immediately the current Web Service, displaying the response in the SOAP editor. Switch Panel Position toolbar icon Tiles vertically or horizontally the SOAP editor. Export Response XSD toolbar icon Saves the current response XML schema description to a file. Restore Default Request toolbar icon Discards the current request and reverts to a default, blank request structure. Delete Empty Optional Components toolbar icon Removes all blank optional elements from the query. This may be necessary to construct a valid query. Clean up before execution toolbar icon Automatically deletes empty optional elements in the SOAP request when Invoke Web Service is clicked. This checkbox has no effect on package steps at run-time. Use Request File toolbar icon Uses a SOAP request stored in a file instead of the parameters specified in the SOAP editor. Timeout ms toolbar icon Specifies a maximum period of time to wait for the request to be complete. Operation The list of operations for the selected port. Options The HTTP request options: ■ Timeout : The web service request waits for a reply for this time before considering that the server will not provide a response and an error is produced. ■ HTTP Authentication: If you check this box, you should provide a user and password to authenticate on your HTTP server. SOAP Editor middle and right Displays the web service request on the left pane in the SOAP Editor or Source tab and the SOAP response on the right pane.