Integrate Paylocity Data in the Pentaho Report Designer

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.



Publish reports based on Paylocity data in the Pentaho BI tool.

The CData JDBC Driver for Paylocity data enables access to live data from dashboards and reports. This article shows how to connect to Paylocity data as a JDBC data source and publish reports based on Paylocity data in Pentaho.

Connect and Create a Report

  1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
  2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.
  3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new Paylocity connection. In the resulting dialog, configure the connection properties as shown below.

    • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:paylocity: and is 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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      Below is a typical JDBC URL:

      jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
    • Custom Driver Class Name: Enter cdata.jdbc.paylocity.PaylocityDriver.
    • User Name: The username to authenticate with.
    • Password: The password to authenticate with.

Add Paylocity Data to a Report

You are now ready to create a report with Paylocity data.

  1. Add the Paylocity source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

  2. Configure the query. This article uses the one below:

    SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
  3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the Employee table.
  4. Finally, run the report to see the chart.