Object-Relational Mapping (ORM) with Paylocity Data Entities in Java

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.



Object-relational mapping (ORM) techniques make it easier to work with relational data sources and can bridge your logical business model with your physical storage model. Follow this tutorial to integrate connectivity to Paylocity data into a Java-based ORM framework, Hibernate.

You can use Hibernate to map object-oriented domain models to a traditional relational database. The tutorial below shows how to use the CData JDBC Driver for Paylocity to generate an ORM of your Paylocity repository with Hibernate.

Though Eclipse is the IDE of choice for this article, the CData JDBC Driver for Paylocity works in any product that supports the Java Runtime Environment. In the Knowledge Base you will find tutorials to connect to Paylocity data from IntelliJ IDEA and NetBeans.

Install Hibernate

Follow the steps below to install the Hibernate plug-in in Eclipse.

  1. In Eclipse, navigate to Help -> Install New Software.
  2. Enter "http://download.jboss.org/jbosstools/neon/stable/updates/" in the Work With box.
  3. Enter "Hibernate" into the filter box.
  4. Select Hibernate Tools.

Start A New Project

Follow the steps below to add the driver JARs in a new project.

  1. Create a new project. Select Java Project as your project type and click Next. Enter a project name and click Finish.
  2. Right-click the project and click Properties. Click Java Build Path and then open the Libraries tab.
  3. Click Add External JARs to add the cdata.jdbc.paylocity.jar library, located in the lib subfolder of the installation directory.

Add a Hibernate Configuration File

Follow the steps below to configure connection properties to Paylocity data.

  1. Right-click on the new project and select New -> Hibernate -> Hibernate Configuration File (cfg.xml).
  2. Select src as the parent folder and click Next.
  3. Input the following values:

    • Hibernate version:: 5.2
    • Database dialect: Derby
    • Driver class: cdata.jdbc.paylocity.PaylocityDriver
    • Connection URL: A JDBC URL, starting with jdbc:paylocity: and followed by a semicolon-separated list of connection properties.

      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 typical JDBC URL is below:

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

Connect Hibernate to Paylocity Data

Follow the steps below to select the configuration you created in the previous step.

  1. Switch to the Hibernate Configurations perspective: Window -> Open Perspective -> Hibernate.
  2. Right-click on the Hibernate Configurations panel and click Add Configuration.
  3. Set the Hibernate version to 5.2.
  4. Click the Browse button and select the project.
  5. For the Configuration file field, click Setup -> Use Existing and select the location of the hibernate.cfg.xml file (inside src folder in this demo).
  6. In the Classpath tab, if there is nothing under User Entries, click Add External JARS and add the driver jar once more. Click OK once the configuration is done.
  7. Expand the Database node of the newly created Hibernate configurations file.

Reverse Engineer Paylocity Data

Follow the steps below to generate the reveng.xml configuration file. You will specify the tables you want to access as objects.

  1. Switch back to the Package Explorer.
  2. Right-click your project, select New -> Hibernate -> Hibernate Reverse Engineering File (reveng.xml). Click Next.
  3. Select src as the parent folder and click Next.
  4. In the Console configuration drop-down menu, select the Hibernate configuration file you created above and click Refresh.
  5. Expand the node and choose the tables you want to reverse engineer. Click Finish when you are done.

Configure Hibernate to Run

Follow the steps below to generate plain old Java objects (POJO) for the Paylocity tables.

  1. From the menu bar, click Run -> Hibernate Code Generation -> Hibernate Code Generation Configurations.
  2. In the Console configuration drop-down menu, select the Hibernate configuration file you created in the previous section. Click Browse by Output directory and select src.
  3. Enable the Reverse Engineer from JDBC Connection checkbox. Click the Setup button, click Use Existing, and select the location of the hibernate.reveng.xml file (inside src folder in this demo).
  4. In the Exporters tab, check Domain code (.java) and Hibernate XML Mappings (hbm.xml).
  5. Click Run.

One or more POJOs are created based on the reverse-engineering setting in the previous step.

Insert Mapping Tags

For each mapping you have generated, you will need to create a mapping tag in hibernate.cfg.xml to point Hibernate to your mapping resource. Open hibernate.cfg.xml and insert the mapping tags as so:

cdata.paylocity.PaylocityDriver jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH org.hibernate.dialect.SQLServerDialect

Execute SQL

Using the entity you created from the last step, you can now search and modify Paylocity data: import java.util.*; import org.hibernate.Session; import org.hibernate.cfg.Configuration; import org.hibernate.query.Query; public class App { public static void main(final String[] args) { Session session = new Configuration().configure().buildSessionFactory().openSession(); String SELECT = "FROM Employee E WHERE EmployeeId = :EmployeeId"; Query q = session.createQuery(SELECT, Employee.class); q.setParameter("EmployeeId","1234"); List<Employee> resultList = (List<Employee>) q.list(); for(Employee s: resultList){ System.out.println(s.getFirstName()); System.out.println(s.getLastName()); } } }