Integrate with live Paylocity Data in Jitterbit

Jitterbit is an enterprise iPaaS (integration platform as a service) that lets you streamline your data workflows. When paired with CData Connect Cloud, Jitterbit gets access to live Paylocity data. This article demonstrates how to connect to Paylocity using Connect Cloud and integrate with live Paylocity data in Jitterbit.

CData Connect Cloud provides a pure OData 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 Jitterbit

Connectivity to Paylocity from Jitterbit is made possible through CData Connect Cloud. To work with Paylocity data from Jitterbit, 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.

Configure Paylocity Endpoints for Jitterbit

After connecting to Paylocity, create a workspace and virtual dataset for your desired table(s).

1. Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the Paylocity connection (e.g. Paylocity1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

Connect to Paylocity from Jitterbit using Connect Cloud

To establish a connection from Jitterbit to CData Connect Cloud using the OData protocol, follow these steps.

1. Log into Jitterbit.
2. Create a project in Cloud Studio and provide a workspace environment for it.
3. Click Connections and enter OData in the search bar.
4. Select the OData connector.
5. Enter the OData connection properties.
• Connection Name: enter a connection name.
• OData Metadata URL: enter https://cloud.cdata.com/api/odata/{workspace_name}.
• Authentication: select Basic Auth.
• User Name: 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.
6. Click Test to test the connection, and then click Save Changes.
7. Choose the operation you want to perform and drag it to the workflow in your project.
8. Double-click the query operation to see all the tables and derived views available in your OData endpoint.
9. Select a table and configure the query.

You can now transform and integrate live Paylocity data in Jitterbit.

Get CData Connect Cloud

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