Using SAP Adapter with OSB 11g (PS3)


We see a lot of requests from the field for a sample project demonstrating the usage of SAP Adapter with OSB. A viewlet is made to address this request and is available on OTN.

As a supplement, a brief overview is presented here to outline the steps required to build such a simple project with OSB 11g and SAP Adapter for the PS3 release.

At the time of writing this note, PS3 was the latest release for the iWay Adapters. This note can, however, serve as a reference document for post-install steps, while working with later releases.


The installation is fairly standard. So, we will skip the details here. The high level sequence is outlined below:

Database Install

  • Install Database - EE is recommended but XE is good enough for demo purposes.

OSB 11g PS3 Install

  • Install Weblogic w/OEPE for PS3 release
  • Install OSB 11g PS3 release, only choosing the OSB option

Adapter Install

  • Install Adapter PS2 in the OSB 11g PS3 Middleware home
  • Upgrade OPatch that came with the OSB 11g PS3 release
  • Apply Adapter Patch PS3

OSB Configuration

  • Create OSB Domain - a simple domain with Adminserver and one Managed Server

Adapter Configuration

  • Modify $ORACLE_HOME/3rdParty/ApplicationAdapters/iwafca.rar/META-INF/ra.xml
  • Deploy Adapter rar and JCA Test Servlet
  • Copy SAP specific libraries in
    • $ORACLE_HOME/3rdParty/ApplicationAdapters/lib (for Design-time)
    • $DOMAIN_HOME/lib (for Run-time)

Project Build - Design-Time

For building OSB projects with iWay Adapters, we use the design-time browser interface of OSB 11g and the Application Explorer design-time tool from iWay. The following sections highlight the overall sequence.

OSB Design Time - Part 1

First, create a place-holder project with appropriate folders in OSB, that can be used to export artifacts from the Application Explorer tool directly.

Application Explorer - iWay Design Time Tool

For iWay Adapters, we use the design-time tool Application Explorer for introspection of SAP repository objects and generate the metadata consisting of xsd/wsdl and jca binding files.

To launch Application Explorer, the environment has to be properly set by running the setDomainEnv script file created as part of the Weblogic server installation. A sample modified script to launch Application Explorer is shown below.

The rest of the process consists of the following key steps.

Define Configuration

Create JCA based configuration as opposed to iBSE, which is webservice based and strictly now used for backward compatibility purposes.

Define MySAP Adapter Target

Create the SAP endpoint target providing login credentials and server details.

Identify SAP Repository Object

Connect to remote SAP Repository and identify the object to be used for communication, e,g, BAPI, IDOC, RFC etc.

Export Artifacts to OSB Project

Select object, right-click and export WSDL, XSD and JCA binding information directly to pre-created OSB project.

OSB Design Time - Part 2

Go back to the OSB project created earlier to find the objects exported from Application Explorer. The following few steps complete the build process of the basic OSB project, so that it can be tested from within the OSB console. 

Generate WSDL and Service

Generate WSDL and Service from the JCA Binding exported from Application Explorer and save them in a separate project sub-folder, e.g. BusinessServices.

This service and wsdl can now be further referred to build other proxy services and complex OSB projects. But for our purposes of using the SAP Adapter in OSB, the OSB project is complete and can be tested.

Testing - Run-Time

Without building a fully functional and meaningful OSB project with proper proxy services and pipelines, OSB console provides the capability to quickly test a business service from a test console. This can be compared to the similar capability found within Application Explorer. We will use the OSB test console here to validate the runtime access of SAP data from OSB.

OSB Test Console

Launch the test console by clicking the test icon under Actions category from the service generated earlier. Type in test data and click on Execute.

The response will come back from SAP and the results returned will be displayed in a separate window.

iWay SAP Adapters can thus be very conveniently used to generate services and the JCA binding information directly into an existing OSB project. Furthermore, the OSB test console can be launched to quickly validate the runtime testing of a newly built service with live data from SAP. 


Hi Shub,

It's really quite useful information. Few questions:-

1. Why it's required to do the environment setting in setDomainEnv
2. For SOA suite, do we need to follow the same steps.
3. Do we require to install any patches.


Posted by Himanshu Gupta on April 10, 2012 at 11:33 AM PDT #

Hi Himanshu,
Thanks for the feedback.

Answers to your queries:
1. The Application Explorer requires weblogic/soa specific libraries, which needs to be set in the environment before one starts it up.
2. For SOA Suite, similar patching sequence is necessary. For more details, please refer to the SAP Adapter Installation Guide for SOA Suite.
3. Assuming that you are asking about the SOA Suite patches, only the ones mentioned in the note here are required for the PS3 release.


Posted by Shub on April 11, 2012 at 02:15 AM PDT #

Can you provide me the url to download viewlet demonstrating the usage of SAP Adapter with OSB.

Thank You


Posted by Vijay on April 15, 2012 at 08:59 PM PDT #

hi i am desperately looking for SAP JC03.0.5 adapter , i contacted several groups but no response from others , i am looking for oracle application adapters software free download link or trail version plz
unow i am not able to work with those samples , my humble request how to get those adapters software (includes iwora11g.application.adapters)


Posted by brahma on March 30, 2013 at 09:29 PM PDT #

Hi can any one provide the url to download the viewlet demostration of the usagae of Oracle applicaion adapters that includes and supports the all packages adapters

plz provide the url for that

Posted by brahma on March 30, 2013 at 09:32 PM PDT #

Post a Comment:
  • HTML Syntax: NOT allowed

This is the blog for the Oracle FMW Architects team fondly known as the A-Team. The A-Team is the central, technical, outbound team as part of the FMW Development organization working with Oracle's largest and most important customers. We support Oracle Sales, Consulting and Support when deep technical and architectural help is needed from Oracle Development.
Primarily this blog is tailored for SOA issues (BPEL, OSB, BPM, Adapters, CEP, B2B, JCAP)that are encountered by our team. Expect real solutions to customer problems, encountered during customer engagements.
We will highlight best practices, workarounds, architectural discussions, and discuss topics that are relevant in the SOA technical space today.


« October 2016