Connect and Visualize Live Paylocity Data in Databricks Lakehouse Federation with CData Connect Cloud

Databricks Lakehouse Federation enables organizations to query and integrate data from multiple sources without requiring data movement. It allows federated queries across databases, data warehouses, and lakehouses, providing a unified interface for data analysis and management within Databricks. When combined with CData Connect Cloud, it enables seamless access to Paylocity data for data virtualization, while also supporting data lineage and fine-grained access control.

This article explains how to use CData Connect Cloud to establish a live connection to Paylocity and how to access live Paylocity data from the Databricks platform.

CData Connect Cloud offers a seamless SQL Server, cloud-to-cloud interface for Paylocity, enabling you to effortlessly create dashboards and visualizations using live Paylocity data in Databricks. While building visualizations, Databricks requires SQL queries to retrieve the necessary data. With built-in optimized data processing, CData Connect Cloud pushes all supported SQL operations (such as filters and JOINs) directly to Paylocity, utilizing server-side processing for fast and efficient data retrieval of Paylocity data.

Configure Paylocity connectivity for Databricks in CData Connect Cloud

To work with Paylocity data in Databricks - Lakehouse Federation, you need to connect to Paylocity from Connect Cloud and provide user access to the 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

With the connection configured, you are ready to connect to Paylocity data from Databricks.

Connecting live Paylocity data in Databricks

Follow these steps to establish a connection from Databricks to the CData Connect Cloud Virtual SQL Server API.

1. Log into Databricks.
2. Navigate to SQL Warehouses and start any warehouse of your choice.
3. In the navigation pane, select Catalog. Click and select Create a connection.
4. In the Connection basics section (or Step 1 of Set up connection page), enter the following connection details and click Next:
   • Connection name: a user-defined connection name.
   • Connection type: select SQL Server from the drop-down list.
   • Auth type: select Username and password.
   
5. In the Authentication section (or Step 2), enter the required authentication details, and click Next:
   • Host: tds.cdata.com
   • Port: 14333
   • User: enter your CData Connect Cloud username, displayed in the top-right corner of the CData Connect Cloud interface. For example, test@cdata.com
   • Password: enter the PAT generated and copied in the previous section.
   
6. In the Connection details section (or Step 3), enable the Trust server certificate checkbox and select the appropriate Application intent. Click Create Connection.
7. In the Catalog basics section (or Step 4), enter the required details and click Create catalog:
   • Catalog name: enter a name of your choice
   • Connection: this will be the Databricks connection you defined earlier
   • Database: enter your Paylocity connection name (for example, Paylocity1)
   
8. In the Access section (or Step 5), assign the Workspace, User access rights, and Grant read or edit privileges to the catalog.
9. Click Next > Save to save all the details for the catalog.

Access the catalog and visualize live Paylocity data in Databricks

To access the newly created catalog and create a dashboard to visualize live Paylocity data in Databricks, follow these steps:

1. Select the catalog and expand it. A list of tables from Paylocity will appear on the screen.
2. Choose the desired table and click the Overview tab to view the table metadata.
3. Click the Sample Data tab to view real-time data in the table.
4. Now, click Create at the top right corner and select Dashboard.
5. Manually create a visualization by selecting at least one field in the visualization editor from the widget, or choose one of the visualization options suggested by Databricks AI.
6. Once the visualization is created, edit the details in the widget settings of the dashboard.
7. Click Publish to publish the dashboard report.

Live access to Paylocity data from cloud applications

At this stage, you have established a direct, cloud-to-cloud connection to live Paylocity data in Databricks. This enables you to create dashboards to monitor and visualize your data seamlessly.

For more details on accessing live data from over 100 SaaS, Big Data, and NoSQL sources through cloud applications like Databricks, visit our Connect Cloud page. As always, let us know if you have any questions during your evaluation. Our world-class CData Support Team is always available to help!