Build Paylocity-Connected Apps in Bubble

Bubble is a no-code platform that simplifies the process of developing and launching apps and businesses. When coupled with CData Connect AI, you gain effortless no-code access to Paylocity data for streamlined app development. This article guides you through the integration process from Bubble to Paylocity using CData Connect AI.

CData Connect AI provides a pure cloud-to-cloud OData interface for Paylocity data that allows you to integrate from Bubble to Paylocity data in real time.

Connect to Paylocity from Bubble

To work with Paylocity data from Bubble, 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 Bubble

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 Bubble.

Build a Paylocity-Connected App

With OData endpoints added to Connect AI, you can build an app in Bubble with live access to Paylocity data.

Configure the Bubble API Connector

To start, Configure the API Connector for accessing CData Connect AI from Bubble.

1. In your app, click the Plugins tab and click Add plugins
2. Search for "API Connector" and click Install 👁 Installing the API Connector plugin
   
3. After installation, click the "Add another API" button and configure the API:
   • Name the API
   • Set Authentication to "HTTP Basic Auth"
   • Set Username to a Connect AI user (e.g. [email protected])
   • Set Password to the PAT for the user
   • Expand the API Call, select the "GET" command and set the URL to a Workspace endpoint you previously configured (e.g. https://cloud.cdata.com/api/odata/{workspace_name}/Employee)
   👁 Configuring the API Call
   
4. Click the "Initialize call" button to adjust data types in the response (as needed) 👁 Initializing the call
   
5. After making any necessary changes, click "Save" 👁 Saving the data types
   

Configure the App UI

With the API Connector configure, you are ready to retrieve Paylocity data in your Bubble app. In this article, we request the data with a UI component that can display an Excel-like table.

1. On the Plugin tab, install the "Excel-like HandsonTable" 👁 Adding the Excel-like HandsonTable plugin
   
2. On the Design tab, add an "Excel Table" to the workspace 👁 Adding an Excel Table to the app
   
3. In the Excel Table, in Data source, select "Get data from an external API"
4. Set Type of content to "API Call value"
5. Set Data source to "CData Connect AI - API Call's value" (or equivalent) 👁 Binding the Excel Table to the API Call
   
6. Click "Preview" to ensure the data was retrieved from Paylocity. 👁 Previewing the app
   

At this point, you can develop applications with live access to Paylocity data without needing to know the complexities of the back-end API.

Live Access to Paylocity Data from Cloud Applications

Now you have a direct connection to live Paylocity data from Bubble. You can create more Paylocity-connected apps — all without writing any code or replicating Paylocity data.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, see the CData Connect AI.