Ready to get started?

Download a free trial of the SAP Netweaver Gateway Driver to get started:

 Download Now

Learn more:

SAP Netweaver Gateway Icon SAP Netweaver Gateway JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with SAP Netweaver Gateway.

Connect to SAP Netweaver Gateway from a Connection Pool in WebLogic



Use the CData JDBC Driver for SAP Netweaver Gateway to connect to SAP Netweaver Gateway data from Web applications running on WebLogic.

The CData JDBC Driver for SAP Netweaver Gateway enables you to follow standard procedures to integrate SAP Netweaver Gateway data into Java Web applications. This article shows how to deploy the CData JDBC Driver for SAP Netweaver Gateway in WebLogic Server.

Deploy the JDBC Driver in WebLogic Server

To deploy the driver, add the driver JAR to your classpath. The .lic file must be located in the same folder as the JAR. These files are located in the lib subfolder of the installation directory.

If you want to add the driver to all domains, prepend the path to the JAR to the WEBLOGIC_CLASSPATH environment variable in WL_HOME\common\bin\commEnv.cmd/sh. This script is located in WL_HOME\common\bin\. For example:

set WEBLOGIC_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sapgateway.jar;%WEBLOGIC_CLASSPATH%

In WebLogic 12.2.1 if you want to add the driver to a specific domain, you can simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

Earlier versions require that you manually add the driver to the classpath: Prepend the following to the PRE_CLASSPATH environment variable in setDomainEnv.cmd/sh. This script is located in the bin subfolder of the folder for that domain.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.sapgateway.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for SAP Netweaver Gateway

After deploying the driver, log into the WebLogic Administration Console and create the connection.

  1. In the Domain Structure tree, click Services -> Data Sources -> New -> Generic Data Source.
  2. On the JDBC Data Source Properties page, enter the following information:
    • Name: Enter a user-friendly name; for example, sapgatewayjdbc.
    • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/SAPGateway.
    • Database Type: Select Other.

  3. Click Next to use the default options. On the last page, enter the following information and click Test Configuration:

    • Driver Class Name: Enter the driver class, cdata.jdbc.sapgateway.SAPGatewayDriver.
    • URL: Enter the JDBC URL. A typical JDBC URL is below:

      jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH

      SAP Gateway allows both basic and OAuth 2.0 authentication. You can use basic authentication to connect to your own account, or you can use OAuth to enable other users to retrieve data from your service with their accounts. In addition to authenticating, set the following connection properties to access SAP Gateway tables.

      • Url: Set this to the URL of your environment, or to the full URL of the service. For example, the full URL might appear as: https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/. In this example, the environment URL would just be: https://sapes5.sapdevcenter.com.
      • Namespace: Set the appropriate Service Namespace. In the example above, IWBEP is the namespace. It is optional if the full URL to the service is specified.
      • Service: Set this to the service you want to retrieve data from. In the example above, the service is GWSAMPLE_BASIC. It is not required if the full URL is specified.

      Authenticate via Basic Authentication

      In basic authentication, you use your login credentials to connect. Set the following properties:

      • User: This is the username you use to log in to SAP Gateway.
      • Password: This is the password you use to log in to SAP Gateway.

      Authenticate via OAuth Authentication

      You can connect to SAP Gateway using the embedded OAuth connectivity (without setting any additional authentication connection properties). When you connect, the OAuth endpoint opens in your browser. Log in and grant permissions to complete the OAuth process. See the OAuth section in the online Help documentation for more information on other OAuth authentication flows.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the SAP Netweaver Gateway JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.sapgateway.jar

      Fill in the connection properties and copy the connection string to the clipboard.

    • Database User Name: Enter the username, if not specified in the JDBC URL.
    • Password: Enter the password, if not specified in the JDBC URL.

After selecting the server where you want to deploy the JDBC data source, you can now connect to SAP Netweaver Gateway data.

More WebLogic Integration

The steps above show how configure the driver in a simple connection pooling scenario. For more use cases and information, see the JDBC sections in the WebLogic Data Sources chapter of the Oracle Fusion Middleware documentation.