Connect REST 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 REST and the CData SQL Gateway, FileMaker connects to REST data through its ESS (External SQL Source) feature, allowing you to work with REST records as if they were native FileMaker tables.

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

Create an ODBC Data Source for REST

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.

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the and providing any authentication values, set to "XML" or "JSON" and set to more closely match the data representation to the structure of your data.

The property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

• Document (default): Model a top-level, document view of your REST data. The data provider returns nested elements as aggregates of data.
• FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
• Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling REST Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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, REST - as a standard MySQL or SQL Server endpoint.

See the SQL Gateway Overview to set up REST 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 REST 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 REST 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 REST 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 REST Sys
7. Click OK.
👁 Configure the data source in FileMaker

8. View the tables from REST 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 REST table data appears on the screen. (As shown)
👁 The REST table data is displayed in FileMaker Pro

Get Started Today

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

Contact our Support Team if you have any questions.