Import Paylocity Data into FileMaker Pro

One of the strengths of the CData ODBC driver is its ubiquitous support across many applications and platforms. In this article, you will configure the ODBC driver in FileMaker Pro and create data visualizations with Paylocity data.

Query Paylocity Data in FileMaker Pro

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. See the "Getting Started" chapter of the help documentation for a guide to creating a DSN on Windows or Unix-based systems like Mac OS X and Linux.

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.

You can then load Paylocity data into tables in Filemaker Pro:

1. In your solution, click File -> Import Records -> ODBC Data Source, and select the CData Paylocity DSN.

2. In the resulting SQL Query Builder wizard, select tables and columns and then click Insert into SQL Query. You can edit this query directly. For example:

   SELECT FirstName, LastName FROM Employee WHERE EmployeeId = '1234'

   You can use the UI to build filters in the WHERE clause by clicking the WHERE tab.

3. In the resulting Import Field Mapping wizard, you can define mappings from columns in the data source to the columns in a destination table. To create a new table for the query results, select New Table ("CData Paylocity Source") from the Target box, and click Import.

For more information on the SQL that the driver supports out of the box, see the help documentation.

Process Data at Design Time

You can sort and aggregate data, as well as calculate summary functions, while you browse tables. To manipulate the view of data at design time, first complete the two steps below:

1. Switch to Browse mode: Click the Mode pop-up menu in the footer of the application.
2. Switch to Table view: Click the table icon in the View As menu in the main toolbar of the application.

Aggregate and Summarize

Follow the procedure below to group column values and then display a summary, as shown in the screenshot below:

1. Sort: Click the arrow in the FirstName column header and then click Sort Ascending in the resulting menu.
2. Group: In the menu for the FirstName column click Add Trailing Group by FirstName to group the values and create a subsequent row where summary calculations can be inserted. Click Add Leading Group to introduce the group with a summary.
3. Summarize: In the menu for a column that has been grouped, select a summary from the Trailing Subtotals menu.

the procedure below to create a simple bar chart that shows the total LastName for each FirstName.

1. Click the arrow in the LastName column header and click "Chart by LastName" in the menu. If you have already grouped on a column in the Table view, FirstName, for example, you can select the option to chart LastName by FirstName.
2. In the Chart Setup window, select columns to draw the chart: To add the column for the x-axis, click the button next to the Data box.

Selecting the x-axis and y-axis will draw the chart. You can also process data in the Chart Setup: Set the following options to create a basic chart.

1. Click the button next to the Data box and select Specify Field Value. Select a column in the resulting dialog.
2. Select a summary for the y-axis in the Summary menu.