Build Charts with Paylocity Data in Clear Analytics

The CData ODBC Driver for Paylocity enables access to live data from Paylocity under the ODBC standard, allowing you work with Paylocity data in a wide variety of BI, reporting, and ETL tools and directly, using familiar SQL queries. This article shows how to use Clear Analytics, a Microsoft Excel Add-In, to connect to Paylocity as an ODBC source and create queries, tables, and charts (including PivotTables) based on Paylocity data.

Connect to Paylocity Data

Configure the ODBC Data Source Name

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

Configure the Data Source in Clear Analytics

1. Open Excel and navigate to the CLEAR ANALYTICS ribbon. Once there, open the Data Manager.
2. Select Database as the data source.
3. In the Set Connection section, click the option to create a new database.
4. Select Microsoft ODBC Data Source as the data source and click OK.
5. Select the DSN you already configured from the drop-down menu.
6. Back on the Set Connection section, select Standard (ANSI ODBC) Query Builder as the SQL Builder Provider and click Next.
7. Select the Schema/Owner and choose the domains (tables) that you wish to use in Clear Analytics.
8. Prepare your data objects as needed by customizing the display names and descriptions of the tables and columns.
9. For the vast majority of the CData ODBC Drivers, you will not set a key date for your domains.
10. In the Domain Relations section, add any relational information between tables.
11. In the Domain Tree section, create groups for your data and add the available items to the groups.
12. Review the summary of your data and click Finish.

Create a Chart with Paylocity Data

You are now ready to create a chart with Paylocity data.

Create a New Query

1. Click Repository in the CLEAR ANALYTICS ribbon.
2. Create a new query.
3. Select the columns you wish to retrieve.
4. Set the aggregation type for your data (use the blank entry if you do not wish to aggregate the data).
5. Set filters and formulas by dragging columns to the lower window.
6. Name your query and click Save.

Build a Chart Based on a Query Report

1. Click Report Explorer in the CLEAR ANALYTICS ribbon.
2. In the Report Explorer pane, click the 'New Report' icon in the toolbar.
3. Select the query you just created.
4. Name the report and click 'Save and Execute'.
5. Click the Results tab within the Report Explorer
6. Expand your report and drag the chart to the Excel spreadsheet.
7. In the resulting PivotChart window, drag the fields (columns) to the Filters, Legends, Axis (Categories), and Values windows.

With a new data source in Clear Analytics established and a chart created, you are ready to begin analysis of Paylocity data. With the ODBC Driver for Paylocity and Clear Analytics, you can perform self-service analytics in Excel with live data, directly from Paylocity.