Create Interactive Metabase Dashboards that Work with Paylocity Data

Ready to get started?

Learn more or sign up for a free trial:

CData Connect



Use CData Connect to create a virtual MySQL database for Paylocity data and create an interactive dashboard in Metabase from Paylocity data.

Metabase is an open source data visualization tool that allows users to create interactive dashboards. When paired with CData Connect Cloud, users can easily create visualizations and dashboards linked to live Paylocity data. This article describes how to create a virtual database for Paylocity and build a simple visualization using Paylocity data.

CData Connect provides a pure SQL interface for Paylocity, allowing you to easily integrate with live Paylocity data in Metabase — without replicating the data. Connect looks exactly like a MySQL database to Metabase and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to Paylocity, leveraging server-side processing to quickly return Paylocity data.

Create a Virtual MySQL Database for Paylocity Data

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Log into Connect Cloud and click Databases.
  2. Select "Paylocity" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to Paylocity.

    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.

  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

Connect to CData Connect from Metabase

After creating the virtual database, navigate to your Metabase instance. Use the MySQL interface to connect to CData Connect.

  1. Navigate to the administration screen (Settings -> Admin) and click "Add Database" from the "Databases" tab
  2. Configure the connection to CData Connect and click "Save"
    • Database type: Select "MySQL"
    • Name: Name the connection (e.g. "Paylocity (CData Connect)")
    • Host: The URL of your Connect instance (e.g. https://myinstance.cdatacloud.net)
    • Port: The port of the MySQL endpoint for your Connect instance (e.g. 3306)
    • Database name: The name of the virtual database you just created (e.g. Paylocity1)
    • Username: A CData Connect username
    • Password: The password for the above CData Connect user
    • Click to Use a secure connection (SSL)

Query Paylocity Data with Metabase

Once you configure the connection to CData Connect, you can query Paylocity and build visualizations.

  1. Use the "Write SQL" tool to retrieve the Paylocity data
  2. Write a SQL query based on the virtual database, e.g.

    SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'
  3. Navigate to the "Visualization" screen, choose a visualization, and configure the visualization

More Information & Free Trial

At this point, you have built a simple visualization from Paylocity data in Metabase. You can continue to work with live Paylocity data in Metabase just like you would any MySQL database. For more information on creating a virtual MySQL database for Paylocity (and more than 200 other data sources), visit the Connect Cloud page. Sign up for a free trial and start working with live Paylocity data in Metabase today.