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

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

Create an ODBC Data Source for Cosmos DB

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.

To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

• AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
• AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.

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

See the SQL Gateway Overview to set up Cosmos DB 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 Cosmos DB 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.

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 CosmosDB Sys
   
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 Cosmos DB 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.

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.

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

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

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 CosmosDB Sys
7. Click OK.

8. View the tables from Cosmos DB populated under the Data Source section. Select the table of your choice and click OK.

9. The Relationships tab now displays the selected table and its metadata. Click OK.

10. Select the table from the Layout dropdown. The Cosmos DB table data appears on the screen. (As shown)

Get Started Today

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

Contact our Support Team if you have any questions.