Connect to Paylocity Data and Transfer Data in Talend

This article shows how you can easily integrate the CData JDBC driver for Paylocity into your workflow in Talend. This article uses the CData JDBC Driver for Paylocity to transfer Paylocity data in a job flow in Talend.

Connect to Paylocity in Talend as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to Paylocity:

1. Add a new database connection to Paylocity data: To add a new connection, expand the Metadata node, right-click the Db Connections node, and then click Create Connection.
2. In the resulting wizard, enter a name for the connection.

3. On the next page, select Generic JDBC from the DB Type menu and 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.

   A typical JDBC URL is below:

   jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
4. Enter the path to the cdata.jdbc.paylocity.jar file, located in the lib subfolder of the installation directory.
5. Right-click the connection and then click Retrieve Schema.
6. Click Next with the default options to select the tables you want to import.
7. Finish the wizard with the default options.

Output the Employee Table to a Flat File

You can follow the procedure below to transfer the Employee table to a flat file output component:

1. In the Table Schemas node, drag the tables to the workspace.
2. In the dialog that is displayed, select the tJDBCInput component.
3. Next, drag a tFileOutputDelimited component from the Business Intelligence tab of the Palette into the workspace.
4. Right-click the Employee tJDBCInput component and drag a vector to the output file.

Run the project to transfer the data.