Connect Paylocity Data to Claris FileMaker via ESS using an ODBC Driver and the CData SQL Gateway

Claris FileMaker is a low-code platform that enables users to quickly create custom apps to manage and automate data workflows. Using the CData ODBC Driver for Paylocity and the CData SQL Gateway, FileMaker connects to Paylocity data through its ESS (External SQL Source) feature, allowing you to work with Paylocity records as if they were native FileMaker tables.

In this article, we configure and use the CData ODBC Driver for Paylocity and the CData SQL Gateway, along with the MySQL ODBC Driver, to connect to Paylocity data using the ESS functionality in FileMaker.

Create an ODBC Data Source for Paylocity

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

Configuring the CData SQL Gateway

The CData SQL Gateway bridges non-SQL data sources (like SaaS applications, APIs, and NoSQL databases) with SQL-based tools (like FileMaker, MySQL clients, and BI tools).

In simple terms, it exposes any CData driver-supported source - for example, Paylocity - as a standard MySQL or SQL Server endpoint.

See the SQL Gateway Overview to set up Paylocity data connectivity as a virtual MySQL database. Set up a MySQL remoting service that listens for MySQL requests from clients, and configure the service through the SQL Gateway UI (as shown below). Save the user credentials (Username and Password) for future use.

Once you establish the connection, you can use the CData SQL Gateway to access Paylocity data through the MySQL protocol.

Installing the MySQL ODBC Driver

Follow the steps below to install and configure the MySQL ODBC Driver:

1. Download and install the latest 64-bit Windows version of the MySQL ODBC Unicode Driver from this link.
2. Launch ODBC Data Sources (64-bit) from Windows search. Open the System DSN tab, click Add, select MySQL ODBC Unicode Driver from the Create New Data Source window, and click Finish.
👁 Create a new data source using the latest MySQL ODBC Unicode Driver

3. Enter the following connection details in the MySQL Connector/ODBC Data Source Configuration window:
   • Data Source Name: Enter a DSN of your choice
   • TCP/IP Server: localhost
   • Port: Enter the port set in the SQL Gateway (for this procedure, use "3307")
   • User: Enter the username set in the CData SQL Gateway
   • Password: Enter the password set in the CData SQL Gateway
   • Database: CData Paylocity Sys
   👁 Configure the MySQL ODBC Driver using CData SQL Gateway credentials
   
4. Click Test to verify that the "Connection Successful" dialog box appears. Then click OK to save the configuration details.

You have now successfully configured the MySQL ODBC Driver.

Use FileMaker ESS function to load Paylocity data

In this section, we explore how to use the ESS (External SQL Source) feature to retrieve data in the FileMaker application. Follow the given steps to complete the process:

1. Open FileMaker Pro. Navigate to Create from the left panel and select Blank > Create.
👁 Create a new application in FileMaker Pro

2. Enter a desired filename and click Save.
3. In Manage Database, remove the Tables and Fields from the respective tabs. Select the Relationships tab and click Add Table.
👁 Add a table in the Manage Database window in FileMaker Pro

4. In Specify Table, expand the Data Source dropdown menu and select Add ODBC Data Source. Click OK.
👁 Add an ODBC Data Source in the Specify Table window

5. In Select ODBC Data Source, select the previously configured MySQL ODBC driver and click Continue.
👁 Select the newly configured MySQL ODBC Unicode Driver

6. In the Edit Data Source window, enter the following details:
• Name: This field will be auto-filled. Enter a new name of choice if necessary.
• Type: Select "ODBC".
• Under Authentication, select the Specify username and password radio button and enter the following details:
• User name: Enter the username set in the CData SQL Gateway.
• Password: Enter the password set in the CData SQL Gateway.
• Catalog Name: CData Paylocity Sys
7. Click OK.
👁 Configure the data source in FileMaker

8. View the tables from Paylocity populated under the Data Source section. Select the table of your choice and click OK.
👁 Add a new table in the Specify Table window

9. The Relationships tab now displays the selected table and its metadata. Click OK.
👁 The new table gets added in the Relationships tab

10. Select the table from the Layout dropdown. The Paylocity table data appears on the screen. (As shown)
👁 The Paylocity table data is displayed in FileMaker Pro

Get Started Today

Download a free 30-day trial of CData ODBC Driver for Paylocity to integrate Paylocity data into Claris FileMaker and use Paylocity data in your FileMaker applications.

Contact our Support Team if you have any questions.