Bridge Paylocity Connectivity with Apache NiFi



Access and process Paylocity data in Apache NiFi using the CData JDBC Driver.

Apache NiFi supports powerful and scalable directed graphs of data routing, transformation, and system mediation logic. When paired with the CData JDBC Driver for Paylocity, NiFi can work with live Paylocity data. This article describes how to connect to and query Paylocity data from an Apache NiFi Flow.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Paylocity data. When you issue complex SQL queries to Paylocity, the driver pushes supported SQL operations, like filters and aggregations, directly to Paylocity and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Paylocity data using native data types.

Connecting to Paylocity Data in Apache NiFi

  1. Download the CData JDBC Driver for Paylocity installer, unzip the package, run the .exe file to install the driver.
  2. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.paylocity.jar (and cdata.jdbc.paylocity.lic), to the Apache NiFi lib subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\lib.

    On Windows, the default location for the CData JDBC Driver is C:\Program Files\CData\CData JDBC Driver for Paylocity.

  3. Start Apache NiFi by running the run-nifi.bat file in bin subfolder, for example, C:\nifi-1.3.0-bin\nifi-1.3.0\bin.

    (OR)

    Use the command prompt to navigate to the particular directory and run the run-nifi.bat file for example:

    cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
    .\run-nifi.bat
    
  4. Navigate to the Apache NiFi UI in your web browser: It should be https://localhost:8443/nifi.

    Note: If users are utilizing an older version of Apache NiFi, they should access it via http://localhost:8080/nifi. In earlier versions, HTTP was the protocol employed. However, in the most recent version, HTTPS is the standard. By default, HTTP operates on port 8080, while HTTPS uses port 8443.

  5. When accessing Apache NiFi via a URL, it prompts you to enter a username and password for login.

    To retrieve login credentials, users should consult the 'App.log' file located within the log directory of their NiFi installation. This file typically contains the necessary details for accessing the NiFi interface.

  6. Click the (Configuration) button from the Operate sidebar under the "NiFi Flow" process group.
  7. In the NiFi Flow Configuration page, navigate to the "Controller Services" tab.
  8. Click the button to create a new controller service.
  9. In the Add Controller Service page, select "DBCPConnectionPool", and then click Add.
  10. In the Configure Controller Service page, navigate to the "Properties" tab.
  11. Click the gear button to configure the new DBCPConnection Pool.
  12. Fill in the properties:

    PropertyValue
    Database Connection URLjdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH
    Database Driver Class Namecdata.jdbc.paylocity.PaylocityDriver
    Database Driver Location(s)Path to your Apache NiFi's lib folder where the JAR files are present.

    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.

    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.

  13. To establish a connection and execute a select query, simply drag and drop the processor (indicated by the yellow highlight) into the workspace.
  14. Select the 'ExecuteSQL' processor and click the 'Add' button to make it visible in the workspace.
  15. Click on the added processor (ExecuteSQL)to open the connection page.
  16. Click on the Verify Properties button and verify to test the connection.
  17. Ensure that all the verification results are successful, and then click on APPLY.
  18. Activate the connection by clicking the small button at the right corner of the screen.

Your Paylocity data is now available for use in Apache NiFi. For example, you can use the DBCPConnection Pool as the source for a QueryDatabaseTable processor (shown below).

Download a free, 30-day trial of the CData JDBC Driver for Paylocity and start working with your live Paylocity data in Apache NiFi. Reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the Paylocity Driver to get started:

 Download Now

Learn more:

Paylocity Icon Paylocity JDBC Driver

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