Ready to get started?

Learn more about the CData JDBC Driver for SAP Netweaver Gateway or download a free trial:

Download Now

Connect to SAP Netweaver Gateway Data in DBVisualizer

Integrate SAP Netweaver Gateway data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for SAP Netweaver Gateway implements JDBC standards to provide connectivity to SAP Netweaver Gateway data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to SAP Netweaver Gateway data in DBVisualizer and use the table editor to edit and save SAP Netweaver Gateway data.

Create a New JDBC Data Source for SAP Netweaver Gateway Data

Follow the steps below to use the Driver Manager to provide connectivity to SAP Netweaver Gateway data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:sapgateway:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.sapgateway.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the SAPGatewayDriver class, cdata.jdbc.sapgateway.SAPGatewayDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:sapgateway: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:sapgateway:User=user;Password=password;URL=https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/;InitiateOAuth=GETANDREFRESH
    • Database UserId: The username to use to authenticate to SAP Netweaver Gateway.
    • Database Password: The password to use to authenticate to SAP Netweaver Gateway.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the SAP Netweaver Gateway JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.