Connect to Paylocity Data Using the Script Function in Claris FileMaker Pro

Claris FileMaker is a low-code database application development tool that enables users to create custom apps for managing and organizing data. It combines a powerful relational database engine with an intuitive interface, allowing both technical and non-technical users to design and deploy applications across desktop, web, and mobile platforms.

In this article, we'll explore how to use the CData ODBC Driver for Paylocity and FileMaker scripting to connect to Paylocity data.

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.

Connect and Sync Paylocity data with FileMaker Using Scripts

In this section, we walk through the steps to connect live Paylocity data to FileMaker using the CData ODBC Driver for Paylocity and the Script function. During the initial import, FileMaker brings in all data from the external data source. From the second import onward, it updates only the data that has changed in the external source (a differential update). You can also replace the data in the current record order and schedule these differential updates for automated syncing.

You can download and install the latest version of FileMaker Pro for your Mac/Windows/Linux systems from this link.

Connect and sync Paylocity data with FileMaker using scripts

Scripting in FileMaker automates complex tasks and workflows by running a sequence of actions with a single command. By using scripting to integrate with Paylocity, you can automatically connect to, import, update, and replace Paylocity data within your FileMaker applications, streamlining data management and improving efficiency.

First-time importing and adding Paylocity data using script

In this section, we'll use scripts to import Paylocity data into FileMaker by following these steps:

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

2. Enter a filename of your choice and click Save.
3. In the Manage Database window, go to the Tables tab and create or rename the table where you want to display the Paylocity data.
👁 Create or rename existing the table

4. In the Fields tab, create and add the fields you want to use in the table.
👁 Add the necessary fields.

5. In the Relationships tab, add table relationships if there are multiple tables, then click OK.
👁 Add the table relationships.

6. To reopen and modify the table structure, go to File > Manage > Database.
7. Navigate to Scripts > Script Workspace.
👁 Open the Script Workspace.

8. Select New Script to open a new script workspace.
9. From the Steps panel on the right, select Records > Import Records > Insert into Script.
👁 Insert into script from import records.

10. In the Specify Data Source dropdown, choose ODBC Data. 👁 Click ODBC Data from Specify data source.
    
11. Select CData Paylocity Sys from the Select ODBC Data Source window, and click Continue. Enter your Paylocity credentials and click OK.
👁 Select the data source driver.
👁 Enter the data source credentials to aunthenticate.

12. In the Specify ODBC SQL Query dialog, enter the SQL query in the SQL text editor to import the desired Paylocity data.
👁 Specify the SQL query.

13. Alternatively, select Query Builder to open the SQL Query Builder window. Choose the target table from the Tables section and relevant columns from the Columns section. Click Insert into SQL Query after each selection to auto-generate the query. You can also manually edit the query using WHERE and ORDER BY clauses or the designated tabs. Click OK to finalize the query.
👁 Specify the columns in the table to auto-generate the SQL Query.

14. Click OK.
15. In the Specify import order option, click Specify and enter the Paylocity credentials.
👁 Click Specify.

16. In the Specify Import Order window, define the import order for the target fields you added earlier. Select Add between the source and target fields to insert the Paylocity data as new records in the table. Click Import.
👁 Select

17. The script now appears in the workspace. Click Run to execute the script and process the import.
👁 Click Run to execute the script.

18. FileMaker imports the Paylocity data as a table.
👁 The Paylocity data gets loaded.

Update or Replace Imported Paylocity data Using a Script

After importing the Paylocity data into FileMaker, use scripts to update or replace any changes made in Paylocity by following this process:

1. Go back to the Script Workspace by following the steps mentioned in the earlier section.
2. Select the existing script, click the settings button, choose Specify under Specify Import Order, and re-enter the Paylocity credentials to authenticate.
👁 Click Specify again from the previous script.

3. In the Specify Import Order window, choose Update between source and target to update the imported Paylocity data. This updates the target's found set with Paylocity data values from selected fields when the match fields have the same values. You must define at least one match field in the mapping and select the checkbox Add remaining data as new records. Click Import.
👁 Select
👁 Match at least one field in the mappings.

4. Alternatively, choose the Replace option instead of Update, based on your use case. This replaces the selected fields in the target's found set with Paylocity data in the current record order. Click Import.
👁 Select

5. FileMaker adds the script to the workspace. Click Run to execute the script and process the import query.
6. FileMaker imports the updated or replaced Paylocity data as a table.

Get Started Today

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

Reach out to our Support Team if you have any questions.