Create a Data Access Object for Paylocity Data using JDBI

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Paylocity.



A brief overview of creating a SQL Object API for Paylocity data in JDBI.

JDBI is a SQL convenience library for Java that exposes two different style APIs, a fluent style and a SQL object style. The CData JDBC Driver for Paylocity integrates connectivity to live Paylocity data in Java applications. By pairing these technologies, you gain simple, programmatic access to Paylocity data. This article walks through building a basic Data Access Object (DAO) and the accompanying code to read and write Paylocity data.

Create a DAO for the Paylocity Employee Entity

The interface below declares the desired behavior for the SQL object to create a single method for each SQL statement to be implemented.

public interface MyEmployeeDAO { //insert new data into Paylocity @SqlUpdate("INSERT INTO Employee (EmployeeId, LastName) values (:employeeId, :lastName)") void insert(@Bind("employeeId") String employeeId, @Bind("lastName") String lastName); //request specific data from Paylocity (String type is used for simplicity) @SqlQuery("SELECT LastName FROM Employee WHERE EmployeeId = :employeeId") String findLastNameByEmployeeId(@Bind("employeeId") String employeeId); /* * close with no args is used to close the connection */ void close(); }

Open a Connection to Paylocity

Collect the necessary connection properties and construct the appropriate JDBC URL for connecting to Paylocity.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Either 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 and copy the connection string to the clipboard.

A connection string for Paylocity will typically look like the following:

jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH

Use the configured JDBC URL to obtain an instance of the DAO interface. The particular method shown below will open a handle bound to the instance, so the instance needs to be closed explicitly to release the handle and the bound JDBC connection.

DBI dbi = new DBI("jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH"); MyEmployeeDAO dao = dbi.open(MyEmployeeDAO.class); //do stuff with the DAO dao.close();

Read Paylocity Data

With the connection open to Paylocity, simply call the previously defined method to retrieve data from the Employee entity in Paylocity.

//disply the result of our 'find' method String lastName = dao.findLastNameByEmployeeId("1234"); System.out.println(lastName);

Write Paylocity Data

It is also simple to write data to Paylocity, using the previously defined method.

//add a new entry to the Employee entity dao.insert(newEmployeeId, newLastName);

Since the JDBI library is able to work with JDBC connections, you can easily produce a SQL Object API for Paylocity by integrating with the CData JDBC Driver for Paylocity. Download a free trial and work with live Paylocity data in custom Java applications today.