VOOZH about

URL: https://www.cdata.com/kb/tech/paylocity-cloud-powerapps.rst

⇱ Integrate Live Paylocity Data into Custom Business Apps Built in Power Apps


Integrate Live Paylocity Data into Custom Business Apps Built in Power Apps

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Connect AI to connect to Paylocity data and integrate live Paylocity data into apps built in Microsoft Power Apps.

Power Apps is a service for building and using custom business apps that connect to your data and work across the web and mobile β€” without the time and expense of custom software development. When paired with CData Connect AI, you get instant, cloud-to-cloud access to Paylocity data from the apps you build using Power Apps. This article shows how to connect to Connect AI from Power Apps and build an app based on live Paylocity data.

CData Connect AI provides a pure SQL, cloud-to-cloud interface for Paylocity, allowing you to easily integrate with live Paylocity data in Power Apps β€” without replicating the data. CData Connect AI looks exactly like a SQL Server database to Power Apps 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 Apps

Connectivity to Paylocity from Power Apps is made possible through CData Connect AI. To work with Paylocity data from Power Apps, we start by creating and configuring a Paylocity connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. πŸ‘ Adding a Connection
  3. Select "Paylocity" from the Add Connection panel
  4. πŸ‘ Selecting a data source
  5. 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)

  6. Click Save & Test
  7. 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 Apps.

Connecting to CData Connect AI

To use Connect AI to integrate Paylocity data into your Power Apps, you need a new SQL Server connection:

  1. Log in to Power Apps
  2. Click Dataverse -> Connections -> New connection
  3. Select SQL Server πŸ‘ Creating a new SQL Server Connection
  4. In the connection wizard:

    • Choose to connect directly
    • Set SQL server name to tds.cdata.com,14333
    • Set SQL database name to the name of the Paylocity connection (e.g. Paylocity1)
    • Set Username to a Connect AI user (e.g. [email protected])
    • Set Password to the PAT for the above user
    • Click Create πŸ‘ Connecting to Connect AI

Building a Data-Centric App for Paylocity Data

With the connection to Connect AI configured, you are ready to integrate live Paylocity data into the apps you build in Power Apps.

  1. Log in to Power Apps
  2. Click Create and select "SQL" πŸ‘ Creating a new app from data
  3. Select the SQL Server connection you created
  4. Search for or choose a table to work with
  5. Click Connect πŸ‘ Connecting to Paylocity data
  6. Customize the newly created app just like you would any other, including changing the layout and setting the fields exposed in BrowseScreen, DetailScreen, and EditScreen πŸ‘ Customizing the Paylocity data app

At this point, you have an app with read and write access to live Paylocity data that you can save and publish for use within your organization.

SQL Access to Paylocity Data from Cloud Applications

Now you have a direct connection to live Paylocity data from Microsoft Power Apps. You can create more connections and apps to 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.