Ready to get started?

Learn more about the CData ODBC Driver for Sage 300 or download a free trial:

Download Now

Natively Connect to Sage 300 Data in PHP

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

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

Sage 300 requires some initial setup in order to communicate over the Sage 300 Web API.

  • Set up the security groups for the Sage 300 user. Give the Sage 300 user access to the option under Security Groups (per each module required).
  • Edit both web.config files in the /Online/Web and /Online/WebApi folders; change the key AllowWebApiAccessForAdmin to true. Restart the webAPI app-pool for the settings to take.
  • Once the user access is configured, click https://server/Sage300WebApi/ to ensure access to the web API.

Authenticate to Sage 300 using Basic authentication.

Connect Using Basic Authentication

You must provide values for the following properties to successfully authenticate to Sage 300. Note that the provider reuses the session opened by Sage 300 using cookies. This means that your credentials are used only on the first request to open the session. After that, cookies returned from Sage 300 are used for authentication.

  • Url: Set this to the url of the server hosting Sage 300. Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/{tenant}/ For example, http://localhost/Sage300WebApi/v1.0/-/.
  • User: Set this to the username of your account.
  • Password: Set this to the password of your account.

Establish a Connection

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

$conn = odbc_connect("CData ODBC Sage300 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 Sage300 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 OEInvoices WHERE AllowPartialShipments = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC Sage300 Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM OEInvoices WHERE AllowPartialShipments = ?"); $success = odbc_execute($query, array('Yes'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC Sage300 Source","user","password"); $query = odbc_exec($conn, "SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices WHERE AllowPartialShipments = 'Yes'");

Process Results

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

$conn = odbc_connect("CData ODBC Sage 300 data Source","user","password"); $query = odbc_exec($conn, "SELECT InvoiceUniquifier, ApprovedLimit FROM OEInvoices WHERE AllowPartialShipments = 'Yes'"); while($row = odbc_fetch_array($query)){ echo $row["InvoiceUniquifier"] . "\n"; }

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

$conn = odbc_connect("CData ODBC Sage 300 data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM OEInvoices WHERE AllowPartialShipments = ?"); $success = odbc_execute($query, array('Yes')); 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 Sage 300-specific adaptations of the PHP community documentation for all ODBC functions.