Integrating Paylocity Data in Talend Cloud Data Management Platform

Qlik's Talend Cloud Data Management Platform supports various data environments, enabling analytics for smarter decisions, operational data sharing, data and application modernization, and establishing data excellence for risk reduction. When paired with the CData JDBC Driver for Paylocity, you can improve data integration, quality, and governance for your Paylocity Data. This article shows how you can easily integrate to Paylocity using a CData JDBC Driver in Talend Cloud Data Management, and then view the data for simultaneous use in your workflow.

Prerequisites

Before connecting the CData JDBC Driver to view and work with your data in Talend Cloud Data Management Platform, make sure to download and install the latest version of Talend Studio on your system. Also, ensure that you have the required prerequisites.

1. A Talend Cloud Data Management account with appropriate permissions.
2. The CData JDBC Driver for Paylocity, which can be downloaded from the CData website.

Connect to Paylocity in Talend as a JDBC data source

Access Talend Data Management Cloud

1. Run the Talend Cloud Data Management Platform installed on your local system and click on Other Login Mode. 👁 Log into Talend Cloud Data Management Platform locally
   
2. Click on Manage Connections. Set Repository to "Local" and enter the Name, Description and User E-mail in the respective spaces. Set the Workspace path and click on OK. 👁 Manage a connection.
   👁 Create a connection in Talend Data Management Cloud
   
3. Now, select the Create a new project radio button to add a new project name and click on Create. 👁 Create a new project.
   
4. The new project should appear under the Select an existing project section. Click on Open. The Talend Cloud Data Management Platform workspace opens up. 👁 Open the Talend Cloud Data Management Platform workspace.
   

Create a new connection

1. In the navigation pane, locate and expand the Metadata dropdown. Right-click on Db Connections and select Create Connection. 👁 Create a new connection in the Talend platform under Db connections.
   
2. Search for and select 'JDBC' in the Find section of the Database Connection window. Then, click on Finish. 👁 Search and select the JDBC connector.
   
3. Enter the Name, Purpose and Description of the new database in Talend where you need to load the Paylocity data. Click on Next. 👁 Enter details of the database toload the source data.
   
4. Generate a JDBC URL for connecting to Paylocity, beginning with jdbc:paylocity: followed by a series of semicolon-separated connection string 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.)
   

   A typical JDBC URL is below:

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

5. Enter the JDBC URL copied from CData JDBC Driver for Paylocity in Edit new database. 👁 Enter the JDBC URL (Salesforce is shown).
   

6. Click on the "(+) Add" button under Drivers. A 'newLine' will appear in the Drivers board. Click on (...) at the end of the new line, select the Install a new module radio button, and click on (...) to add the path to the JAR file, located in the 'lib' subfolder of the installation directory. Click on OK. 👁 Add a new line in Drivers board to add the path to the Paylocity JAR file (Salesforce is shown).
   👁 The lib folder which contains the Paylocity JAR file (Salesforce is shown).
   👁 Add the JAR installation path in 'Install a new module' (Salesforce is shown).
   
7. Select the Driver Class as cdata.jdbc.paylocity (JAR file obtained from your installation directory given in the previous step). 👁 Add the Driver class.
   

Test the new connection

1. Click on Check Connection. If the entered details are correct, a "Connection successful" confirmation prompt will appear. Click on "OK" and "Finish". 👁 Check the connection.
   
2. Once the connection is established, right-click on the newly created connection and select Retrieve Schema. You can use the filters as well to retrieve the data as per your requirements. Click on Next. 👁 Retrieve schema from the datasource.
   👁 Add the necessary filters.
   
3. Expand the "CData" catalog in the Schema window and select the tables you want to import from the Paylocity schema. Click on Next. 👁 Select a table from the Paylocity schema.
   
4. In the next step, select the columns you want to view from the table and click on Finish. 👁 Select the necessary columns from the selected table.
   
5. All the selected tables from the Paylocity schema are now populated under the Table Schemas section of the JDBC connection.
6. Right-click on any of the selected tables and click on Data Viewer to preview the data from the data source. 👁 Click on Data Viewer to view the source data.
   👁 Display the source table view.
   

Get Started Today

Download a free, 30-day trial of the CData JDBC Driver for Paylocity and integrate Paylocity data into Talend Cloud Data Management Platform. Reach out to our Support Team if you have any questions.