We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Link PingOne with FileMaker Pro
Use the MySQL Remoting feature of the JDBC driver to integrate PingOne data in Filemaker Pro for Mac or Windows.
This article shows how to use the CData JDBC Driver for PingOne 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 PingOne as a remote MySQL database. The CData JDBC Driver for PingOne 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: PingOne 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 PingOne 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:
- 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 PingOne/lib"
- Edit the configuration file (cdata.jdbc.pingone.remoting.ini by default):
- Update the [databases] section with the JDBC Connection URL for PingOne:
pingone = "AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH"
To connect to PingOne, configure these properties:
- Region: The region where the data for your PingOne organization is being hosted.
- AuthScheme: The type of authentication to use when connecting to PingOne.
- Either WorkerAppEnvironmentId (required when using the default PingOne domain) or AuthorizationServerURL, configured as described below.
Configuring WorkerAppEnvironmentId
WorkerAppEnvironmentId is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.
First, find the value for this property:
- From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
- Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
- In the environment's home page navigation sidebar, click Applications.
- Find your OAuth or Worker application details in the list.
-
Copy the value in the Environment ID field.
It should look similar to:
WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'
Now set WorkerAppEnvironmentId to the value of the Environment ID field.
Configuring AuthorizationServerURL
AuthorizationServerURL is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.
Authenticating to PingOne with OAuth
PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:
- Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
- To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
- Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.
OAuth (Authorization Code grant)
Set AuthScheme to OAuth.
Desktop Applications
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- InitiateOAuth: GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the OAuthAccessToken each time you connect, use InitiateOAuth.
- OAuthClientId: The Client ID you obtained when you created your custom OAuth application.
- OAuthClientSecret: The Client Secret you obtained when you created your custom OAuth application.
- CallbackURL: The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333
When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:
- The driver obtains an access token from PingOne and uses it to request data.
- The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.
The driver refreshes the access token automatically when it expires.
For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.
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 PingOne:
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.pingone.jar -f "cdata.jdbc.pingone.remoting.ini"
Create the DSN
After connecting successfully to PingOne 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, PingOne.
- 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, PingOne.
- 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 PingOne 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 PingOne tables to the relationships graph. You can now scroll through, sort, and summarize PingOne data by clicking View -> Browse Mode, just as you would a remote MySQL database.
