Build Apps with Live Paylocity data in Adalo using CData Connect Cloud

Adalo is a no-code platform used to build custom mobile and web applications without needing programming skills. It allows users to design interfaces, manage databases, and integrate functionality through simple drag-and-drop tools, making app development accessible and efficient. When combined with CData Connect Cloud, it provides access to Paylocity data to build custom applications and more.

This article explains how to use CData Connect Cloud to create a live connection to Paylocity and how to connect and access live Paylocity data from the Adalo platform.

Configure Paylocity connectivity for Adalo in CData Connect Cloud

To work with Paylocity data in Adalo, we need to connect to Paylocity from Connect Cloud, provide user access to the connection, and create OData endpoints for the Paylocity data.

Connect to Paylocity from Connect Cloud

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

1. Log into Connect Cloud, click Sources, and then click Add Connection

2. Select "Paylocity" from the Add Connection panel

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.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add Paylocity Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud through the REST API, Workspaces, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect Cloud. 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 Cloud 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.
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 Adalo

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).
2. Click Add to add new assets to the Workspace.
3. Select the Paylocity connection (e.g. Paylocity1) and click Next.
4. Select the table(s) you wish to work with and click Confirm.
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 Adalo.

Build a custom app with Adalo

After configuring CData Connect Cloud, you can begin developing the Adalo app using Paylocity data.

1. Click on CREATE NEW APP.
2. Select Desktop Web App and click on Next.
3. You can choose any template, but for testing purposes, we've chosen a Blank template.
4. Finally, add an app name and choose a color scheme, and your app is ready to go!

Registering external collections

Adalo uses a data structure called Collection to manage app data and offers a feature called External Collections with APIs, which lets you seamlessly integrate Collection with external APIs. Use this feature to connect to Connect Cloud.

1. After creating an app, you first need to register a Collection, which is a definition for handling data within the Adalo app. There are two types of Collections: Database Collections, which are like Adalo's own internal database, and External Collections, which allow access to external APIs. In this case, we will access an external API, registering it as an External Collection.
2. On the External Collections registration screen, click on ADD COLLECTION to enter the collection name (any name of your choice), and provide the API base URL endpoint (OData endpoint registered on Connect Cloud). Make sure to add "/(table)" to the OData URL to access the specific endpoint. (Refer to the image given for reference)
3. In order to authenticate, you need a base64 authorization header comprising your username and PAT, joined by a colon. For example, [email protected]:MY_PAT. You can use a scripting tool, web tool, or other application to create this header.

   Using Postman to generate the Authorization header

   1. Open the Postman application. Enter the OData URL mentioned in the previous step for a GET request on Postman. Click on the Authorization tab and select Auth Type as "Basic Auth". Enter the Username and Password as follows and click on Send:
      • Username: Connect Cloud Username
      • Password: PAT generated on Connect Cloud
      
   2. Go to the Headers tab and copy/save the value of the Authorization key.
4. Back in Adalo, click on ADD ITEM and select Header.
5. Enter the details in the Header section as follows:
   • Name: "Authorization"
   • Value: Authorization key value copied in the previous step
   
6. Select Done and click on Next.
7. Select Get All and enter "value" in the Results Key section. Click on Done and Next.
8. Now, to test the API setup, click on RUN TEST. If you finally see the message and response shown below, the creation of External Collections is complete.

Creating a list screen

After configuring CData Connect Cloud, you can now begin developing the app on Adalo using Paylocity data.

1. First, click the + button in the upper right corner of the Adalo screen to display the list screen, then drag and drop "Simple List" onto the screen.
2. Once the layout is complete as shown below, link the External Collections definition you created earlier to What is this a list of?
3. Click on "Add Magic Text" button (as shown) to add the "Title" and "Subtitle" to the data items you want to obtain.
4. Now, click on View App in the top right corner of the screen and select Staging Preview.
5. You can now view the Paylocity data in the app created on Adalo.

Live connections to Paylocity data from cloud applications

Adalo now allows you to connect to live Paylocity data directly, allowing you to create more connections and apps without duplicating Paylocity data.

To get real-time data access to over 100 SaaS, big data, and NoSQL sources directly from your cloud applications, visit CData Connect Cloud.