Working with Web Service Connector in OIM 11g R2PS3

Background:

• Webservices are web APIs exposed by web applications to enable inter-operability with their applications. Operations exposed by webservice can be invoked and used via SOAP protocol.
• The OIM OOB (Out-of the box) WebService Connector is SOAP based.
• The SOAP operations are offered based on a pre-defined WSDL contract. 
• WSDL contains definitions for the operations, the input and output schema specific to each operation.
• SOA server acts as a middle layer between OIM and target web service.
• The connector uses SOA to connect to target web service and perform operations on them.
• SOA composite project is used to wire the operations against the target web service's.

Prerequisites:

• Target Web Service WSDL/WSDL URL
• Target Web Service details
• Jdeveloper
• Good to have SOAP-UI(Just to check the request/response of the web service.It has nothing to do with OIM/Web-Service Connector) .This tool can help you to identity the required/mandatory parameters in your web service,format of some parameters in case if this information is not provided by the client/web service owner.
• Web Service Connector installer - http://www.oracle.com/technetwork/middleware/id-mgmt/downloads/connectors-101674.html

Building the Connector Bundle: 

• Build utility is used to build the target web service connector.
• The build utility is a script that generates OIM artifacts specific to target web-service.
• It also generates SOA composite project, to which you can wire a web service client against target web service.

      Follow the steps to generate a connector bundle

o Create a directory for the connector, for example, Webservices-11.1.1.5.0, in the OIM_HOME/server/ConnectorDefaultDirectory directory

o  Copy and unzip the contents of the connector installation media directory into directory created in Step 1.

     Execute the following command:

      sh build-connector.sh "LONG_CODE" "SHORT_CODE"

            where,

            LONG_CODE = descriptive name of the connector

SHORT_CODE= the concise 4-character name of the target system that will be used in    lookup names, adapter names

              E.g. Jive is the name of target web service in my case; give any suitable name as per 

                     your target.

  

                                                 After successful execution of the command, following message will be displayed;

                                                                                Installing Connector in OIM:

1. Log in to the Administrative and User Console with a user who have connector installation permissions.
2. In the left pane, under System Management, click Manage Connector.
3. In the Connector Management page, click Install.
4. From the Connector List, select JiveWS Connector 11.1.1.5.0.   

   

                                                                                                                                                                                                                                               5. Click Load.

       6. To start the installation process, click Continue.

          Wait till all the tasks get complete.

       7. The following tasks are performed, in sequence:

1. Configuration of Connector Libraries
2. Import of the Connector XML Files (Using Deployment Manager)
3. Compilation of Adapter Definitions 

     8. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. 

                                                                                                                                                                                      9. Verify the artifacts generated through design console     

Creating and Configuring SOA Composite for Target Web Service:

   1.  Copy the SOA composite project from OIM_HOME/server/ConnectorDefaultDirectory

        /Webservices-11.1.1.5.0/soa/project/JiveWSConnector.

   2.  Open the JiveWSConnector.jpr file in Jdeveloper.

   3.  Open WSConnector.bpel file.

   4.  Drag and drop Partner link on right hand side.

   5.  Right click on the Partner Link and click edit.

   6.  Enter details as below:

              Name: Endpoint name [JiveWSEndpoint]

              WSDL URL: online WSDL URL /offline downloaded WSDL location.

              PartnerLink Type: There should be only one type, select it.

              Partner Role: There should be only one type, select it.

              My Role: Select as below

   

                                                                                                           

 7.   Click Apply and Save the Project.

 

Next upcoming blog:  Configuring Create,Update,Delete and Search Operations in SOA Composite for target web-service.