This documentation is for WSO2 Enterprise Service Bus version 4.8.0 . View documentation for the latest release.

All docs This doc

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. Download and install WSO2 ESB by following the instruction in Installation Guide.
  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.


    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 jcolibrary to <JDK_HOME>/jre/lib/i386/server.

    Linux 64-bit

    Copy the Linux native SAP jcolibrary to <JDK_HOME>/jre/lib/amd64.


    Copy the Windows native SAP jcolibrary sapjco3.dll to <WINDOWS_HOME>/system32.
  4. Create a directory named sap in the <ESB_HOME>/repository/conf/ directory and provide access rights to read the properties files you will save in it later.

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

    InfoThis directory does not exist by default.ASAPsystem administrator has to create the directory and provide access rights so that you can read the properties files saved in the directory


    • *.dest : This is where we store SAP endpoint parameters when WSO2 ESB is configured as a client to an external SAP endpoint.  
    • *.server : This is where we store SAP endpoint parameters when WSO2 ESB is configured as a server to an external SAP endpoint.
    For details on creating the properties files and defining the relevant properties, see Setting up the Client Configuration File and Setting up the Server Configuration File.
  6. Start the ESB using the -Djava.library.path switch to specify the location of your SAP jco library. 
    For example ./ -Djava.library.path=/usr/lib/jvm/jre1.7.0/lib/i386/server/