Natively Connect to Epicor Kinetic Data in PHP

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

To successfully connect to your ERP instance, you must specify the following connection properties:

• Url:the URL of the server hosting your ERP instance. For example, https://myserver.EpicorSaaS.com
• ERPInstance: the name of your ERP instance.
• User: the username of your account.
• Password: the password of your account.
• Service: the service you want to retrieve data from. For example, BaqSvc.

In addition, you may also set the optional connection properties:

• ApiKey: An optional key that may be required for connection to some services depending on your account configuration.
• ApiVersion: Defaults to v1. May be set to v2 to use the newer Epicor API.
• Company: Required if you set the ApiVersion to v2.

Establish a Connection

Open the connection to Epicor Kinetic by calling the or methods. To close connections, use or .

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

Connections opened with are closed when the script ends. Connections opened with the 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 EpicorERP Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE CompanyName = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC EpicorERP Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Customers WHERE CompanyName = ?");
$success = odbc_execute($query, array('CompanyName'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC EpicorERP Source","user","password");
$query = odbc_exec($conn, "SELECT CustNum, Company FROM Customers WHERE CompanyName = 'CompanyName'");
 

Process Results

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

$conn = odbc_connect("CData ODBC Epicor Kinetic data Source","user","password");
$query = odbc_exec($conn, "SELECT CustNum, Company FROM Customers WHERE CompanyName = 'CompanyName'");
while($row = odbc_fetch_array($query)){
 echo $row["CustNum"] . "\n";
}

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

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