Visualize Paylocity Data from Tableau

With CData Drivers for Paylocity, you can use data access standards to unlock connectivity to business intelligence tools like Tableau. The CData JDBC Driver for Paylocity allows you to connect from Tableau on Windows and macOS. This article covers how to discover schemas and query Paylocity data data in real-time.

NOTE: If you are using Tableau 2020.3 or higher, you can use the CData JDBC Driver for Paylocity. If you wish to connect to Paylocity data in Tableau Cloud, you will need to use CData Connect Cloud.

Connect to Paylocity in Tableau

Before starting Tableau, make sure you've placed the .jar file in the correct folder:

• Windows: C:\Program Files\Tableau\Drivers
• MacOS: ~/Library/Tableau/Drivers

Once your .jar file is in place, establishing a connection is straightforward.

1. Start Tableau.
2. Under To a Server, select More.
3. Select Other Databases (JDBC)
4. Enter the JDBC connection string in the URL field.

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.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Paylocity JDBC Driver. Either double-click the .jar file or execute the .jar file from the command-line.

From Windows:

java -jar 'C:\Program Files\CData[product_name]\lib\cdata.jdbc.paylocity.jar'

From MacOS:

java -jar cdata.jdbc.paylocity.jar

Fill in the connection properties and copy the connection string to the clipboard.

When you configure the JDBC URL, 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.

The following is a sample URL created in the designer:

jdbc:paylocity:OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH;
5. Select Sign in.

Discover Schemas and Query Data

1. Select CData from the Database pull-down menu.
2. Select CData from the Schema pull-down menu.
3. Drag the table onto the join area. You can include multiple tables.
4. Select Update Now or Automatically Update. Update Now lets you preview the first 10,000 rows of the data source (or enter the number of rows you want to see in the Rows text box). Automatically Update automatically reflects the changes in the preview area.
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.
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. Click and drag a field from the Dimensions or Measures area to Rows or Columns. Tableau creates column or row headers.
8. Select one of the chart types from the Show Me tab. Tableau displays the chart type that you selected.

Using the CData JDBC Driver for Paylocity with Tableau, you can easily create robust visualizations and reports on Paylocity data. Download a free, 30-day trial and get started today.