Ready to get started?

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

 Download Now

Learn more:

SAP Netweaver Gateway Icon SAP Netweaver Gateway ODBC Driver

The SAP Netweaver Gateway ODBC Driver is a powerful tool that allows you to connect with live data from SAP Netweaver Gateway, directly from any applications that support ODBC connectivity.

Access SAP Netweaver Gateway data like you would a database - read, write, and update SAP Netweaver Gateway Entities, etc. through a standard ODBC Driver interface.

Access SAP Netweaver Gateway Data as a Remote Oracle Database



Use the Oracle ODBC Gateway and Heterogeneous Services technology to access SAP Netweaver Gateway data from your Oracle system.

The Oracle Database Gateway for ODBC and Heterogeneous Services technology enable you to connect to ODBC data sources as remote Oracle databases. This article shows how to use the CData ODBC Driver for SAP Netweaver Gateway to create a database link from SAP Netweaver Gateway to Oracle and to query SAP Netweaver Gateway data through the SQL*Plus tool. You can also create the database link and execute queries from SQL Developer.

Connect to SAP Netweaver Gateway as an ODBC Data Source

Information for connecting to SAP Netweaver Gateway follows, along with different instructions for configuring a DSN in Windows and Linux environments.

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.

Windows

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

Note: If you need to modify the DSN or create other SAP Netweaver Gateway DSNs, you must use a system DSN and the bitness of the DSN must match your Oracle system. You can access and create 32-bit DSNs on a 64-bit system by opening the 32-bit ODBC Data Source Administrator from C:\Windows\SysWOW64\odbcad32.exe.

Linux

If you are installing the CData ODBC Driver for SAP Netweaver Gateway in a Linux environment, the driver installation predefines a system DSN. You can modify the DSN by editing the system data sources file (/etc/odbc.ini) and defining the required connection properties.

/etc/odbc.ini

[CData SAPGateway Source] Driver = CData ODBC Driver for SAP Netweaver Gateway Description = My Description User = user Password = password URL = https://sapes5.sapdevcenter.com/sap/opu/odata/IWBEP/GWSAMPLE_BASIC/

For specific information on using these configuration files, please refer to the help documentation (installed and found online).

Set Connection Properties for Compatibility with Oracle

The driver provides several connection properties that streamline accessing SAP Netweaver Gateway data just as you would an Oracle database. Set the following properties when working with SAP Netweaver Gateway data in SQL*Plus and SQL Developer. For compatibility with Oracle, you will need to set the following connection properties, in addition to authentication and other required connection properties.

  • MapToWVarchar=False

    Set this property to map string data types to SQL_VARCHAR instead of SQL_WVARCHAR. By default, the driver uses SQL_WVARCHAR to accommodate various international character sets. You can use this property to avoid the ORA-28528 Heterogeneous Services data type conversion error when the Unicode type is returned.

  • MaximumColumnSize=4000

    Set this property to restrict the maximum column size to 4000 characters.

  • IncludeDualTable=True

    Set this property to mock the Oracle DUAL table. SQL Developer uses this table to test the connection.

Linux Configuration

In Linux environments, Oracle uses UTF-8 to communicate with the unixODBC Driver manager, whereas the default driver encoding is UTF-16. To resolve this, open the file /opt/cdata/cdata-driver-for-sapgateway/lib/cdata.odbc.sapgateway.ini in a text editor and set the encoding.

cdata.odbc.sapgateway.ini

[Driver] DriverManagerEncoding = UTF-8

Configure the ODBC Gateway, Oracle Net, and Oracle Database

Follow the procedure below to set up an ODBC gateway to SAP Netweaver Gateway data that enables you to query live SAP Netweaver Gateway data as an Oracle database.

  1. Create the file initmysapgatewaydb.ora in the folder oracle-home-directory/hs/admin and add the following setting:

    initmysapgatewaydb.ora

    HS_FDS_CONNECT_INFO = "CData SAPGateway Sys"
  2. Add an entry to the listener.ora file. This file is located in oracle-home-directory/NETWORK/admin.

    If you are using the Database Gateway for ODBC, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysapgatewaydb) (ORACLE_HOME = your-oracle-home) (PROGRAM = dg4odbc) ) )

    If you are using Heterogeneous Services, your listener.ora needs to have a SID_LIST_LISTENER entry that resembles the following:

    listener.ora

    SID_LIST_LISTENER = (SID_LIST = (SID_DESC = (SID_NAME = mysapgatewaydb) (ORACLE_HOME = your-oracle-home) (PROGRAM = hsodbc) ) )
  3. Add the connect descriptor below in tnsnames.ora, located in oracle-home-directory/NETWORK/admin:

    tnsnames.ora

    mysapgatewaydb = (DESCRIPTION= (ADDRESS=(PROTOCOL=tcp)(HOST=localhost)(PORT=1521)) (CONNECT_DATA=(SID=mysapgatewaydb)) (HS=OK) )
  4. Restart the listener.
  5. Test the configuration with the following command:

    tnsping mysapgatewaydb
  6. Open SQL*Plus and create the database link with the command below:

    CREATE DATABASE LINK mysapgatewaydb CONNECT TO "user" IDENTIFIED BY "password" USING 'mysapgatewaydb';

You can now execute queries in SQL*Plus like the one below (note the double quotation marks around the table name):

SELECT * from "SalesOrderLineItems"@mysapgatewaydb WHERE Quantity = '15';