Connect to Paylocity Data in RazorSQL

The CData JDBC Driver for Paylocity enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to Paylocity using wizards in RazorSQL.

Create a JDBC Data Source for Paylocity Data

1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
2. In the Connection Wizard that appears, set the following properties:
   • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
   • Driver Class: Set the driver class to cdata.jdbc.paylocity.PaylocityDriver.
   • Username: Enter the username. (This property can also be set in the JDBC URL.)
   • Password: Enter the password. (This property can also be set in the JDBC URL.)

   • JDBC URL: Enter connection parameters. The JDBC URL begins 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.)
     

     A typical JDBC URL is the following:

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

Query Paylocity Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.