Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Access Paylocity Data from MySQL in HeidiSQL
Use CData ODBC Driver and SQL Gateway to connect and query live Paylocity data from HeidiSQL.
HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with the CData ODBC Driver for Paylocity and SQL Gateway, HediSQL's reach extends to include access to live Paylocity data. This article demonstrates how to connect to on-premise Paylocity and query Paylocity data in HeidiSQL.
Connect to Paylocity Data
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 SQL Gateway
See the SQL Gateway Overview to set up connectivity to Paylocity data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.
To connect to the SQL Gateway from HeidiSQL, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:
- The IP address or domain name of the machine hosting the SQL Gateway
- The data source name (likely CData Paylocity Sys) of the MySQL service
- The port number of the MySQL service
- The credentials of a SQL Gateway user with access to the service
Configure Remote Access
If your ODBC Driver and the remoting service are installed on-premise (and not accessible from HeidiSQL), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.
Connect to Paylocity in HeidiSQL
Once you have a MySQL Service configured for the CData ODBC Driver for Paylocity, you are ready to connect to the data in HeidiSQL. Start by creating a new connection Session in HeidiSQL, then choose the MySQL library type.
Configure the data set using the values for the MySQL service for Paylocity you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Open.
Query Paylocity from HeidiSQL
- In the database listing on the left, find your connection to Paylocity configured earlier.
- In the database listing on the left, expand the appropriate connection and to view individual tables or data objects present within Paylocity.
- Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables
With the CData ODBC Driver for Paylocity and SQL Gateway, you are able to easily query data from Paylocity data in HeidiSQL. If you have any questions, such as needing to access your on-premises data from HeidiSQL, let our Support Team know.