Create Paylocity-Connected Business Apps in AppSheet

Google AppSheet is a no-code development platform for application software, enabling users to design mobile, tablet, and web applications. When combined with CData Connect AI, you gain immediate cloud-to-cloud access to Paylocity data for business applications. This article outlines the process of connecting to Paylocity using Connect AI and constructing a basic app from Paylocity data within AppSheet.

CData Connect AI offers a dedicated cloud-to-cloud interface for Paylocity, enabling the creation of reports directly from live Paylocity data within AppSheet, all without the need for data replication to a native database. When you design applications that interact with data, AppSheet formulates SQL queries to retrieve the required information. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to Paylocity. This leverages server-side processing to swiftly deliver the requested Paylocity data.

Configure Paylocity Connectivity for AppSheet

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

Connect to Paylocity from AppSheet

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

1. Log into AppSheet
2. Click "My account" in the menu
3. Click the Sources tab and add a new data source 👁 Creating a new data source
   
4. Select Cloud Database and set the connection information
   • Type: Sql Server
   • Server: tds.cdata.com,14333
   • Database: the Paylocity connection, for example, Paylocity1
   • Username: a Connect AI user, for example, [email protected]
   • Password: the PAT for the above Connect AI user
   • SSL: Require SSL
   👁 Connecting to Connect AI
   
5. Click "Test Connection"
6. Click "Authorize Access"

Create an App

Once you create the data source for Paylocity, you can start building apps on Paylocity data. Start by clicking "My apps" in the menu.

1. Click to create a new app and select "Start with your own data"
2. Name the app and select an appropriate category, based on your data
3. Select the newly created data source
4. Select the table or view with the data you want 👁 Selecting a table
   

At this point, you can configure the design of your app, selecting which columns from the selected table to display, use as labels, and more. Preview the app in the preview panel and then publish or share it when ready.

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