SAP Integration

Systems, Applications, and Products (SAP) for data processing is an industry leading enterprise software solution that is widely used among product and process oriented enterprises for finance, operations, HR and many other aspects of a business. SAP ERP solutions provide reliable and efficient platforms to build and integrate enterprise or business-wide data and information systems with ease. 

WSO2 ESB leverages the best of both worlds by providing the integration layer so that an existing SAP R/3 based solutions of an enterprise can be integrated with other data/business oriented systems so that you can mix-and-match requirements with minimal effort. As a result, enterprises can keep parts of their systems independent of SAP and extensible for many other systems, solutions and middleware.

The WSO2 SAP adapter is shipped with WSO2 ESB and is implemented as a transport for WSO2 ESB. This is provided in the <ESB_HOME>/repository/components/plugins directory as org.wso2.carbon.transports.sap-VERSION.jar (e.g. org.wso2.carbon.transports.sap_1.0.0.jar).

The WSO2 SAP adapter has full IDoc and experimental BAPI support. It used the SAP JCO library as the underlying framework to communicate with SAP. This section describes how to set up WSO2 ESB in a SAP environment, how to install the SAP JCo middleware library, SAP Intermediate Document (IDoc) and Business Application Programming Interface (BAPI) adapters.

Installing WSO2 SAP Adapter

Follow the instructions below to install and set up the ESB SAP adapter.

1. Download and install WSO2 ESB by following the instruction in Getting Started.

2. Download the sapidoc3.jar and sapjco3.jar middleware libraries from the SAP support portal and copy those libraries to the <ESB_HOME>/repository/components/lib directory.

   Note

   You need to have SAP login credentials to access the SAP support portal.

3. Download the native SAP JCo library and copy it to the system path. You need to select the system path applicable to your operating system as described below.

   Linux 32-bit	Copy the Linux native SAP jco library libsapjco3.so to <JDK_HOME>/jre/lib/i386/server.
   Linux 64-bit	Copy the Linux native SAP jco library libsapjco3.so to <JDK_HOME>/jre/lib/amd64.
   Windows	Copy the Windows native SAP jco library sapjco3.dll to <WINDOWS_HOME>/system32.

4. Copy the following SAP endpoint property files to the <ESB_HOME>/repository/conf/sap directory. You need to have two property files, one at the server-end and the other at the client-end to communicate with an external SAP endpoint using IDoc or BAPI.

   This directory does not exist by default. A SAP system administrator has to create the directory and provide access rights so that you can read the property files saved in the directory.
   • *.dest : This is where we keep SAP endpoint parameters when WSO2 ESB should act as a client to an external SAP endpoint.  
   • *.server : This is where we keep SAP endpoint parameters when WSO2 ESB should act as a server to an external SAP endpoint.
   For details on creating the property files and defining the relevant properties, see Setting up the *.dest and *.server property files.
5. Start the ESB using the -Djava.library.path switch to specify the location of your SAP jco library.
   For example ./wso2server.sh -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/

Configuring WSO2 SAP Adapter

As mentioned above, the SAP adapter is implemented as a transport for WSO2 ESB. This transport consists of two parts as follows:

• BAPI/RFC adapter
• IDoc adapter

Just like any other transport, you need to enable the BAPI/RFC adapter as well as the IDoc adapter in order to use the SAP adapter.

To enable the BAPI/RFC adapter

• Edit the <ESB_HOME>/repository/conf/axis2/axis2.xml file and uncomment the BAPI sender and listener as follows:

  <transportSender name="bapi" class="org.wso2.carbon.transports.sap.SAPTransportSender"/>
  ...
  <transportReceiver name="bapi" class="org.wso2.carbon.transports.sap.SAPTransportListener"/>

To enable the IDoc adapter

• Edit the <ESB_HOME>/repository/conf/axis2/axis2.xml file and uncomment the IDoc sender and listener as follows:

  <transportSender name=”idoc” class="org.wso2.carbon.transports.sap.SAPTransportSender"/>
  ...
  <transportReceiver name=”idoc” class="org.wso2.carbon.transports.sap.SAPTransportListener"/>

Setting up the *.dest property file

To setup WSO2 ESB as a client to a SAP system you need to create the *.dest property file and define the relevant properties. The following table lists the properties and the description of each property that should be specified in the *.dest property file.

The *.dest property file should be named <SAP-GWHOST>.dest. For example, if the name of your SAP gateway is SAPSYS, the name of the file should be SAPSYS.dest.

Following is a sample configuration for the *.dest property file:

jco.client.client=800
jco.client.user=wso2_user
jco.client.passwd=wso2pass14
jco.client.lang=en
jco.client.ashost=/H/217.116.29.154/S/3299/H/10.100.5.120/S/3200
jco.client.gwserv=3300
jco.client.sysnr=00
jco.client.idle_timeout=300
jco.client.logon=0
jco.client.msserv=3600
jco.client.trace=0
jco.client.getsso2=0
jco.client.r3name=CPT

Setting up the *.server property file

To setup WSO2 ESB as an IDoc server you need to create the *.server property file and define the relevant properties. The following table lists the properties and the description of each property that should be specified in the *.server property file.

This file should be named <SAP-GWHOST>.server. For example, if the name of your SAP gateway is SAPSYS, the name of the file should be SAPSYS.server.

Following is a sample configuration for the *.server property file:

