We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Import Real-Time ADP Data in ColdFusion to Build Applications
Use CData JDBC drivers to import and use ADP data in ColdFusion.
Adobe ColdFusion is a web and mobile application development platform. It uses its own scripting language, ColdFusion Markup Language (CFML), to create data-driven websites as well as generate remote services, such as REST.
When ColdFusion is paired with the CData JDBC Driver for ADP, you can link your ColdFusion web and mobile applications to operational ADP data. This allows for your applications to be more robust and complete. This article details how to use the JDBC driver to create a table populated with ADP data from within a ColdFusion markup file.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live ADP data. When you issue complex SQL queries 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 client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze ADP data using native data types.
Configuring the Connection to ADP
You will need a JDBC connection string to establish a connection between Coldfusion and ADP.
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
Adding a Data Source and Creating a Table
After configuring the connection, follow the steps below to add the CData JDBC Driver to ColdFusion's lib directory, add a new data source, test the connection, create a ColdFusion markup file, and, finally, make a real-time connection with ADP data and display it in a table written in the ColdFusion Markup Language, or CFML:
-
Copy the JDBC Driver for ADP and lic file from "C:\Program Files\CData[product_name]\lib" to
"C:\ColdFusion2021\cfusion\wwwroot\WEB-INF\lib".
cdata.jdbc.adp.jar cdata.jdbc.adp.lic
Note: If you do not copy the .lic file with the jar, you will see a licensing error that indicates you do not have a valid license installed. This is true for both the trial and full versions.
- From the ColdFusion administrator interface, choose Data & Services.
- Here, we can "Add New Data Source". The data source name can be any name, provided it conforms to the ColdFusion variable naming conventions. For our JDBC driver, choose "other", then click the "Add" button.
-
Next, populate the driver properties.
- JDBC URL will need to be in the format: jdbc:adp:|connectionString|.
- A typical connection string looks like this:
jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123'InitiateOAuth=GETANDREFRESH
- The Driver Class is: cdata.jdbc.adp.ADPDriver
- The Driver Name is arbitrary and simply used to recognize the data source in the ColdFusion administration console.
- Now, test the connection by clicking the check mark to the left of the CDataADPJDBC data source you just created. When the data source reports an "OK" status, it is ready for use.
-
Next, create a new ColdFusion Markup file (.cfm) and place it in the wwwroot directory ("C:\ColdFusion2021\cfusion\wwwroot")
for ColdFusion.
The following code queries the data source:
<cfquery name="ADPQuery" dataSource="CDataADPJDBC"> SELECT * FROM Workers </cfquery>
And a CFTable can be used to quickly output the table in HTML:<cftable query = "ADPQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b>AssociateOID</b>" align="Left" width=2 text="AssociateOID"/> <cfcol header="<b>WorkerID</b>" align="Left" width=15 text="WorkerID"/> ... </cftable>
Full code, including the HTML portion is available below:<html> <head><title>CData Software | ADP Workers Table Demo </title></head> <body> <cfoutput>#ucase("ADP Workers Table Demo")#</cfoutput> <cfquery name="ADPQuery" dataSource="CDataADPJDBC"> SELECT * FROM Workers </cfquery> <cftable query = "ADPQuery" border = "1" colHeaders colSpacing = "2" headerLines = "2" HTMLTable maxRows = "500" startRow = "1"> <cfcol header="<b>AssociateOID</b>" align="Left" width=2 text="AssociateOID"/> <cfcol header="<b>WorkerID</b>" align="Left" width=15 text="WorkerID"/> ... </cftable> </body> </html>
- Finally, run the code locally in a browser at the default port of 8500. It produces a table populated with ADP data!
As a note, the CData JDBC Drivers also support parameterized queries using the cfqueryparam element.
For example:
SELECT * FROM Account WHERE name =
Get Started Today
Download a free, 30-day trial of the CData JDBC Driver for ADP and start building ADP-connected applications with Adobe ColdFusion. Reach out to our Support Team if you have any questions.