Create Paylocity Dataflows on PowerBI.com

The CData Power BI Connector for Paylocity seamlessly integrates with the tools and wizards in Power BI, including the real-time data workflows on PowerBI.com. Follow the steps below to pull data directly into DataFlows on PowerBI.com and use the Power BI Gateway to configure automatic refresh.

Create a DSN

Installing the Power BI Connector creates a DSN (data source name) called CData Power BI Paylocity. 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.

Pulling Paylocity Data Directly Into Your Dataflow

With the data source configured, follow the steps below to load data from Paylocity tables into your DataFlow.

Set Up the Power BI Gateway

Follow the steps below to configure the gateway on your machine:

1. Run the CData Power BI Connector installer. If you have not already done so, download the Power BI Gateway.
2. Select the on-premises data gateway (recommended) option.
3. Sign into the gateway.
4. Name the gateway and specify a recovery key.

5. In the Connectors step, choose a folder where the gateway will look for the CData Power BI Connector. This article uses C:\Users\PBIEgwService\Documents\Power BI Desktop\Custom Connectors\. Copy the .pqx files for the CData Connector (found in C:\Users\USERNAME\Documents\Power BI Desktop\Custom Connectors\) to the folder you configured.

   NOTE: The account configured for the service (NT SERVICE\PBIEgwService) needs to be able to access the folder chosen for the gateway. If needed, you can change the service account in the Service Settings section of the gateway installer.

6. Confirm that the entry CData.PowerBI.Paylocity is displayed in the list in the Connectors section. 👁 CData Power BI Connectors in the On-Premises Data Gateway.
   

Set up Power BI Online for a Dataflow

1. In Power BI Online, create a new workspace, which is also known as an app, if you do not already have one. Note that this is only available with Power BI Pro or higher.
2. Set up your On-Premises Gateway. The steps for this are in the Configuring the Gateway section of this article.
3. Go back to Power BI Online. In settings, go to 'Manage Gateways', and add a new data source to your Gateway
   • Enter the Data Source Name, the name that the data source will be referred to within Power BI Online
   • Select the Data Source Type, (e.g. CData Power BI Connector for Paylocity) and set the Data Source Name (e.g. CData Power BI Paylocity)
   • Set Authentication Method to "Anonymous" 👁 Configuring the connection for the gateway.
     
   • Set Privacy Level as needed
4. Click Add to finish the configuration (do not skip the test connection as it is important to know if a successful connection was made).
   
   If you would like to manage the users that have access to this data source, you can go to the Users tab.

Set up your Dataflow and pull the Paylocity data

1. In the new workspace, go to Create > Dataflow > Add New Entities.
2. Choose the ODBC data source and enter the correct connection properties.
   👁 Connect to the data source for the CData Power BI connector.
   Enter your DSN name in the ODBC connection string section, dsn=CData Power BI Paylocity. Choose your gateway and set the authentication type to Anonymous.
3. Choose the table(s) you want to work with and click Transform data.
   If you want to make any changes to the query, you can right click on the query and click on Advanced Editor.

Configure Data Refresh on PowerBI.com

Refresh your dataflow to have the most up to date data.

• To refresh manually, open the dataflow options menu from your workspace -> Dataflows and click Refresh Now.
• To schedule refreshes, open the dataflow options menu from your workspace -> Dataflows and click Schedule Refresh. Enable the option to keep your data up to date. Specify the refresh frequency in the menus.

👁 Scheduled refresh of Dataflow.

At this point, you will have a Dataflow built on top of live Paylocity data. Learn more about the CData Power BI Connectors for Paylocity and download a free trial from the CData Power BI Connector for Paylocity page. Let our Support Team know if you have any questions.