Integrate with Paylocity Data in SnapLogic

SnapLogic's iPaaS platform helps organizations automate application, data and cloud integrations. When paired with CData Connect Cloud, SnapLogic gets access to live Paylocity data. This article demonstrates how to connect to Paylocity using Connect Cloud and integrate with Paylocity data in SnapLogic.

CData Connect Cloud provides a pure SQL Server interface for Paylocity, allowing you to query data from Paylocity without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to Paylocity, leveraging server-side processing to return the requested Paylocity data quickly.

Configure Paylocity Connectivity for SnapLogic

Connectivity to Paylocity from SnapLogic is made possible through CData Connect Cloud. To work with Paylocity data from SnapLogic, we start by creating and configuring a Paylocity connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "Paylocity" from the Add Connection panel
3. Enter the necessary authentication properties to connect to Paylocity.

   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.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to Paylocity from SnapLogic using Connect Cloud

To establish a connection from SnapLogic to CData Connect Cloud, you will need to download the JDBC Driver.

1. Open the Client Tools page of CData Connect Cloud.
2. In the Dev Tools section, click JDBC.
3. Download and run the setup file.
4. When the installation is complete, locate the JDBC Connect JAR file in the JDBC driver's installation directory, for example, C:\Program Files\CData\JDBC Driver for CData Connect\lib.
5. Copy the JDBC Connect JAR file (cdata.jdbc.connect.jar).

After copying the JDBC CData Connect JAR file, you will need to paste it into the SnapLogic installation location and configure the connection to Connect Cloud.

1. Log into SnapLogic.
2. Click the Managers tab.
3. Select a folder from the Project Spaces to add the JDBC JAR file to.
4. Click the Files tab.
5. Click the button in the top right to upload the CData Connect Cloud JDBC JAR file. It appears as a file once uploaded.
6. Click the Designer tab.
7. Click JDBC to expand the options for "snaps."
8. Click and drag a Generic JDBC - Select "snap" onto the designer.
9. Click Add Account > Continue.
10. Enter the JDBC connection properties.
    • JDBC driver: add the CData Connect Cloud JAR file
    • JDBC driver Class: enter cdata.jdbc.connect.ConnectDriver
    • JDBC Url: enter a JDBC connection string for the JDBC driver. For example: jdbc:connect:AuthScheme=Basic;User={username};Password={PAT};
    • Username: enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, [email protected].
    • Password: enter the PAT you generated on the Settings page.
11. Click Validate. If the connection succeeds, the "snap" is ready to use.
12. Click Apply.

You can now create reports with the connected data.

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from SnapLogic, try CData Connect Cloud today!