Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →Link Clio with FileMaker Pro
Use the MySQL Remoting feature of the JDBC driver to integrate Clio data in Filemaker Pro for Mac or Windows.
This article shows how to use the CData JDBC Driver for Clio 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 Clio as a remote MySQL database. The CData JDBC Driver for Clio 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
Use the JDBC the JDBC driver to create an external SQL source (ESS). 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:
- The CData JDBC driver.
- The CData MySQL Remoting daemon (included with the driver).
- 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 8.0.11).
On macOS, FileMaker Pro requires the Actual Technologies Open Databases ODBC driver.
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:
-
Open Terminal and change to the lib subfolder in the installation folder.
$ cd "/Applications/CData/CData JDBC Driver for Clio/lib"
- Edit the configuration file (cdata.jdbc.api.remoting.ini by default):
- Update the [databases] section with the JDBC Connection URL for Clio:
api = "Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
Start by setting the Profile connection property to the location of the Clio Profile on disk (e.g. C:\profiles\Clio.apip). Next, set the ProfileSettings connection property to the connection string for Clio (see below).
Clio API Profile Settings
Clio uses OAuth-based authentication.
First, register an OAuth application with Clio. You can do so by logging to your Developer Account and clicking the Add button. Enter details and select the scope of your application here - these details will be shown to Clio users when they're asked to authorize your application. Your Oauth application will be assigned a client id (key) and a client secret (secret). Additionally you will need to set the Region in ProfileSettings connection property.
After setting the following connection properties, you are ready to connect:
- AuthScheme: Set this to OAuth.
- InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
- OAuthClientId: Set this to the client_id that is specified in you app settings.
- OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
- CallbackURL: Set this to the Redirect URI that is specified in your app settings.
- Region: Set this in ProfileSettings to your Clio geographic region. Defaults to app.clio.com.
See the help documentation for more information about the available connection properties and other configuration options for remoting.
- Update the [databases] section with the JDBC Connection URL for Clio:
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.api.jar -f "cdata.jdbc.api.remoting.ini"
Create the DSN
After connecting successfully to Clio 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:
- Open iODBC by searching in the launchpad.
- On the System DSN tab, click Add and select Actual Open Source Databases.
- 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, API.
- In the Metadata tab, check the boxes for:
- "Ignore schema in column specifications"
- "Don't use INFORMATION_SCHEMA for metadata"
- 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.
- From the Control Panel, select Set Up Data Sources (ODBC). The ODBC Data Source Administrator is displayed.
- On the System DSN tab, click Add and select the MySQL ODBC driver.
- 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, API.
- In the Metadata tab, check the boxes for:
- "Ignore schema in column specifications"
- "Don't use INFORMATION_SCHEMA for metadata"
- Click Test Connection and enter your credentials in the dialog.
Create Clio 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.
- Click File -> Manage -> Database.
- On the Relationships tab of the resulting dialog, click the Add a Table button in the Table/Relationships section.
- 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 Clio tables to the relationships graph. You can now scroll through, sort, and summarize Clio data by clicking View -> Browse Mode, just as you would a remote MySQL database.