Create Paylocity-Connected Visualizations in Klipfolio

Klipfolio is an online dashboard platform designed to create real-time business dashboards, whether for your team or clients. When combined with CData Connect Cloud, you gain immediate cloud-to-cloud access to Paylocity data to create visualizations, reports, and more. This article provides step-by-step instructions on connecting to Paylocity within Connect Cloud and creating visualizations using Paylocity data in Klipfolio.

CData Connect Cloud offers a direct cloud-to-cloud interface for Paylocity, enabling you to construct reports from real-time Paylocity data data within Klipfolio—without the need for data replication to a database natively supported by Klipfolio. While building visualizations, Klipfolio generates SQL queries to fetch data. With optimized data processing capabilities out of the box, CData Connect Cloud efficiently directs all supported SQL operations (such as filters, JOINs, etc.) directly to Paylocity, harnessing server-side processing to swiftly retrieve the requested Paylocity data data.

Configure Paylocity Connectivity for Klipfolio

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

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

Connect to Paylocity from Klipfolio

The steps below outline connecting to CData Connect Cloud from Klipfolio to create a new Paylocity data source.

1. Open Klipfolio
2. Click in Data Sources to add a new data source
3. Search for and select MSSQL as the Service
4. Click "Create a custom MSSQL data source"
5. Configure the data source by setting the MSSQL connection properties:
   • Host: tds.cdata.com
   • Port: 14333
   • Database: your database (e.g., Paylocity1)
   • Driver: MS SQL
   • Username: a Connect Cloud user (e.g. user@mydomain.com)
   • Password: the above user's PAT
   • SQL Query: any query to retrieve data (e.g. SELECT * FROM Employee )
   • Select the checkbox to "Include column headers"
   • Select the checkbox to "Use SSL/TLS"
6. Click "Get data" to preview the Paylocity data before building a data model.

Build a Data Model

After retrieving the data, click the checkbox to "Model your data" and click "Continue." In the new window, configure your data model.

1. Confirm that the model includes all columns you wish to work with
2. Name your model
3. (optional) Set the Description
4. Set "Header in row" to 1
5. Click the toggle to "Exclude data before row" and set the value to 2
6. Click "Save and Exit"

Create a Metric

With the data modeled, we are ready to create a Metric (or visualization) of the data to be used in the Klipfolio platform for dashboards, reporting, and more.

1. Click "Create metrics"
2. Select a Data source
3. Select a Metric value and default aggregation
4. Select Segmentation(s)
5. Select a Date & time
6. Select a Data shape
7. Configure the Display settings
8. Click Save
9. Navigate to your Metric and further configure the visualization

SQL Access to Paylocity Data from Cloud Applications

Now you have a Metric built from live Paylocity data. You can add it to a new dashboard, share, and more. Easily create more data sources and new visualizations, produce reports, and more — all without replicating Paylocity data.

To get SQL data access to 100+ SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect Cloud.