Use CData Connect AI to Access Paylocity Data in Microsoft Power Pivot

This article will explain how to use CData Connect AI to present Paylocity data as OData services and then consume the data in Microsoft Excel's Power Pivot business intelligence tool. Follow the steps below to retrieve and edit Paylocity data in Power Pivot.

Connect to Paylocity from Power Pivot

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

Connect to Paylocity from Connect AI

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

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.

Configure Paylocity Endpoints for Power Pivot

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). 👁 The Workspaces page.
   👁 Adding a new Workspace.
   
2. Click Add to add new assets to the Workspace.
3. Select the Paylocity connection (e.g. Paylocity1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
   
4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
   
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 Power Pivot.

Import Paylocity Tables in Power Pivot

Follow the steps below to import tables that can be refreshed on demand:

1. In Excel, click Data -> Get Data -> From Other Sources -> From OData Feed 👁 Starting the OData connection.
   
2. Fill out the OData feed URL (e.g. https://cloud.cdata.com/api/odata/{workspace_name}) 👁 The URL of the OData endpoint for Connect AI.
   
3. On the next screen, select Basic and configure the username and password. Password will be your PAT. 👁 Authenticating with Connect AI
   

4. Select the tables that you would like to import into Excel 👁 Selecting tables (Salesforce is shown.)
   

5. After selecting your table(s) and clicking Load, you should see the data appear in an Excel spreadsheet 👁 Loading tables (Salesforce is shown.)
   

6. Now, click the Power Pivot tab on the ribbon, and then select Add to Data Model. 👁 Loading data into Power Pivot (Salesforce is shown.)
   This can now work with your Paylocity data in Power Pivot.

   👁 The Pivot Table that is consuming OData feeds from Connect AI. (Salesforce is shown.)
   

Free Trial & More Information

If you are interested in connecting to your Paylocity data (or data from any of our other supported data sources) from Power Pivot, sign up for a free trial of CData Connect AI today! For more information on Connect AI and to see what other data sources we support, refer to our CData Connect AI page.