Connect to ADP Data in DBeaver

The CData ODBC Driver for ADP enables access to live data from ADP under the ODBC standard, allowing you work with ADP data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to manage ADP data with visual tools in DBeaver like the query browser.

The CData ODBC drivers offer unmatched performance for interacting with live ADP data in DBeaver due to optimized data processing built into the driver. When you issue complex SQL queries from DBeaver to ADP, the driver pushes supported SQL operations, like filters and aggregations, directly to ADP and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can manage and analyze ADP data.

Connect to ADP

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the Microsoft ODBC Data Source Administrator. This is also the last step of the driver installation. See the "Getting Started" chapter in the Help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Finally, set the "Map To WVarchar connection property to False in the DSN Configuration window for the driver. This configuration will allow string types to be mapped to SQL_VARCHAR and prevent SQL_WVARCHAR types from being displayed as NULL.

Connecting to the ADP ODBC Data Source in DBeaver

1. Open the DBeaver application and in the Database menu, select the New Database Connection option. 👁 Creating a new Database Connection
   
2. In the 'Connect to a database' window, select ODBC and click Next. 👁 Creating a new Database Connection
   
3. In the Database/Schema field, enter the DSN name (CData ADP Source by default). It will be automatically added to the JDBC URL as well.
4. Click the Test Connection button. You should receive a 'Connected' message after DBeaver has detected the DSN, along with details about the driver if the connection is successful. 👁 Successfully tested connection
   

Query ADP Data

You can now query information from the tables exposed by the data source connection. You can expand the database structure in order to view all the tables. You can retrieve the table's data by right-clicking on a table name and selecting View data. The data will then be available in the Data tab.

Free Trial & More Information

At this point, you have connected to live ADP data from DBeaver. For more information, visit the CData ODBC Driver page. Download a free, 30-day trial and start working live ADP data DBeaver today.