Publish Real-Time Paylocity Data to 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 publish reports to 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.

Get Paylocity Data

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

Select Tables and Views to Load

1. Open Power BI Desktop and click Get Data -> CData Paylocity.
2. Select CData Power BI Paylocity in the Data Source Name menu and select the Import data connectivity mode.
3. Expand the CData Power BI Paylocity folder, expand an associated schema folder, and select tables.

Shaping Data

Use the Query Editor if you need more control over the query and query results before you load the data. Power BI detects the column behavior from the Paylocity metadata retrieved by the CData connector. In the Query Editor, you can perform actions like filtering, summarizing, and sorting on columns.

To open the Query Editor, click Edit in the Navigator window. Right-click a row to filter the rows. Right-click a column header to perform actions like the following:

• Change column data types
• Remove a column
• Group by columns

Power BI records your query modifications in the Applied Steps section, adjusting the underlying data retrieval query that is executed to the remote Paylocity data.

Load Data

When you click Load, the connector executes the underlying query to Paylocity.

Create Data Visualizations

After loading Paylocity data into Power BI, you can create data visualizations in the Report view by dragging fields from the Fields pane onto the canvas. Follow the steps below to create a pie chart:

1. Select the pie chart icon in the Visualizations pane.
2. Select a dimension in the Fields pane: for example, FirstName.
3. Select a measure in the Fields pane: for example, LastName.

You can change sort options by clicking the ellipsis (...) button for the chart. Options to select the sort column and change the sort order are displayed.

You can use both highlighting and filtering to focus on data. Filtering removes unfocused data from visualizations; highlighting dims unfocused data. You can highlight fields by clicking them:

You can apply filters at the page level, at the report level, or to a single visualization by dragging fields onto the Filters pane. To filter on the field value, select one of the values that are displayed in the Filters pane.

Click Refresh to synchronize your report with any changes to the data.

Configure Data Refresh on PowerBI.com

Follow the steps below to configure automatic data refresh through the Power BI Gateway. The gateway enables the Power BI cloud service to connect to the DSN on your machine.

Selecting a Gateway Mode

You need to select a gateway mode when you install the gateway:

• Gateway (personal mode): Use the gateway in personal mode if you only need to publish to PowerBI.com and refresh reports. The gateway runs under your Windows user account.
• Gateway (formerly Enterprise): Use the default gateway if you are using other Azure services that require a gateway. You also need the default gateway if multiple users need to access the gateway.
  You need a system DSN to connect through the default gateway. (System DSNs can be accessed system-wide, while user DSNs can only be used by a specific user account.) You can use the CData Power BI Paylocity system DSN configured as the last step of the connector installation.

Configuring the Gateway (Personal Mode)

Publishing through the gateway in personal mode simply requires an installed gateway with access to custom connectors.

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 (personal mode) option.
3. Sign into the gateway.
4. Name the gateway and specify a recovery key.
5. In the Connectors section of the gateway settings, enable the custom data connectors option. You can also specify an alternate path to the custom data connector .pqx files here.
   Note: The CData Power BI Connectors install the .pqx files to the default folder, Your User Home\Documents\Power BI Desktop\Custom Connectors.

Configuring the Gateway

Publishing through the gateway requires an installed gateway with access to customer connectors and a configured connection to the DSN for Paylocity from PowerBI.com

1. Set Up the 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.

2. Connect to Paylocity Data from PowerBI.com

1. Add a data source to the gateway: Log into PowerBI.com and from the Settings menu, select Manage Gateways and select your gateway.
2. Select the option to "Allow user's custom data connectors to refresh through this gateway cluster."
3. Click Apply to save your changes.
4. Click the option to add a data source to the gateway.
5. In the Data Source Settings section, enter a name for the data source and in the Data Source Type menu select CData Power BI Connector for Paylocity.
6. In the Data Source Name box that is displayed, enter the system DSN: CData Power BI Paylocity.

Publish to PowerBI.com

You can now publish refreshable reports and their underlying datasets. Follow the steps below to publish and complete the data refresh configuration for a dataset.

1. In Power BI Desktop, click Publish on the Home ribbon to publish the report.
2. On PowerBI.com, select the workspace where you uploaded the report.
3. In the Datasets section, click the options menu for the Paylocity dataset you created, then click Settings.
4. In the Gateway Connection section, enable the option to use a gateway and select your gateway. You may need to manually add the data source to the gateway:
   1. Expand the Gateway under the Actions column
   2. Click the link to "Manually add to gateway"
   3. In the "New connection" form, set the Connection name, set Data Source Name to the same data source name as above (e.g. "CData PBI Paylocity"), and set Authentication Method to "Anonymous"
   4. Set Privacy Level as needed and click "Create"
5. If you are using the gateway in personal mode, expand the Data Source Credentials node and click Edit Credentials -> Sign In. (This step is not necessary if you are using the default gateway.)

Refresh a Dataset

Refresh the dataset to provide the current data to your reports.

• To refresh manually, open the dataset options menu from your workspace -> Datasets and click Refresh Now.
• To schedule refreshes, open the dataset options menu from your workspace -> Datasets and click Schedule Refresh. Enable the option to keep your data up to date. Specify the refresh frequency in the menus.
• In Report view, click Refresh to sync the report with the dataset as you work.