SAP Java Connector

The SAP Java Connector (SAP JCo) is a development library that enables a Java application to communicate with SAP systems via SAP's RFC protocol. The SAP JCo supports both communication directions: inbound Remote Function Calls (Java calls ABAP) as well as outbound Remote Function Calls (ABAP calls Java).

Benefits of the SAP Java Connector for building SAP-enabled Java applications:

  • High performance JNI-based RFC middleware.
  • Supports R/3 3.1I and higher releases (and other SAP components that have BAPIs or RFMs).
  • Supports inbound (Java client calls BAPI or RFM) and outbound (ABAP calls Java server) RFC communication.
  • Supports synchronous, transactional, queued and background RFC (sRfc, tRfc, qRfc, bgRfc protocols).
  • Supports classic RFC data serialization as well as xRfc, basXML and cbRfc (column based/fast serialization) formats.
  • Supports RFC communication via classic CPIC and via WebSocket network protocol.
  • Provides client connection pooling.
  • Multi-platform support.
  • Complete and correct code page handling (including Unicode and non-Unicode single- and multi-byte code pages).

In case of problems with the SAP Java Connector, create a support case under component BC-MID-CON-JCO.

Download SAP Java Connector 3.1 SDK

Release 3.1.10 of the SAP Java Connector includes fixes and new functionality as described in SAP Note 3481535. It also contains all fixes and enhancements of previous patch releases: 3446411, 3347894, 3276799, 3204567, 3115707, 3036882 and 2947370.

SAP Note 2786882 describes which operating systems and versions with which JDKs/JREs are supported by the SAP Java Connector 3.1, and when the SAP Java Connector 3.1 maintenance and support period will end.

The SDK package of SAP Java Connector 3.1 includes the software, documentation, and examples. The SAP Java Connector 3.1 requires a JDK/JRE 8, 11, 17, or 21. SAP Java Connector 3.1 running on Windows operating systems requires the Microsoft Visual Studio 2015-2022 C/C++ runtime libraries to be installed on the system. See SAP Note 2786882.

Notes

  • The SDK archives for Windows and macOS of the SAP Java Connector are shipped as a ZIP file embedded in a ZIP file.
    The SDK archives for the Unix versions of the SAP Java Connector are shipped as a TGZ file embedded in a ZIP file.
  • Extract the nested archive variant from the downloaded archive first. In case you have installation instructions from some other component, they usually refer to the nested archive.
  • After extracting the content from the nested archive, further installation instructions can be found in the file <instDir>/javadoc/installation.html.

Note on 32-bit versus 64-bit versions:
You only need the 64-bit version of the SAP Java Connector if you are using a 64-bit Java VM. If you have to use a 32-bit Java VM on a 64-bit platform, download and use the 32-bit version of JCo. The 64-bit variant should always be preferred on 64-bit platforms.
Some JVMs offer both modes: 32-bit as well as 64-bit. In this case you need to start the JVM with an additional start-up parameter to specify the mode. Usually these are options -d32 and -d64; please consult the JVM documentation for further details.

Operating systemProcessorSDK versionRelease dateFile size (KB)
Microsoft Windows and Windows Server32-bit
3.1.10
June 21, 20246,156
64-bit x86*3.1.10June 21, 20246,502
Linux for AArch64 compatible processors64-bit ARM3.1.10June 21, 20244,283
Linux for Intel compatible processors64-bit x86*3.1.10June 21, 20244,340
Linux for IBM PowerPC processors64-bit LE**
3.1.10
June 21, 20244,521
Linux for IBM eServer zSeries64-bit3.1.10June 21, 20244,477
Apple macOS
64-bit ARM3.1.10June 21, 20244,379
64-bit x86*3.1.10June 21, 20244,556
HP-UX64-bit Itanium3.1.10June 21, 20247,254
IBM AIX64-bit3.1.10June 21, 20245,315
IBM i (OS/400 PASE)64-bit3.1.10June 21, 202419,748
IBM z/OS64-bit3.1.10June 21, 20244,626
Oracle Solaris (SunOS)64-bit SPARC3.1.10June 21, 20246,010
64-bit x86*3.1.10June 21, 20245,447

* "64-bit x86" refers to Intel EM64T and AMD64 processors.
** "64-bit LE" refers to IBM PowerPC 64-bit processors running in little-endian mode.

In case of problems with the SAP Java Connector, create a support case under component BC-MID-CON-JCO.

Documentation

TypeDescriptionLanguageRelease dateFile size (KB)
DocumentationDescribes the programming model of the JCo 3.1 standalone version and the Java IDoc Library 3.1 add-on.EnglishOctober 31, 20192,533
DocumentationDescribes the programming model of the JCo 3.0 standalone version and the Java IDoc Library 3.0 add-on.
EnglishApril 15, 2013329
DokumentationBeschreibt das Programmiermodell der JCo 3.0 Standalone-Version und der Java IDoc-Bibliothek 3.0-Erweiterung.DeutschApril 15, 2013335
Migration GuideOutlines how to migrate a Java application from using an older JCo version 2.x to use version 3.0.EnglishAugust 8, 2011100
MigrationsleitfadenFührt aus, wie man eine Java-Anwendung von der Verwendung einer älteren JCo Version 2.x zur Verwendung der Version 3.0 überführt.
DeutschAugust 8, 2011114

