Bidirectional Access to Paylocity Data from FileMaker Pro

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Paylocity JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Paylocity.



Use the MySQL Remoting feature of the JDBC driver to integrate Paylocity data in Filemaker Pro for Mac or Windows.

This article shows how to use the CData JDBC Driver for Paylocity to integrate with the External SQL Sources (ESS) feature in FileMaker Pro, which allows you to link records in FileMaker Pro with related records in your other operational data stores.

You will use the MySQL Remoting feature to access Paylocity as a remote MySQL database. The CData JDBC Driver for Paylocity implements both the JDBC and MySQL standards to integrate with applications like FileMaker Pro that support connections to traditional databases like MySQL but not generic JDBC connections.

Selecting a FileMaker Pro Integration

There are two data access modes in FileMaker Pro:

  • Data Import: Paylocity data is copied into a FileMaker Pro database and can be refreshed on demand. To streamline this solution, use the CData ODBC driver, as FileMaker Pro supports ODBC natively, but it does not support JDBC.

    To use this approach, see ODBC Paylocity Integration in FileMaker Pro.

  • ESS: Instead of working with a local copy of the data, you can use the JDBC driver to create an external SQL source. The remote data can be modified in FileMaker Pro and tables can be used in the relationships graph like standard FileMaker Pro tables.

Outlining the ESS Setup

The JDBC driver is part of a data access chain. Compared to a native ODBC integration, FileMaker Pro integrations that use MySQL remoting have several additional components. This article shows how to link each of the following components with FileMaker Pro:

  1. The CData JDBC driver.
  2. The CData MySQL Remoting daemon (included with the driver).
  3. An ODBC driver for MySQL.

    On Windows, FileMaker Pro requires the official MySQL driver, the MySQL Connector\ODBC (currently, the best option is Connector\ODBC 5.1.13).

    On macOS, FileMaker Pro requires the Actual Technologies Open Databases ODBC driver.

  4. An ODBC driver manager.

    On Windows, the driver manager is built in. On macOS, you will need to install a driver manager before installing the ODBC driver; install the iODBC driver manager.

Start the Remoting Daemon

Follow the steps below to enable the MySQL Remoting feature:

  1. Open Terminal and change to the lib subfolder in the installation folder.

    $ cd "/Applications/CData/CData JDBC Driver for Paylocity/lib"
  2. Edit the configuration file (cdata.jdbc.paylocity.remoting.ini by default):
    • Update the [databases] section with the JDBC Connection URL for Paylocity: paylocity = "OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;RSAPublicKey=YourRSAPubKey;Key=YourKey;IV=YourIV;InitiateOAuth=GETANDREFRESH"

      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.

      See the help documentation for more information about the available connection properties and other configuration options for remoting.

  3. Start the MySQL daemon by specifying the configuration file or settings on the command line. The example below uses the included sample configuration file.

    $ java -jar cdata.jdbc.paylocity.jar -f "cdata.jdbc.paylocity.remoting.ini"

Create the DSN

After connecting successfully to Paylocity and starting the MySQL daemon, create a MySQL ODBC data source. When working with ODBC data sources, you specify connection properties in a DSN (data source name).

If you have not already obtained an ODBC driver and driver manager, refer to "Outlining the ESS Setup" to determine the components supported for your platform.

macOS

Follow the steps below to use the iODBC graphical administrator tool:

  1. Open iODBC by searching in the launchpad.
  2. On the System DSN tab, click Add and select Actual Open Source Databases.
  3. Provide the following information to complete the wizard:
    • Name: Enter the DSN.
    • Server: Enter 127.0.0.1 or the address of the machine where the MySQL daemon is running.
    • Port: Enter the port that the daemon is listening on. For example, 3306.
    • Database: Enter the name of a database specified in the config file for the daemon. For example, Paylocity.
    • In the Metadata tab, check the boxes for:
      • "Ignore schema in column specifications"
      • "Don't use INFORMATION_SCHEMA for metadata"
  4. Click Test Connection and enter your credentials in the dialog.

Windows

You can use the built-in Microsoft ODBC Data Source Administrator to create the ODBC DSN.

  1. From the Control Panel, select Set Up Data Sources (ODBC). The ODBC Data Source Administrator is displayed.
  2. On the System DSN tab, click Add and select the MySQL ODBC driver.
  3. Provide the following information to complete the wizard:
    • Name: Enter the DSN.
    • Server: Enter 127.0.0.1 or the address of the machine where the MySQL daemon is running.
    • Port: Enter the port that the daemon is listening on. For example, 3306.
    • Database: Enter the name of a database specified in the config file for the daemon. For example, Paylocity.
    • In the Metadata tab, check the boxes for:
      • "Ignore schema in column specifications"
      • "Don't use INFORMATION_SCHEMA for metadata"
  4. Click Test Connection and enter your credentials in the dialog.

Create Paylocity Shadow Tables

Shadow tables exist in an external SQL source but can be used in much the same way as other tables in your FileMaker database; you can add them in the relationships graph, browse data, and create layouts on them.

  1. Click File -> Manage -> Database.
  2. On the Relationships tab of the resulting dialog, click the Add a Table button in the Table/Relationships section.
  3. In the Data Source menu, select Add ODBC Data Source and then select the DSN you created in the previous section.

After specifying the username and password for the DSN, you can add Paylocity tables to the relationships graph. You can now scroll through, sort, edit, and summarize Paylocity data by clicking View -> Browse Mode, just as you would a remote MySQL database.