How to connect Amazon QuickSight to Paylocity Data

Amazon QuickSight allows users to build interactive dashboards in the cloud. When paired with CData Connect AI, you get cloud-to-cloud access to Paylocity data for visualizations, dashboards, and more. This article shows how to connect to Paylocity in Connect AI and build dashboards in Amazon QuickSight with access to Paylocity data.

CData Connect AI provides a pure cloud-to-cloud interface for Paylocity, allowing you to allowing build visualizations from Paylocity data in Amazon QuickSight. By importing your Paylocity data into the Amazon QuickSight "Super-fast, Parallel, In-memory Calculation Engine" (SPICE), you can leverage the powerful data processing features of the Amazon ecosystem to build responsive dashboards. And with the ability to schedule refreshes of the data stored in SPICE, you control how up-to-date your dashboards are.

Configure Paylocity Connectivity for Amazon QuickSight

Connectivity to Paylocity from Amazon QuickSight is made possible through CData Connect AI. To work with Paylocity data from Amazon QuickSight, 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 Amazon QuickSight.

Import Paylocity Data into SPICE and Create Interactive Dashboards

The steps below outline creating a new data set based on the connection to Paylocity in Connect AI, importing the dataset into SPICE, and building a simple visualization from the data.

1. Log into Amazon QuickSight and click "Manage data."
2. Click "Now data set," select SQL Server as the data source, configure the connection to your Connect AI instance, and click "Create data source." 👁 Connecting to Connect AI as a QuickSight data set.
   
3. Select a table to visualize (or subait a custom SQL query for your data). 👁 Selecting a Table to visualize.
   
4. Click "Edit/Preview data" to customize the data set.
5. Select "Import to SPICE for quicker analytics" and click "Visualize." 👁 Importing data to SPICE for quicker analytics.
   
6. Select fields to visualize and a visual type. 👁 Visualizing data in QuickSight via Connect AI (Salesforce is shown).
   

Schedule Refreshes for SPICE Data Sets

QuickSight users can schedule refreshes for data sets that are imported into SPICE, ensuring that data being analyzed is only as old as the most recent refresh.

1. Navigate to the QuickSight home page.
2. Click "Manage data."
3. Select the data set you wish to refresh.
4. Click "Schedule refresh."
5. Click Create, configure the refresh settings (time zone, repeat frequency, and starting datetime), and click Create. 👁 Scheduling a refreshing of the data imported into SPICE.
   

Live Access to Paylocity Data from Cloud Applications

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