Connect to Paylocity Data from Crystal Reports

Crystal Reports is a business intelligence application by SAP designed to help you analyze your data with well-formatted, pixel-perfect, and multi-page reports. When paired with CData Connect AI, Crystal Reports gets access to live Paylocity data. This article demonstrates how to connect to Paylocity using Connect AI and report on Paylocity data in Crystal Reports.

CData Connect AI provides a pure SQL Server interface for Paylocity, allowing you to query data from Paylocity without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Paylocity, leveraging server-side processing to return the requested Paylocity data quickly.

Configure Paylocity Connectivity for Crystal Reports

Connectivity to Paylocity from Crystal Reports is made possible through CData Connect AI. To work with Paylocity data from Crystal Reports, we start by creating and configuring a Paylocity connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Paylocity" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect 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. 👁 Configuring a connection (Salesforce is shown)
   

4. Click Save & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Paylocity data from Crystal Reports.

Connect to Paylocity from Crystal Reports using Connect AI

To establish a connection from Crystal Reports to CData Connect AI, you will need to download the JDBC driver.

1. Open the Client Tools page of CData Connect AI.
2. Search for and select JDBC.
3. Download and run the setup file.
4. When the installation is complete, locate the JDBC Connect JAR file in the JDBC driver's installation directory, for example, C:\Program Files\CData\JDBC Driver for CData Connect\lib.
5. Copy the JDBC Connect JAR file (cdata.jdbc.connect.jar).

After copying the JDBC CData Connect JAR file, you will need to paste it into the Crystal Reports installation location and configure the connection to Connect AI.

1. Find the installation directory for Crystal Reports, for example, C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java\lib
2. Paste the JDBC Connect JAR file into the Crystal Reports installation directory.
3. Go to the parent java folder. For example, C:\Program Files (x86)\SAP BusinessObjects\SAP BusinessObjects Enterprise XI 4.0\java This folder should contain a CRConfig file. 👁 Locating the CRConfig file in the Crystal Reports installation directory.
   
4. Open CRConfig in a text editor.
5. Add the path to the JDBC CData Connect JAR file in the
6. Log into Crystal Reports and start a blank report.
7. In the Database Expert dialog, click Create New Connection.
8. Select the JDBC data source and the tables you want to add. Click OK. 👁 Selecting the JDBC data source.
   
9. In the Connection dialog, enter the Connection URL (e.g. jdbc:connect:AuthScheme=Basic;user=username;password=PAT;) and Database Classname (e.g. cdata.jdbc.connect.ConnectDriver). 👁 Configuring the connection.
   
10. Click Finish. The Database Expert dialog displays all available connections. 👁 Browsing the available data from Connect AI.
    

You can now create reports with the connected data.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Crystal Reports, try CData Connect AI today!