Connect to Paylocity Data in Airbyte ELT Pipelines

Airbyte empowers users to load your data into any data warehouse, data lake, or database. When combined with CData Connect AI, Airbyte users can create Extract, Load, Transform (ELT) pipelines directly from live Paylocity data. This article illustrates the process of connecting to Paylocity through Connect AI and constructing ELT pipelines for Paylocity data within Airbyte.

CData Connect AI offers a dedicated SQL Server interface for Paylocity, facilitating data querying without the need for data replication to a native database. With built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, straight to Paylocity. This harnesses server-side processing to swiftly retrieve the desired Paylocity data.

Configure Paylocity Connectivity for Airbyte

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

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Paylocity" from the Add Connection panel
👁 Selecting a data source

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. 👁 Configuring a connection (Salesforce is shown)
   

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

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to Paylocity data from Airbyte.

Connect to Paylocity from Airbyte

To establish a connection from Airbyte to CData Connect AI, follow these steps.

1. Log in to your Airbyte account 👁 Logging into Airbyte
   
2. On the left panel, click Sources, then Add New Source
   • Set Source Type to MSSQL Server to connect the TDS endpoint
   • Set Source Name
   • Set Host URL to tds.cdata.com
   • Set Port to 14333
   • Set Database to the name of the connection you previously configured, e.g. Paylocity1.
   • Set Username to your Connect AI username
   • Set SSL Method to Encrypted (trust server certificate), leave the Replication Method as standard, and set SSH Tunnel Method to No Tunnel
   • (Optional) Set Schema to anything you want to apply to the source
   • Set Password to your Connect AI PAT
   • (Optional) Enter any needed JBDC URL Params
3. Click Test and Save to create the data source.

Create ELT Pipelines for Paylocity Data

To connect Paylocity data with a new destination, click Sources and then Set Up Connection to connect to your destination. Select the source created above and your desired destination, then allow Airbyte to process. When it is done, your connection is ready for use.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Airbyte, try CData Connect AI today!