Ready to get started?

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

Download Now

Natively Connect to SAP Netweaver Gateway Data in PHP

The CData ODBC driver for SAP Netweaver Gateway enables you to create PHP applications with connectivity to SAP Netweaver Gateway data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for SAP Netweaver Gateway into your LAMP or WAMP stack to build SAP Netweaver Gateway-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to SAP Netweaver Gateway data, execute queries, and output the results.

Configure a DSN

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.

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.

Establish a Connection

Open the connection to SAP Netweaver Gateway by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC SAPGateway Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC SAPGateway Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM SalesOrderLineItems WHERE Quantity = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC SAPGateway Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM SalesOrderLineItems WHERE Quantity = ?"); $success = odbc_execute($query, array('15'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC SAPGateway Source","user","password"); $query = odbc_exec($conn, "SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC SAP Netweaver Gateway data Source","user","password"); $query = odbc_exec($conn, "SELECT ProductID, Quantity FROM SalesOrderLineItems WHERE Quantity < 15"); while($row = odbc_fetch_array($query)){ echo $row["ProductID"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC SAP Netweaver Gateway data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM SalesOrderLineItems WHERE Quantity = ?"); $success = odbc_execute($query, array('15')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are SAP Netweaver Gateway-specific adaptations of the PHP community documentation for all ODBC functions.