Integrate with Paylocity Data in JReport Designer

Jerod Johnson
Director, Technology Evangelism

Create charts and reports based on Paylocity data in JReport Designer.

The CData JDBC Driver for Paylocity data enables access to live data from dashboards and reports as if Paylocity were a relational database, allowing you to query Paylocity data using familiar SQL queries. This article shows how to connect to Paylocity data as a JDBC data source and create reports based on Paylocity data in JReport Designer.

Connect to Paylocity Data

Edit C:\JReport\Designer\bin\setenv.bat to add the location of the JAR file to the ADDCLASSPATH variable:

...
set ADDCLASSPATH=%JAVAHOME%\lib\tools.jar;C:\Program Files\CData\CData JDBC Driver for Paylocity 2016\lib\cdata.jdbc.paylocity.jar;
...

Create a new data source by clicking File New Data Source.
In the resulting dialog, create a name for the data source (CData JDBC Driver for Paylocity), select JDBC, and click OK.
In the Get JDBC Connection Information dialog you will configure your connection to the JDBC driver:
- Driver: Be sure that the Driver box is checked and fill in the name of the class for the driver:
```
cdata.jdbc.paylocity.PaylocityDriver
```
- URL: 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.
  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  
  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;
```
- User: The username to authenticate with; typically left blank.
- Password: The password to authenticate with; typically left blank.
👁 Configuring the connection to the JDBC Driver (Salesforce is shown.)
In the Add Table dialog, select the tables you wish to include in your report (or in future reports using this data source) and click Add.
👁 Adding Tables. (Salesforce is shown.)

Click Done once the dialog has completed loading the tables.
In the Catalog Browser, you can create the queries that you will use to populate your reports. You can do this now, or after you create your report. In either case, expand () the data source (CData JDBC Driver for Paylocity), right-click on Queries, and select Add Query. 👁 Adding a query for data to be used in the report. (Salesforce is shown.)
In the Add Table/View/Query dialog, expand () the JDBC URL and Tables and select the table(s) you wish to use in the query and click OK. 👁 Selecting a table for the query. (Salesforce is shown.)
In the Query Editor dialog, you can select the columns you wish to include or simply click the SQL button and manually input your own query. For example:
```
SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
```
👁 Editing the query. (Salesforce is shown.)

With the query built, click OK to close the Query Editor dialog. At this point you are ready to add Paylocity data to a new or existing report.

NOTE: Now that the query is built, you can create a Business View based on the query. With a Business View, you can create Web reports or library components based on the query. For more information on this, refer to the JReport tutorials.