SAP Java IDoc Library

The SAP Java IDoc Library (SAP JIDocLib) is an add-on library for the SAP Java Connector (SAP JCo). It provides an easy-to-use API for sending and receiving IDocs and IDoc packages to and from SAP systems. The API also helps interpreting and navigating through IDocs and modifying them or creating new ones. In addition, it provides a processing feature for parsing and rendering IDoc-XML documents.

Notes:

  • The SAP Java IDoc Library 3.1.3 requires the SAP Java Connector 3.1.7 or higher and a JDK/JRE 8, 11 or 17. For installation instructions read the <instDir>/idoclibdoc/installation.html page included in the SDK download archive. For details about the contained fixes and enhancements read the <instDir>/idoclibdoc/releasenotes.html page which is also included therein.
  • Versions 3.x of the Java IDoc Library have changed incompatibly compared to the previous versions 1.x. For adjusting existing JIDocLib 1.x application code to use the new version 3.1 please see the Migration Guide (PDF file).

Download SAP Java IDoc Library 3.1.3 SDK

March 2, 2023, 624 KB, ZIP file (incl. library, documentation and examples)

Frequently Asked Questions

The SAP Java Connector (SAP JCo) is a development library that enables a Java application to communicate with SAP systems via SAP's RFC protocol. It combines an easy-to-use API with unprecedented flexibility and performance. The SAP JCo supports both communication directions: inbound Remote Function Calls (Java calls ABAP) as well as outbound Remote Function Calls (ABAP calls Java).

The SAP Java IDoc Library (SAP JIDocLib) is an add-on library for the SAP Java Connector (SAP JCo). It provides an easy-to-use API for sending and receiving IDocs and IDoc packages to and from SAP systems. The API also helps interpreting and navigating through IDocs and modifying them or creating new ones. In addition, it provides a processing feature for parsing and rendering IDoc-XML documents.

Yes. All usage in front of any SAP software is covered.

The SAP .NET Connector is based on Microsoft .NET. This connector offers developers the possibility to expose BAPIs and remote enabled function modules to any .NET application (inbound communication). It is also possible to access .NET components from an on-premise SAP system (outbound communication).

The SAP Java Connector employs standards-based information exchange between SAP and a Java application. Additionally, the SAP Java Connector together with the SAP Java IDoc Library offer high level support for IDocs.

SAP Java Connector appears to an SAP system as an RFC destination. To direct a BAPI or IDoc call to SAP Java Connector, you simply use this destination. To incorporate external data or services into your SAP system, you create a Java application, which defines the interface to the data, and call the implementation.

The communication between SAP Java Connector and an SAP system can be secured via Secure Network Communication (SNC). For this you need the SAP Common Cryptographic Library. More information about security including the required configuration in the SAP System and how to obtain the SAP Cryptographic Library can be found in the SAP Software Download Center. Information about the necessary configuration within SAP Java Connector can be found in the JavaDoc of the SAP Java Connector SDK.

See SAP Note 2786882 describing which operating systems and versions with which JDKs/JREs are supported by the SAP Java Connector, and when the SAP Java Connector maintenance and support period will end. Furthermore, it is recommended to have at least 256 MB physical memory on your hardware.

Updates happen by installing a new version over an older version. See also the installation instructions included in the JCo SDK download archive. In general, a new SAP Java Connector patch level is downwards compatible to the previous patch levels of the same release.

Installation is painless and done in a matter of minutes. Unzip the installation file into an arbitrary directory and follow the installation instructions about adjusting the PATH/LIBPATH and CLASSPATH environment variables. Besides a JDK or JRE, no additional software is required.

Configuration is rapid and straight forward and usually a matter of days for a trained person. Practical experience with Java Programming plus basic knowledge of SAP technology, e. g. BAPI or IDoc, is essential. For error tracking, RFC and tRfc knowledge is helpful. As for ALE, SAP JCo is a transparent transport layer, so SAP JCo itself does not require ALE knowledge.

No.

The license terms are explained on the Connectors homepage.

The SAP Java Connector (JCo) and the SAP Java IDoc Library (JIDocLib) are available free of charge and can be downloaded from the SAP Support Portal. The license terms are pointed out on the download pages and in the documentation of these components.

If you have existing developer licenses, these named persons already have the required license to develop solutions based on the SAP Java Connector. If additional persons want to develop based on the SAP Java Connector, you will have to acquire additional developers licenses for them.

The runtime does not require any immediate license fees. However, please note that each user accessing application functionality through the SAP Java Connector is required to be licensed under a respective solution or component license.

To obtain the necessary licenses, please contact your local SAP Office.

Yes. Redistribution is not allowed. Please see the license terms on the download page.

SAP customers get full support and service from SAP. This support is provided via the SAP Support Portal.