Build Paylocity Visualizations in Tableau Cloud

Tableau Cloud is an analytics platform fully hosted in the cloud. When paired with CData Connect Cloud, 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 Cloud.

CData Connect Cloud provides a pure cloud-to-cloud interface for Paylocity, allowing you to easily build visualizations from live Paylocity data in Tableau Cloud without installing connectors or publishing worksheets and data sources from Tableau Desktop. As you build visualizations, Tableau Cloud generates SQL queries to gather data. Using optimized data processing out of the box, CData Connect Cloud 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 Cloud

To work with Paylocity data from Tableau Cloud, we need to connect to Paylocity from Connect Cloud, provide user access to the connection, and create a Workspace for the Paylocity data.

Connect to Paylocity from Connect Cloud

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

1. Log into Connect Cloud, click Sources, and then click Add Connection

2. Select "Paylocity" from the Add Connection panel

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 Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud 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 Cloud. 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 Cloud 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.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Paylocity Endpoints for Tableau Cloud

After connecting to Paylocity, create a workspace for your desired table(s).

1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
2. Click Add to add new assets to the Workspace.
3. Select the Paylocity connection (e.g. Paylocity1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Paylocity data from Tableau Cloud.

Visualize Live Paylocity Data in Tableau Cloud

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

1. Log into Tableau Cloud, select a account, and create a new workbook.
2. In the new workbook, choose the OData Connector from the data wizard and fill in the values for your Connect Cloud instance.
   • Set Server to the OData URL for your Workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}
   • Set Authentication to Username and Password
   • Set Username to your Connect Cloud username (e.g. [email protected])
   • Set Password to a PAT for the above user
   
3. Select your newly created database and the table(s) you wish to visualize (defining relationships for JOINad tables as needed).

4. Select Dimensions and Measures and configure your visualization.

Real-Time Access to Paylocity Data from Cloud Applications

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