Natively Connect to ADP Data in PHP

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

Connect to ADP by specifying the following properties:

• OAuthClientId: The client Id of the custom OAuth application you obtained from ADP.
• OAuthClientSecret: The custom OAuth application's client secret.
• SSLClientCert: Set this to the certificate provided during registration.
• SSLClientCertPassword: Set this to the password of the certificate.
• UseUAT: The connector makes requests to the production environment by default. If using a developer account, set UseUAT = true.
• RowScanDepth: The maximum number of rows to scan for the custom fields columns available in the table. The default value will be set to 100. Setting a high value may decrease performance.

The connector uses OAuth to authenticate with ADP. OAuth requires the authenticating user to interact with ADP using the browser. OAuth access can be configured in ADP through ADP API Central. For more information, refer ADP's API Central Quick Start Guide and the OAuth section in CData's Help documentation.

Establish a Connection

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

$conn = odbc_connect("CData ODBC ADP 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 ADP 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 Workers WHERE AssociateOID = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC ADP Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Workers WHERE AssociateOID = ?");
$success = odbc_execute($query, array('G3349PZGBADQY8H8'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC ADP Source","user","password");
$query = odbc_exec($conn, "SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'");
 

Process Results

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

$conn = odbc_connect("CData ODBC ADP data Source","user","password");
$query = odbc_exec($conn, "SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'");
while($row = odbc_fetch_array($query)){
 echo $row["AssociateOID"] . "\n";
}

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

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