Build Paylocity Visualizations in Tableau Desktop

Tableau is a visual analytics platform transforming the way businesses use data to solve problems. When paired with CData Connect AI, you get instant, cloud-to-cloud access to Paylocity data for visualizations, dashboards, and more. This article shows how to connect to Paylocity and build visualizations from Paylocity data in Tableau.

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

Configure Paylocity Connectivity for Tableau

Connectivity to Paylocity from Tableau is made possible through CData Connect AI. To work with Paylocity data from Tableau, we start by creating and configuring a Paylocity connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "Paylocity" from the Add Connection panel
👁 Selecting a data source

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. 👁 Configuring a connection (Salesforce is shown)
   

4. Click Save & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
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 and a PAT generated, you are ready to connect to Paylocity data from Tableau.

Visualize Live Paylocity Data in Tableau

To establish a connection from Tableau Desktop to the CData Connect AI Virtual SQL Server, follow these steps.

1. In Tableau Desktop, open a new book. Under To a Server, select More, then Microsoft SQL Server. 👁 Selecting Microsoft SQL Server as the connection type.
   
2. Enter your credentials:
   • Server: enter the Virtual SQL Server endpoint and port separated by a comma: tds.cdata.com,14333
   • Database: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Paylocity1).
   • Authentication: select Use a specific username and password.
   • Username: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
   • Password: enter the PAT you previously generated.
   • Require SSL: leave this selected.
   👁 Configuring the connection to the Virtual SQL Server API.
   
3. Click Sign In.
4. Select the Database (Connect AI connection) you wish to work with and opt for a Live or Extract Connection type.
5. Select the table(s) you wish to visualize. If you select multiple tables, define the relationship between the tables using the appropriate columns. 👁 Selecting tables to visualize (Salesforce is shown)
   
6. Select the fields to visualize. 👁 Visualizing live data (Salesforce is shown).
   

Real-Time Access to Paylocity Data from Data Applications

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