Connect to Real-Time Paylocity Data in Power Apps Using Dataflows to Build Custom Applications

Power Apps is a suite of apps, services, and connectors that allows users to build custom applications with minimal or no coding. It empowers businesses to create tailored apps that solve specific business challenges, automate workflows, and integrate with various data sources, including Microsoft Dataverse, SQL Server, and third-party services.

Dataflows in Power Apps simplify the process of importing, transforming, and loading external data into Microsoft Dataverse or other storage systems. They allow users to connect to multiple data sources (like Salesforce, Excel, or SQL databases), clean or shape the data, and store it in Power Apps. When paired with the CData Power BI Connector for Paylocity, it provides access to Paylocity data to build custom applications and more

This article demonstrates how you can easily connect to Paylocity using the CData Power BI Connector for Paylocity and integrate your Paylocity data through the Power Apps on-premises data gateway.

Configure a DSN to connect to Paylocity data

Installing the Power BI Connector creates a DSN (data source name) called CData PBI Paylocity Sys. This the name of the DSN that Power BI uses to request a connection to the data source. Configure the DSN by filling in the required connection properties.

You can use the Microsoft ODBC Data Source Administrator to create a new DSN or configure (and rename) an existing DSN: From the Start menu, enter "ODBC Data Sources." Ensure that you run the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit).

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.

Configure the on-premises data gateway to recognize the CData Power BI Connector for Paylocity

In this section, we will configure the on-premises data gateway to detect the CData Power BI Connector for Paylocity installed on your system. If you haven't installed the data gateway yet, you can download it from Microsoft's official website.

Set Up the Power BI Gateway

Follow the given process to configure the on-premise data gateway on your machine:

1. Download and install the on-premises data gateway (recommended) option. 👁 Install the On-Premise Data Gateway
   
2. Sign into the gateway. 👁 Sign into the gateway using your email-id
   
3. Create a name for the new gateway and specify a recovery key. 👁 Add a name and a recovery key to the gateway
   
4. Open the new gateway, navigate to the Connector tab, and select the path C:\Program Files\CData\CData Power BI Connector for Paylocity from the folder. Click on Apply. 👁 The new gateway is now configured and ready to be used
   👁 Add the installation path to the CData Power BI Connector for Paylocity
   

   NOTE: Select the folder where the gateway will search for the CData Power BI Connector.

5. Once the CData Power BI Connector for Paylocity is identified by the gateway, you're good to go. 👁 The CData Power BI Connector for Paylocity is identified by the gateway
   

Configure a dataflow connection in Power Apps

Once the on-premise data gateway is configured and a new gateway is created, follow these steps to create a dataflow that pulls in the Paylocity data into Power Apps:

1. Open Power Apps. 👁 Open Power Apps
   
2. Select Dataflows from the left panel on the Power Apps screen and click + New Dataflow. 👁 Create a new dataflow
   
3. Provide a name to the dataflow and click Create. 👁 Add a name to the dataflow
   
4. Select ODBC from the list of data sources. 👁 Select ODBC
   
5. On the ODBC Connection settings screen, use the connection details you set up earlier by entering DSN=Connection name (in this case, DSN=CData PBI Paylocity Sys) in the connection string. The on-premise data gateway will display available gateways for connection - select the one you created. Due to the current specifications of Power Apps dataflows, authentication is required for ODBC connections. Choose Basic as the authentication type and enter the Paylocity Username and Password. Click Next. 👁 Configure the connection settings
   
6. Paylocity is now connected to Power Apps. Under Display options, expand CData under ODBC and Paylocity under CData, and a list of all the Paylocity tables will appear in the panel. When you select any one of these tables, a preview will appear, showing that the Paylocity data is correctly referenced through the Power BI connector and on-premise data gateway. Next, click on Transform Data. 👁 Click on Transform Data
   
7. On the query editing screen, if no column conversion is needed, you can skip this step and proceed by clicking on Next. 👁 Click on Next
   
8. In the Choose destination settings screen, you can select how the selected table needs to be loaded by choosing options like Load to new table, Load to existing table, and Do not load. You can also change the Table display name and description as required. 👁 Select how the table needs to be loaded
   👁 Choose the destination settings
   
9. Finally, choose how you'd like to update your data: Refresh manually or Refresh automatically. In this case, we have set it to Refresh automatically. By scheduling it to update every 45 minutes, as shown below, data will be collected and registered every 45 minutes timeframe, ensuring the most up-to-date information is always available. (You can select any timeframe based on your convenience) 👁 Choose among the two refresh settings
   
10. Click on Publish. The dataflow will now be created, published, and displayed as a part of the dataflow list on the Dataflows screen. 👁 Publish the dataflow
    

Get Started Today

At this point, you will have created a dataflow using live Paylocity data and connected it to Power Apps. To learn more, explore the CData Power BI Connectors for Salesforce and download a free 30-day trial from the CData Power BI Connector for Paylocity page.

Feel free to reach out to our Support Team with any questions.