Build Dashboards with Paylocity Data in DBxtra

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 connect to Paylocity data as a generic ODBC Data Provider and create charts, reports, and dashboards based on Paylocity data in DBxtra.

Connect to Paylocity Data

1. If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can configure the DSN using the built-in Microsoft ODBC Data Source Administrator. 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.

2. Open the DBxtra application and in the New menu click Project and name the Project. 👁 Creating a New Project.
   
3. Select ODBC Connection as the Data Connection Type. 👁 Creating an ODBC Connection.
   
4. Click the browse option () for the Data Source.
5. In the Data Link Properties window, select Microsoft OLE DB Provider for ODBC Drivers on the Provider tab. 👁 Select the Provider
   
6. On the Connection tab, select the Data Source Name and the initial catalog to use (CData). 👁 Select the Provider
   
7. Name the Connection and select the appropriate User Groups. 👁 Connection name and User Groups
   
8. Double-click the Connection from within the Project to connect to the data. 👁 Connecting to the data.
   

Create a Dashboard with Paylocity Data

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

1. Right-click Report Objects under the Project and select New Report Object. 👁 Creating a Report Object for the Project
   
2. In the new Report Object, click the link to create the Query.
3. In the Select Data Connection window, select the newly created data connection. 👁 Select Data Connection
   
4. On the Query tab, expand the connection objects and select the Tables, Views, and specific columns you wish to include in your dashboard. You can specify search requirements and even create complex queries which include JOINs and aggregations. 👁 Selecting the data/building the query.
   
5. On the Dashboard tab, select the visualizations and features for your dashboard. Assign the data values from the query to the appropriate fields for the Dashboards items (Values, Series, etc.) 👁 Building the Dashboard.
   

With a new Dashboard created, you are ready to begin analysis of Paylocity data. Thanks to the ODBC Driver for Paylocity, you can refresh the Dashboard and immediately see any changes made at the source. In the same way, you can create and view Reports with live, up-to-date Paylocity data.