Connect to Paylocity Data in Jaspersoft Studio

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.



Execute SQL to remote Paylocity data in Jaspersoft Studio.

This article shows how to connect to Paylocity from Jaspersoft Studio as a standard JDBC data source with the CData JDBC Driver for Paylocity. You will use the standard Jaspersoft wizards to build SQL queries to Paylocity. The queries are executed directly to the Paylocity APIs, enabling real-time connectivity to Paylocity data.

Connect to Paylocity Data as a JDBC Data Source

To create a JDBC data source in Jaspersoft Studio, create a data adapter:

  1. In the Repository Explorer view, right-click the Data Adapters node and click Create Data Adapter.
  2. Select Database JDBC Connection.
  3. Enter a user-friendly name for the driver.
  4. On the Driver Classpath tab, click Add. In the resulting dialog, navigate to the lib subfolder of the installation directory. Select the driver JAR.
  5. On the Database Location tab, enter the class name of the JDBC driver: cdata.jdbc.paylocity.PaylocityDriver.
  6. Enter the JDBC URL.

    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 for Paylocity:

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

Create Reports with Paylocity Data

Follow the steps below to build an SQL query to Paylocity, the basis of a simple report:

  1. Click File -> New Jasper Report. Select a template, select the parent project, and specify the report file.
  2. In the Data Adapter menu, select the data adapter you created in the previous section.
  3. In the Diagram tab, drag tables into the box and click the columns you want. Or, enter a custom query on the Texts tab. For example: SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
  4. Select the fields you want to include in the dataset. This example uses all fields.
  5. Skip the Group By step and finish the wizard.

In the Preview tab, you can see the report as it would look with the current Paylocity data.

Create a Chart

The following sections show how to create a chart tied to its own SQL query. When retrieving the data from the remote data source, more restrictive queries, written for specific report objects, can result in faster performance.

Create a DataSet

Follow the steps below to create a new dataset to populate the chart:

  1. In the report editing area, click the Design tab.
  2. In the Outline view, right-click the root node for the report and click Create Dataset.
  3. Enter a name for the dataset and click the option to create a new dataset from a connection or data source.
  4. In the Data Adapter menu, select the data adapter you created in the first section.
  5. Enter a query such as the following:

    SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
  6. Select the fields you want in the dataset. This example uses FirstName and LastName.
  7. Skip the step to group by fields and finish the wizard.

Configure the Chart

After adding the dataset, follow the steps below to map column values to the chart axes in the chart wizard:

  1. Click the Summary node in the Outline view. In the Properties view, set the height to 400 pixels. The summary band is printed at the end of the report.
  2. Drag a chart from the Palette onto the summary. The chart wizard is displayed.
  3. Select the chart type. This example uses a bar chart.
  4. In the Dataset menu, select the dataset you created for the chart.
  5. In the Dataset tab, select the option to use the same JDBC connection used to fill the master report.
  6. Specify the chart's series: Click the button next to the Series menu and click Add. In the Expression Editor that is displayed, double-click the FirstName column to set the expression to $F{FirstName}.
  7. Specify the y-axis values: In the chart wizard, click the button next to the Value box. In the Expression Editor, double-click LastName to set the expression to $F{LastName}.

  8. Specify the labels for the series elements: In the chart wizard, click the button next to the Label box. In the Expression Editor, double-click the FirstName column to set the expression to $F{FirstName}. If needed, convert the column type to string, as in the following expression: $F{FirstName}.toString()
  9. Expand the chart to fill the summary section: right-click the chart and click Size to Container -> Fit Both.

Running the Report

You can now generate reports on Paylocity data just as you would any other JDBC data source. Jaspersoft Studio periodically refreshes the data across report runs.