How to Query HCL Domino Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for HCL Domino to query HCL Domino data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live HCL Domino data in MySQL Workbench.

Connect to HCL Domino Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to HCL Domino data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query HCL Domino from MySQL Workbench

The steps below outline connecting to the virtual HCL Domino database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live HCL Domino data.

Connect to HCL Domino through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for HCL Domino).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query HCL Domino Data

1. Open the connection you just created (CData SQL Gateway for HCL Domino).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve HCL Domino data, like SELECT * FROM `CData Domino Sys`.ByName;

With access to live HCL Domino data from MySQL Workbench, you can easily query and update HCL Domino, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for HCL Domino and the CData SQL Gateway.