Visualize Paylocity Data in Tableau Desktop (through CData Connect)

Tableau is a visual analytics platform transforming the way businesses use data to solve problems. When paired with CData Connect (or Connect Server), you can easily get access to live Paylocity data within Tableau.

CData Connect Server provides a pure SQL Server interface for Paylocity, allowing you to easily build reports from live Paylocity data in Tableau Desktop — without replicating the data to a natively supported database. As you build visualizations, Tableau Desktop 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.

This article shows how to create a virtual SQL Server database for Paylocity, connect to the virtual database in Tableau, and build a simple chart.

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 Tableau Desktop.

Visualize Live Paylocity Data in Tableau Desktop

The steps below outline connecting to the virtual Paylocity database in CData Connect and building a simple visualization from the data.

1. Open Tableau and click "Microsoft SQL Server" under Connect -> To a Server.
2. In the connection wizard, enter the values for your CData Connect instance and click "Sign In"
   • Server: the address of your Connect instance and port of the TDS endpoint, separated by a comma (default port is: 1433)
   • Database: the virtual database you configured for the Paylocity data
   • Username & Password: the credentials for a CData Connect user
3. Select your newly created database and the table(s) you wish to visualize (defining relationships for JOINed tables as needed).
4. Select Dimensions and Measures and configure your visualization.

SQL Access to Paylocity Data from On-Premise Applications

At this point, you have a direct connection to live Paylocity data from your Tableau Desktop workbook. You can create new visualizations, build dashboards, and more. For more information on gaining SQL access to data from more than 200 SaaS, Big Data, and NoSQL sources (including Paylocity) from desktop applications like Tableau refer to our CData Connect page or download a free trial.