Link HCL Domino with FileMaker Pro



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

This article shows how to use the CData JDBC Driver for HCL Domino 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 HCL Domino as a remote MySQL database. The CData JDBC Driver for HCL Domino 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: HCL Domino 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 HCL Domino 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 8.0.11).

    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 HCL Domino/lib"
  2. Edit the configuration file (cdata.jdbc.domino.remoting.ini by default):
    • Update the [databases] section with the JDBC Connection URL for HCL Domino: domino = "Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;"

      Connecting to Domino

      To connect to Domino data, set the following properties:

      • URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
      • DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

      Authenticating with Domino

      Domino supports authenticating via login credentials or an Azure Active Directory OAuth application:

      Login Credentials

      To authenticate with login credentials, set the following properties:

      • AuthScheme: Set this to "OAuthPassword"
      • User: The username of the authenticating Domino user
      • Password: The password associated with the authenticating Domino user

      The driver uses the login credentials to automatically perform an OAuth token exchange.

      AzureAD

      This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. You need to create a custom OAuth application in Azure Active Directory and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

      • AuthScheme: Set this to "AzureAD"
      • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
      • OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
      • OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
      • CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
      • AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

        The tenant ID is the same as the directory ID shown in the Azure Portal's Azure Active Directory > Properties page.

      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.domino.jar -f "cdata.jdbc.domino.remoting.ini"

Create the DSN

After connecting successfully to HCL Domino 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, Domino.
    • 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, Domino.
    • 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 HCL Domino 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 HCL Domino tables to the relationships graph. You can now scroll through, sort, and summarize HCL Domino data by clicking View -> Browse Mode, just as you would a remote MySQL database.

Ready to get started?

Download a free trial of the HCL Domino Driver to get started:

 Download Now

Learn more:

HCL Domino Icon HCL Domino JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HCL Domino.