Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Access Live Paylocity Data in AWS Lambda
Connect to live Paylocity data in AWS Lambda using the CData JDBC Driver.
AWS Lambda is a compute service that lets you build applications that respond quickly to new information and events. AWS Lambda functions can work with live Paylocity data when paired with the CData JDBC Driver for Paylocity. This article describes how to connect to and query Paylocity data from an AWS Lambda function built in Eclipse.
At the time this article was written (June 2022), Eclipse version 2019-12 and Java 8 were the highest versions supported by the AWS Toolkit for Eclipse.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Paylocity data. When you issue complex SQL queries to Paylocity, the driver pushes supported SQL operations, like filters and aggregations, directly to Paylocity and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze Paylocity data using native data types.
Gather Connection Properties and Build a Connection String
Set the following to establish a connection to Paylocity:
- RSAPublicKey: Set this to the RSA Key associated with your Paylocity, if the RSA Encryption is enabled in the Paylocity account.
This property is required for executing Insert and Update statements, and it is not required if the feature is disabled.
- UseSandbox: Set to true if you are using sandbox account.
- CustomFieldsCategory: Set this to the Customfields category. This is required when IncludeCustomFields is set to true. The default value for this property is PayrollAndHR.
- Key: The AES symmetric key(base 64 encoded) encrypted with the Paylocity Public Key. It is the key used to encrypt the content.
Paylocity will decrypt the AES key using RSA decryption.
It is an optional property if the IV value not provided, The driver will generate a key internally. - IV: The AES IV (base 64 encoded) used when encrypting the content. It is an optional property if the Key value not provided, The driver will generate an IV internally.
Connect Using OAuth Authentication
You must use OAuth to authenticate with Paylocity. OAuth requires the authenticating user to interact with Paylocity using the browser. For more information, refer to the OAuth section in the Help documentation.
The Pay Entry API
The Pay Entry API is completely separate from the rest of the Paylocity API. It uses a separate Client ID and Secret, and must be explicitly requested from Paylocity for access to be granted for an account. The Pay Entry API allows you to automatically submit payroll information for individual employees, and little else. Due to the extremely limited nature of what is offered by the Pay Entry API, we have elected not to give it a separate schema, but it may be enabled via the UsePayEntryAPI connection property.
Please be aware that when setting UsePayEntryAPI to true, you may only use the CreatePayEntryImportBatch & MergePayEntryImportBatchgtable stored procedures, the InputTimeEntry table, and the OAuth stored procedures. Attempts to use other features of the product will result in an error. You must also store your OAuthAccessToken separately, which often means setting a different OAuthSettingsLocation when using this connection property.
NOTE: To use the JDBC driver in an AWS Lambda function, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.
Built-in Connection String Designer
For assistance constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Double-click the JAR file or execute the jar file from the command line.
java -jar cdata.jdbc.paylocity.jar
Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.
Create an AWS Lambda Function
- Download the CData JDBC Driver for Paylocity installer, unzip the package, and run the JAR file to install the driver.
Create a new AWS Lambda Java Project in Eclipse using the AWS Toolkit for Eclipse. You can follow the tutorial from AWS (amazon.com).
For this article, set the Input Type for the project to "Custom" so we can enter a table name as the input.
- Add the CData JDBC Driver for Paylocity JAR file (cdata.jdbc.paylocity.jar) to the build path. The file is found in INSTALL_PATH\lib\.
- Add the following import statements to the Java class:
import java.sql.Connection; import java.sql.DriverManager; import java.sql.ResultSet; import java.sql.ResultSetMetaData; import java.sql.SQLException; import java.sql.Statement;
Replace the body of the handleRequest method with the code below. Be sure to fill in the connection string in the DriverManager.getConnection method call.
String query = "SELECT * FROM " + input; try { Class.forName("cdata.jdbc.paylocity.PaylocityDriver"); } catch (ClassNotFoundException ex) { context.getLogger().log("Error: class not found"); } Connection connection = null; try { connection = DriverManager.getConnection("jdbc:cdata:paylocity:RTK=52465...;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH"); } catch (SQLException ex) { context.getLogger().log("Error getting connection: " + ex.getMessage()); } catch (Exception ex) { context.getLogger().log("Error: " + ex.getMessage()); } if(connection != null) { context.getLogger().log("Connected Successfully!\n"); } ResultSet resultSet = null; try { //executing query Statement stmt = connection.createStatement(); resultSet = stmt.executeQuery(query); ResultSetMetaData metaData = resultSet.getMetaData(); int numCols = metaData.getColumnCount(); //printing the results while(resultSet.next()) { for(int i = 1; i <= numCols; i++) { System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null ); } System.out.print("\n"); } } catch (SQLException ex) { System.out.println("SQL Exception: " + ex.getMessage()); } catch (Exception ex) { System.out.println("General exception: " + ex.getMessage()); } String output = "query: " + query + " complete"; return output;
Deploy and Run the Lambda Function
Once you build the function in Eclipse, you are ready to upload and run the function. In this article, the output is written to the AWS logs, but you can use this is a template to implement you own custom business logic to work with Paylocity data in AWS Lambda functions.
- Right-click the Package and select Amazon Web Services -> Upload function to AWS Lamba.
- Name the function, select an IAM role, and set the timeout value to a high enough value to ensure the function completes (depending on the result size of your query).
- Right-click the Package and select Amazon Web Services -> Run function on AWS Lambda and set the input to the name of the Paylocity object you wish to query (i.e. "Employee").
- After the job runs, you can view the output in the CloudWatch logs.
Free Trial & More Information
Download a free, 30-day trial of the CData JDBC Driver for Paylocity and start working with your live Paylocity data in AWS Lambda. Reach out to our Support Team if you have any questions.