jco.server.gwhost=/H/217.116.29.154/S/3299/H/10.100.5.120/S/3200
jco.server.gwserv=3300
jco.server.progid=IGS.CPT
jco.server.repository_destination=IGS.CPT
jco.server.name=IGS.CPT
jco.server.unicode=1

The table below summarises how you can define a SAP endpoint and a proxy service.

<endpoint name="sapbapiendpoint">
  <address uri="bapi:/JCOCLIENT01"/>
</endpoint>

<proxy name=”sapbapiproxy” transports=”bapi”/>
//in,out,fault Sequence
  <parameter name="transport.sap.serverName">JCOSERVER01</parameter>
// other parameters
</proxy>

<endpoint name="sapidocendpoint">
   <address uri="idoc:/JCOCLIENT01"/>
</endpoint>

<proxy name=”sapidocproxy”transports=”idoc”/>
//in,out,fault Sequence
  <parameter name="transport.sap.serverName">JCOSERVER01</parameter>
// other parameters
</proxy>

Following are descriptions of the proxy level listener parameters that can be defined in a proxy configuration:

Following are descriptions of the SAP client properties that can be defined in the message context with axis2-client scope:

Following is an Axis2 transport sender property that can be defined in axis2.xml: 

transport.sap.customXMLMappers : The key/value list of custom mappers, where the values are fully qualified class names for custom mappers implementing org.wso2.carbon.transports.sap.idoc.IDocXMLMapper.

Troubleshooting

Given below are general troubleshooting guidelines.

• How to handle the Server unknown error

  An example of this error message is as follows:

  [2010-10-25 19:53:00,405] ERROR - DefaultErrorListener Exception occured on :
  JCOSERVER01 and connection : null
  com.sap.conn.jco.JCoException: (129) JCO_ERROR_SERVER_STARTUP: Server startup
  failed at Mon Oct 25 19:53:00 IST 2010.
  This is caused by either a) erroneous server settings, b) the backend system has been shutdown,
  c) network problems. Will try next startup in 1 seconds.
  Could not start server: Connect to SAP gateway failed
  Connect parameters: TPNAME=JCOSERVER01 GWHOST=cynthia GWSERV=sapgw00
  ERROR service 'sapgw00' unknown
  TIME Mon Oct 25 19:53:00 2010
  RELEASE 720
  COMPONENT NI (network interface)
  VERSION 40
  RC -3
  MODULE nixxsl.cpp
  LINE 184
  DETAIL NiSrvLGetServNo: service name cached as unknown
  COUNTER 2
  at com.sap.conn.jco.rt.DefaultServer.openConnection(DefaultServer.java:1168)
  at com.sap.conn.jco.rt.DefaultServer.openConnections(DefaultServer.java:1057)
  at com.sap.conn.jco.rt.DefaultServer.adjustConnectionCount(DefaultServer.java:1004)
  at
  com.sap.conn.jco.rt.DefaultServerManager$DispatcherWorker.run(DefaultServerManager.java:
  299)
  at java.lang.Thread.run(Thread.java:619)
  Caused by: com.sap.conn.jco.JCoException: (129) JCO_ERROR_SERVER_STARTUP: Could
  not start server: Connect to SAP gateway failed
  Connect parameters: TPNAME=JCOSERVER01 GWHOST=cynthia GWSERV=sapgw00
  ERROR service 'sapgw00' unknown
  TIME Mon Oct 25 19:53:00 2010
  RELEASE 720
  COMPONENT NI (network interface)
  VERSION 40
  RC -3
  MODULE nixxsl.cpp
  LINE 184
  DETAIL NiSrvLGetServNo: service name cached as unknown
  COUNTER 2
  at
  com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcServer.accept(MiddlewareJavaRfc.java:2135)
  at com.sap.conn.jco.rt.ServerConnection.accept(ServerConnection.java:380)
  at com.sap.conn.jco.rt.DefaultServer.openConnection(DefaultServer.java:1149)
  © 2012 WSO2
  .. 4 more
  Caused by: RfcException: [null]
  message: Connect to SAP gateway failed
  Connect parameters: TPNAME=JCOSERVER01 GWHOST=cynthia GWSERV=sapgw00
  ERROR service 'sapgw00' unknown
  TIME Mon Oct 25 19:53:00 2010
  RELEASE 720
  COMPONENT NI (network interface)
  VERSION 40
  RC -3
  MODULE nixxsl.cpp
  LINE 184
  DETAIL NiSrvLGetServNo: service name cached as unknown
  COUNTER 2
  Return code: RFC_FAILURE(1)
  error group: 102
  key: RFC_ERROR_COMMUNICATION
  at com.sap.conn.rfc.engine.RfcIoControl.error_end(RfcIoControl.java:255)
  at com.sap.conn.rfc.engine.RfcIoControl.ab_rfcaccept(RfcIoControl.java:43)
  at com.sap.conn.rfc.api.RfcApi.RfcAccept(RfcApi.java:41)
  at
  com.sap.conn.jco.rt.MiddlewareJavaRfc$JavaRfcServer.accept(MiddlewareJavaRfc.java:2121)
  ... 6 more

  The solution to overcome this is to add your SAP server names to the /etc/services file with the relevant ports. For example, the following lines can be added if we consider the example error given above.

  sapgw00 3300/tcp
  sapgw01 3301/tcp