SAP BAPI connection

Use the SAP BAPI connection to extract or load data from or into an SAP data repository.

The Business Application Programming Interface (BAPI) is a standard SAP interface that integrates with SAP application systems. This connection is available for the DataStage service only.

Supported SAP applications

You can use the Unicode installations of these SAP applications:

  • SAP ERP 6.0 EHP6, EHP7 & EHP8
  • S/4 HANA 2020, S/4 HANA 2021, S/4 HANA 2022, S/4 HANA 2023

Prerequisites

The SAP BAPI connection requires two sets of libraries, which you can find at the SAP Marketplace.

  • To create the connection, you need the JAR file sapjco3.jar and libsapjco3.so. See Importing JDBC drivers in the IBM Software Hub documentation for the procedure and required permissions to upload the JAR file to Cloud Pak for Data. Important: By default, uploading JDBC driver files is disabled and users cannot view the list of JDBC drivers in the web client. An administrator must enable users to upload or view JDBC drivers in the IBM Software Hub documentation.
  • The runtime requires the NWRFCSDK libraries libsapnwrfc.so and libsapucum.so. See Handling NWRFCSDK dependencies for BAPI connector for the procedure and required permissions to upload the NWRFCSDK dependency libraries to Cloud Pak for Data.

To enable the Secure Network Communications (SNC) configuration, download the SAP cryptographic library (SPACRYPTOLIB.SAR). For instructions, see Configuring SNC settings.

Create a connection to SAP BAPI

To create the connection asset, you need these connection details:

Jar URIs: Upload or select the JAR files for the SAP Java Connector (SAP JCo).

SAP connector

Select an SAP connector. Each connector has unique properties.

Application Server

  • Application server: Hostname or IP address of the SAP application server.
  • System Number: SAP Application server system number.
  • SAP Router (optional): The router string to connect to a remote SAP Application server. If you use an SAP router to access your system, you must include a fully qualified node name for your RFC server in the SAP router table. The SAP Router value consists of an IP address and port number that describes the stations of a connection that is required between two hosts. Syntax: (/H/host/S/Service/W/pass).
  • Namespace for custom BAPI objects (optional): Use this field as a qualifier to search for a specific BAPI, rather than browsing for all available BAPI objects in the Asset browser. For example, to view a list of all BAPI objects under the '/IBMLIST' namespace enter '/IBMLIST'. An empty value prevents all BAPI objects in any namespace from being listed in the Asset browser.

 

Load Balancing

  • Message Server: Message server name.
  • Select Use System Number to use the system number for the Message server, and then enter the value for the system number. Otherwise, enter the value for the System ID.
  • Group: Logon group for the Message server.
  • SAP Router (optional): The router string to connect to a remote SAP Application server. If you use an SAP router to access your system, you must include a fully qualified node name for your RFC server in the SAP router table. The SAP Router value consists of an IP address and port number that describes the stations of a connection required between two hosts. Syntax: /H/host/S/Service/W/pass.
  • Namespace for custom BAPI objects (optional): Use this field as a qualifier to search for a specific BAPI, rather than browsing for all available BAPI objects in the Asset browser. For example, to view a list of all BAPI objects under the '/IBMLIST' namespace enter '/IBMLIST'. An empty value prevents all BAPI objects in any namespace from being listed in the Asset browser.

 

SNC Application Server

  • Application server: Hostname or IP address of the SAP application server that is running SAP R/3.
  • System Number: SAP Application server system number.
  • SAP Router (optional): The router string to connect to a remote SAP Application server. If you use an SAP router to access your system, you must include a fully qualified node name for your RFC server in the SAP router table. The SAP Router value consists of an IP address and port number that describes the stations of a connection required between two hosts. Syntax: /H/host/S/Service/W/pass.
  • SNC Name (optional): The Personal Security Environment (PSE) certificate name that is generated on the client for the partner server. The default length is 256 characters.
  • SNC Partner Name: The Personal Security Environment (PSE) certificate name that is generated on the SAP server. The default length is 256 characters.
  • SNC QOP: Specifies the quality of protection for the SNC connection:
    • 1: Apply authentication only.
    • 2: Apply authentication and integrity protection. This is the default setting.
    • 3: Apply authentication, integrity, and privacy protection (encryption).
    • 8: Fall back to the global default protection (usually the SNC QOP setting 3).
    • 9: Apply maximum protection.
  • Namespace for custom BAPI objects (optional): Use this field as a qualifier to search for a specific BAPI, rather than browsing for all available BAPI objects in the Asset browser. For example, to view a list of all BAPI objects under the '/IBMLIST' namespace enter '/IBMLIST'. An empty value prevents all BAPI objects in any namespace from being listed in the Asset browser.

 

SNC Load Balancing

  • Message Server: Message server name.
  • Select Use System Number to use the system number for the Message server, and then enter the value for the system number. Otherwise, enter the value for the System ID.
  • Group: Logon group for the Message server.
  • SAP Router (optional): The router string to connect to a remote SAP Application server. If you use an SAP router to access your system, you must include a fully qualified node name for your RFC server in the SAP router table. The SAP Router value consists of an IP address and port number that describes the stations of a connection required between two hosts. Syntax: /H/host/S/Service/W/pass.
  • SNC Name (optional): The Personal Security Environment (PSE) certificate name that is generated on the client for the partner server. The default length is 256 characters.
  • SNC Partner Name: The Personal Security Environment (PSE) certificate name that is generated on the SAP server. The default length is 256 characters.
  • SNC QOP: Specifies the quality of protection for the SNC connection:
    • 1: Apply authentication only.
    • 2: Apply authentication and integrity protection. This is the default setting.
    • 3: Apply authentication, integrity, and privacy protection (encryption).
    • 8: Fall back to the global default protection (usually the SNC QOP setting 3).
    • 9: Apply maximum protection.
  • Namespace for custom BAPI objects (optional): Use this field as a qualifier to search for a specific BAPI, rather than browsing for all available BAPI objects in the Asset browser. For example, to view a list of all BAPI objects under the '/IBMLIST' namespace enter '/IBMLIST'. An empty value prevents all BAPI objects in any namespace from being listed in the Asset browser.

Credentials

For the SNC Application Server or the SNC Load Balancing connector, select Enable X.509 Certificate and enter the certificate to run SNC with the X.509 certificate.

Otherwise, for if you do not use an X.509 Certificate or you connect with the SNC Application Server or the SNC Load Balancing connector, enter the SAP Username and associated SAP password to connect to the SAP server.

  • Client Number: The SAP client number.
  • Language: The ISO two-letter language code for connecting to SAP. For example, en for English.

Choose the method for creating a connection based on where you are in the platform

In a project
Click Assets > New asset > Prepare data > Connect to a data source. See Adding a connection to a project.

In a deployment space
Click Import assets > Data access > Connection. See Adding data assets to a deployment space.

In the Platform assets catalog
Click New connection. See Adding platform connections.

Next step: Add data assets from the connection

Federal Information Processing Standards (FIPS) compliance

This connection can be used on a FIPS-enabled cluster (FIPS tolerant); however, it is not FIPS-compliant.

Creating a DataStage flow with data from the SAP BAPI connector

For instructions and restrictions, see Flow creation for BAPI connector.

Migrating from the traditional DataStage BAPI Stage connector

For migration information and a feature comparison with the BAPI Stage connector from traditional DataStage, see SAP Pack BAPI Stage vs Cloud Pak for Data (CP4D) SAP BAPI Connector.

Learn more

Business Application Programming Interface (BAPI)

Parent topic: Supported connections