Connect to Paylocity from a Connection Pool in WebLogic

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Paylocity.



Use the CData JDBC Driver for Paylocity to connect to Paylocity data from Web applications running on WebLogic.

The CData JDBC Driver for Paylocity enables you to follow standard procedures to integrate Paylocity data into Java Web applications. This article shows how to deploy the CData JDBC Driver for Paylocity in WebLogic Server.

Deploy the JDBC Driver in WebLogic Server

To deploy the driver, add the driver JAR to your classpath. The .lic file must be located in the same folder as the JAR. These files are located in the lib subfolder of the installation directory.

If you want to add the driver to all domains, prepend the path to the JAR to the WEBLOGIC_CLASSPATH environment variable in WL_HOME\common\bin\commEnv.cmd/sh. This script is located in WL_HOME\common\bin\. For example:

set WEBLOGIC_CLASSPATH=your-installation-directory\lib\cdata.jdbc.paylocity.jar;%WEBLOGIC_CLASSPATH%

In WebLogic 12.2.1 if you want to add the driver to a specific domain, you can simply place the driver JAR and .lic file into DOMAIN_HOME\lib; for example, ORACLE_HOME\user_projects\domains\MY_DOMAIN\lib. These files will be added to the server classpath at startup.

Earlier versions require that you manually add the driver to the classpath: Prepend the following to the PRE_CLASSPATH environment variable in setDomainEnv.cmd/sh. This script is located in the bin subfolder of the folder for that domain.

set PRE_CLASSPATH=your-installation-directory\lib\cdata.jdbc.paylocity.jar;%PRE_CLASSPATH%

After making these changes, restart the server.

Create a JDBC Data Source for Paylocity

After deploying the driver, log into the WebLogic Administration Console and create the connection.

  1. In the Domain Structure tree, click Services -> Data Sources -> New -> Generic Data Source.
  2. On the JDBC Data Source Properties page, enter the following information:
    • Name: Enter a user-friendly name; for example, paylocityjdbc.
    • JNDI Name: Enter the path the JDBC data source will be bound to; for example, jdbc/Paylocity.
    • Database Type: Select Other.

  3. Click Next to use the default options. On the last page, enter the following information and click Test Configuration:

    • Driver Class Name: Enter the driver class, cdata.jdbc.paylocity.PaylocityDriver.
    • URL: Enter the JDBC URL. A typical JDBC URL is below:

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

      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.

    • Database User Name: Enter the username, if not specified in the JDBC URL.
    • Password: Enter the password, if not specified in the JDBC URL.

After selecting the server where you want to deploy the JDBC data source, you can now connect to Paylocity data.

More WebLogic Integration

The steps above show how configure the driver in a simple connection pooling scenario. For more use cases and information, see the JDBC sections in the WebLogic Data Sources chapter of the Oracle Fusion Middleware documentation.