Visualize Paylocity Data in Tableau

The CData ODBC Driver for Paylocity enables you to access live Paylocity data in business intelligence tools like Tableau. In this article, you will integrate Paylocity data into a dashboard that reflects changes to Paylocity data in real time.

The CData ODBC drivers offer unmatched performance for interacting with live Paylocity data in Tableau due to optimized data processing built into the driver. When you issue complex SQL queries from Tableau to Paylocity, the driver pushes supported SQL operations, like filters and aggregations, directly to Paylocity and utilizes the embedded SQL engine to process unsupported operations (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can visualize and analyze Paylocity data using native Tableau data types.

Connect to Paylocity as an ODBC Data Source

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Add Paylocity Data to a Dashboard

1. Click Connect to Data -> More Servers -> Other Databases (ODBC).
   Select the CData Data Source Name (for example: CData Paylocity Source).
2. In the Database menu, select CData.
3. In the Table box, enter a table name or click New Custom SQL to enter an SQL query. This article retrieves the Employee table.
4. Drag the table onto the join area. At this point, you can include multiple tables, leveraging the built-in SQL engine to process complex data requests. 👁 A connection to a single table. (Google Sheets is shown.)
   
5. In the Connection menu, select the Live option, so that you skip loading a copy of the data into Tableau and instead work on real-time data. The optimized data processing native to CData ODBC drivers enables unmatched performance in live connectivity.
6. Click the tab for your worksheet. Columns are listed as Dimensions and Measures, depending on the data type. The CData driver discovers data types automatically, allowing you to leverage the powerful data processing and visualization features of Tableau.
7. Drop the FirstName column in the Dimensions pane onto the dashboard. When you select dimensions, Tableau builds a query to the driver. The results are grouped based on that dimension. In Tableau, the raw query is automatically modified as you select dimensions and measures.

8. Drag the LastName column in the Measures field onto the Detail and Color buttons. Tableau executes the following query:

   SELECT FirstName, SUM(LastName) FROM Employee GROUP BY FirstName
   

   When you select a measure, Tableau executes a command to the driver to calculate a summary function, such as SUM, AVG, etc., on the grouped values. The SQL engine (embedded within the driver) is leveraged to process the aggregation of the data, where needed, providing a seamless experience in Tableau, regardless of the data source.

   To change the summary function, open the LastName menu and select the summary you want in the Measure command.

   👁 A simple visualization that shows the latest data.
   

9. You can create other charts using dimensions and measures to build SQL queries visually:

   👁 A dashboard with several visualizations. The SQL query that corresponds to each chart is shown next to the chart. (Google Sheets is shown.)
   

With the CData ODBC Driver for Paylocity, you get live connectivity to your Paylocity data, allowing you to build real-time charts, graphs, and more.