Build Paylocity-Connected Dashboards in Redash

Redash lets you connect and query your data sources, build dashboards to visualize data and share them with your company. When paired with CData Connect Server, you get instant, cloud-to-cloud access to Paylocity data for visualizations, dashboards, and more. This article shows how to create a virtual database for Paylocity and build visualizations from Paylocity data in Redash.

CData Connect Server provides a pure SQL Server interface for Paylocity, allowing you to easily build reports from live Paylocity data in Redash — without replicating the data to a natively supported database. As you build visualizations, Redash generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Server pushes all supported SQL operations (filters, JOINs, etc) directly to Paylocity, leveraging server-side processing to quickly return the requested Paylocity data.

Create a Virtual SQL Server Database for Paylocity Data

CData Connect Server uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect Server and click Connections.
2. Select "Paylocity" from Available Data Sources.
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 Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Paylocity data from Redash.

Visualize Paylocity Data in Redash

The steps below outline creating a new data source in Redash based on the virtual Paylocity database in Connect Server and building a simple visualization from the data.

Create a New Data Source

1. Log into Redash, click on your profile and click "Data Sources"
2. Click the " New Data Source" button
3. Select "Microsoft SQL Server" as the Data Source Type
4. On the configuration tab, set the following properties:
   • Name: Name the data source (e.g. Paylocity (CData Connect))
   • Host: The full URL to your CData Connect instance (e.g. https://connect_server_url)
   • Port: The port of the CData Connect SQL Server endpoint (e.g. 1433)
   • User: A CData Connect user
   • Password: The password for the above user
   • Database name: The name of the virtual database for Paylocity (e.g. Paylocity1)
   • Click the checkbox to Use SSQL
5. Click Create
6. Click the "Test Connection" button to ensure you have configured the connection properly

With the new Data Source created, we are ready to visualize our Paylocity data.

Create a Paylocity Data Visualization

1. Click Create -> New Query
2. Select the newly created Data Source (you can explore the data structure in the New Query wizard)
3. Write a SQL statement to retrieve the data, for example:
   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
4. Click the "Execute" button to load Paylocity data into Redash via CData Connect
5. Use the Visualization Editor to create and analyze graphs from Paylocity data
6. You can schedule the query to refresh and update the visualization periodically

SQL Access to Paylocity Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to Paylocity data from Redash. You can create new visualizations, build dashboards, and more. For more information on gaining SQL access to data from more than 100 SaaS, Big Data, and NoSQL sources from cloud applications like Redash, refer to our Connect Server page.