Build Pipelines with Live Paylocity Data in Google Cloud Data Fusion (via CData Connect AI)

Google Cloud Data Fusion simplifies building and managing data pipelines by offering a visual interface to connect, transform, and move data across various sources and destinations, streamlining data integration processes. When combined with CData Connect AI, it provides access to Paylocity data for building and managing ELT/ETL data pipelines. This article explains how to use CData Connect AI to create a live connection to Paylocity and how to connect and access live Paylocity data from the Cloud Data Fusion platform.

Configure Paylocity Connectivity for Cloud Data Fusion

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

Connecting to Paylocity from Cloud Data Fusion

Follow these steps to establish a connection from Cloud Data Fusion to Paylocity through the CData Connect AI JDBC driver:

1. Download and install the CData Connect AI JDBC driver:
   1. Open the Integrations page of CData Connect AI.
   2. Search for and select JDBC.
   3. Download and run the setup file.
   4. When the installation is complete, copy the JAR file(cdata.jdbc.connect.jar) from the installation directory (e.g., C:\Program Files\CData\JDBC Driver for CData Connect\lib).
2. Log into Cloud Data Fusion.
3. Click the green "+" button at the top right to add an entity.
4. Under Driver, click Upload. 👁 Upload the driver JAR file
   
5. Now, upload the CData Connect AI JDBC driver (JAR file).
6. Enter the driver settings:
   • Name: Enter the name of the driver
   • Class name: Enter "cdata.jdbc.connect.ConnectDriver"
   • Version: Enter the driver version
   • Description (optional): Enter a description for the driver 👁 Enter the driver settings
     
7. Click on Finish.
8. Enter source configuration settings:
   • Label: Helps to identify the connection
   • JDBC driver name: Enter the JDBC driver name to identify the driver configured in Step 6.
   • Connection string: Enter the JDBC connection string, for example:

     jdbc:connect:AuthScheme=Basic;user=username;password=PAT;

   • User: Enter your CData Connect AI username, displayed in the top-right corner of the CData Connect AI interface. For example, "[email protected]"
   • Password: Enter the PAT you generated on the Settings page. 👁 Enter the source configuration settings
     
9. Click Validate in the top right corner.
10. If the connection is successful, you can manage the pipeline by editing it through the UI. 👁 Build and manage the pipeline in the UI
    
11. Run the pipepline created. 👁 Run the pipeline
    

Troubleshooting

Please be aware that there is a known issue in Cloud Data Fusion where "int" types from source data are automatically cast as "long".

Live Access to Paylocity Data from Cloud Applications

Now you have a direct connection to live Paylocity data from from Google Cloud Data Fusion. You can create more connections to ensure a smooth movement of data across various sources and destinations, thereby streamlining data integration processes - all without replicating Paylocity data.

To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources (including Paylocity) directly from your cloud applications, explore the CData Connect AI.