Ready to get started?

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

 Download Now

Learn more:

ADP Icon ADP ODBC Driver

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

Access ADP data like you would a database - read, write, and update ADP FALSE, etc. through a standard ODBC Driver interface.

Build a Simple VCL Application for ADP Data



How to build a simple VCL Application to view ADP data in RAD Studio using the CData ODBC Driver for ADP.

Embarcadero RAD Studio provides a development environment for Delphi and C++Builder applications. With the CData ODBC Driver for ADP, you gain access to live ADP data within RAD Studio, abstracting the data into tables, views, and stored procedures that can be used to retrieve and update ADP data. This article will walk through connecting to ADP and creating a simple VCL application with the Form Designer.

Create a Connection to ADP Data

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:

  • 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. For more information, refer to the OAuth section in the Help documentation.

You can then follow the steps below to use the Data Explorer to create a FireDAC connection to ADP data.

  1. In a new VCL Forms application, expand the FireDAC node in the Data Explorer.
  2. Right-click the ODBC Data Source node in the Data Explorer.
  3. Click Add New Connection.
  4. Enter a name for the connection.
  5. In the FireDAC Connection Editor that appears, set the DataSource property to the name of the ODBC DSN for ADP.

Create VCL Applications with Connectivity to ADP Data

Follow the procedure below to start executing queries to ADP data from a simple VCL application that displays the results of a query in a grid.

  1. Drop a TFDConnection component onto the form and set the following properties:

    • ConnectionDefName: Select the FireDAC connection to ADP data.
    • Connected: Select True from the menu and, in the dialog that appears, enter your credentials.
  2. Drop a TFDQuery component onto the form and set the properties below:

    • Connection: Set this property to the TFDConnection component, if this component is not already specified.
    • SQL: Click the button in the SQL property and enter a query. For example:

      SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'
    • Active: Set this property to true.
  3. Drop a TDataSource component onto the form and set the following property:

    • DataSet: In the menu for this property, select the name of the TFDQuery component.
  4. Drop a TDBGrid control onto the form and set the following property:

    • DataSource: Select the name of the TDataSource.
  5. Drop a TFDGUIxWaitCursor onto the form — this is required to avoid a run-time error.

You now have an executable application that displays the results of the SQL Query set in the TFDQuery object.