Connect to ADP Data in Aqua Data Studio

The CData JDBC Driver for ADP integrates ADP data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to ADP data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The ADP data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, ADP.
   • Driver Location: Click the Browse button and select the cdata.jdbc.adp.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.adp.ADPDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:adp: and is followed by a semicolon-separated list of connection properties.

     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.

     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.

     A typical JDBC URL is below:
     jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123'InitiateOAuth=GETANDREFRESH

Query ADP Data

You can now query the tables exposed.