Ready to get started?

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

 Download Now

Learn more:

SAP ByDesign Icon SAP ByDesign ODBC Driver

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

Access SAP ByDesign data like you would a database - read, write, and update SAP ByDesign Customers, Products, Leads, Suppliers, etc. through a standard ODBC Driver interface.

Natively Connect to SAP ByDesign Data in PHP



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

Drop the CData ODBC Driver for SAP ByDesign into your LAMP or WAMP stack to build SAP ByDesign-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to SAP ByDesign 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.

Set the following connection properties to connect to SAP ByDesign.

  • Url: Set this to the Url of your SAP ByDesign site. For example, https://test.sapbydesign.com
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.
  • CustomService or AnalyticsService: Only one of these must be specified. If you have a custom service you want to retrieve data from, specify CustomService. If you want to retrieve the reports of a analytical service, specify AnalyticsService.
    If neither is specified, 'cc_home_analytics.svc' will used as a default for the AnalyticsService property. If you are not sure what service to specify, you can always query the Services view to list available services.

Establish a Connection

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

$conn = odbc_connect("CData ODBC SAPByDesign 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 SAPByDesign 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 [Inventory Balance] WHERE ProductCategoryID = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC SAPByDesign Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM [Inventory Balance] WHERE ProductCategoryID = ?"); $success = odbc_execute($query, array('1234567'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC SAPByDesign Source","user","password"); $query = odbc_exec($conn, "SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'");

Process Results

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

$conn = odbc_connect("CData ODBC SAP ByDesign data Source","user","password"); $query = odbc_exec($conn, "SELECT ID, ProductCategoryID FROM [Inventory Balance] WHERE ProductCategoryID = '1234567'"); while($row = odbc_fetch_array($query)){ echo $row["ID"] . "\n"; }

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

$conn = odbc_connect("CData ODBC SAP ByDesign data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM [Inventory Balance] WHERE ProductCategoryID = ?"); $success = odbc_execute($query, array('1234567')); 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 ByDesign-specific adaptations of the PHP community documentation for all ODBC functions.