Create Data Visualizations Based On Paylocity Data in Mode

Mode is a collaborative data platform that combines SQL, R, Python, and visual analytics in one place. When paired with CData Connect AI, you get instant, cloud-to-cloud access to Paylocity data for use in data visualizations. This article shows how to connect to Paylocity in Connect AI, connect to Paylocity data in Mode, and create a simple visualization using that data.

CData Connect AI provides a pure cloud-to-cloud interface for Paylocity, allowing you to build data visualizations from live Paylocity data in Mode — without replicating the data to a natively supported database. In order to create visualizations, users write 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 the requested Paylocity data.

Configure Paylocity Connectivity for Mode

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

Connect to Paylocity in Mode

The steps below outline connecting to CData Connect AI from Mode to create a new Paylocity data source.

1. Log-in to Mode 👁 Logging In
   
2. In the top-left corner of the screen, click the down-arrow next to your name and select Connect a Database... 👁 Selecting Connect to Database
   
3. On the next screen, select Microsoft SQL Server. 👁 Selecting Microsoft SQL Server
   
4. Enter the Microsoft SQL Server credentials:
   • Display Name: the name for the connection.
   • Host/Port: enter tds.cdata.com in the Host field and 14333 in the Port field.
   • Database name: enter the Connection Name of the CData Connect AI data source you want to connect to (for example, Paylocity1).
   • 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 generated on the Settings page
   Leave the rest of the connection settings at their default values unless you need to modify them. 👁 Configuring connection settings
   
5. At the bottom of the page, click Connect to ensure that you can connect to CData Connect AI.
6. Upon success, the following screen appears. 👁 New database connection added.
   

Your connection is now available for use in Mode. To connect to additional data sources from your CData Connect AI account, repeat the setup steps above, changing the value for Database for each data source.

Creating A Mode Visualization

To create a visualization in Mode, follow these steps:

1. On the current screen, click New Report. The SQL query text editor appears. Enter the following query:

   			SELECT * FROM [Paylocity].[Employee];
   		

   Click Run. The app now shows the query result: 👁 Showing SQL query result.
   
2. Running the query activates the New Chart tab. Click this tab and select Pie Chart. 👁 Selecting pie chart.
   
3. Now, drop a dimension in the Color section and a measure in the Angle section. 👁 Creating visualization.
   

   We have now created a visualization of Paylocity data in Mode using CData Connect AI!

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!