Work with Live Paylocity Data in Power Query

Power Query is a data transformation and data preparation engine. When paired with CData Connect AI, you get instant, cloud-to-cloud access to Paylocity data from Power Query. This article shows how to connect to Connect AI from Power Query through Microsoft Excel and get live access to Paylocity data for transformation and preparation.

CData Connect AI provides a pure SQL, cloud-to-cloud interface for Paylocity, allowing you to easily integrate with live Paylocity data in Power Query — without replicating the data. CData Connect AI looks exactly like a SQL Server database to Power Query and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to Paylocity, leveraging server-side processing to quickly return Paylocity data.

Configure Paylocity Connectivity for Power Query

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

Working with Live Paylocity Data in Power Query

With the connection to Connect AI configured, you are ready to work with live Paylocity data in Power Query.

1. In Microsoft Excel, open the Power Query Editor (from the Data ribbon, click Get Data -> Launch Power Query Editor) 👁 Opening the Power Query Editor
   
2. Click New Source -> SQL Server 👁 Creating a new SQL Server Source
   
3. In the SQL Server database modal:
   • Set Server to tds.cdata.com,14333
   • (Optional) Set Database to the name of the Paylocity connection (e.g. Paylocity1 )
   👁 Configuring the Server
   
4. In the SQL Server credentials modal, select "Database" and
   • Set User to your Connect AI username (e.g. [email protected] )
   • Set Password to the PAT for the above user
   👁 Configuring the credentials
   
5. Click Connect
6. Select the table(s) you wish to work with in the Navigator and click "OK" 👁 Selecting the table(s) (Salesforce is shown)
   

At this point, you have live access to Paylocity data from Power Query for transformation and preparation.

SQL Access to Paylocity Data

Now you have a direct connection to live Paylocity data from Microsoft Power Query. You can create more connections and transform and preparte your data to better drive business — all without replicating Paylocity data.

To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, sign up for a free trial of CData Connect AI.