How to Connect DBeaver to ADP via a JDBC Driver

The CData JDBC Driver for ADP implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to ADP data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for ADP Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for ADP).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.adp.ADPDriver.
   • Set URL Template to jdbc:adp:.
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.ADP.jar).

Create a Connection to ADP Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for ADP) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   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.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the ADP JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.adp.jar

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123'InitiateOAuth=GETANDREFRESH
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query ADP Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

More Information & Free Trial