Connect to HCL Domino Data from HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with CData Connect AI, HediSQL reach extends to include access to live HCL Domino data. This article demonstrates how to connect to HCL Domino using Connect AI and query HCL Domino data in HeidiSQL.

CData Connect AI provides a pure SQL Server interface for HCL Domino, allowing you to query data from HCL Domino without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to HCL Domino, leveraging server-side processing to return the requested HCL Domino data quickly.

Configure HCL Domino Connectivity for HeidiSQL

Connectivity to HCL Domino from HeidiSQL is made possible through CData Connect AI. To work with HCL Domino data from HeidiSQL, we start by creating and configuring a HCL Domino connection.

1. Log into Connect AI, click Sources, and then click Add Connection
👁 Adding a Connection

2. Select "HCL Domino" from the Add Connection panel
👁 Selecting a data source

3. Enter the necessary authentication properties to connect to HCL Domino.

   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 Entra ID (formerly Azure AD) 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.

   EntraID (formerly AzureAD)

   This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) 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 "EntraID (formerly 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 Entra ID (formerly Azure AD) > Properties page.

   👁 Configuring a connection (Salesforce is shown)
   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add HCL Domino Connection page and update the User-based permissions. 👁 Updating permissions
   

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create. 👁 Creating a new PAT
   
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to HCL Domino data from HeidiSQL.

Connect to HCL Domino from HeidiSQL using Connect AI

To establish a connection from HeidiSQL to the CData Connect AI Virtual SQL Server API, follow these steps.

Create a new HeidiSQL Session

1. In the Session Manager, select New in the bottom-left
2. Give the new session a descriptive name, e.g. Connect-Cloud-HCL Domino
👁 Creating a new session in HeidiSQL.

Configure a SQL Server Connection to Connect AI

1. In the session settings, set the Network type to Microsoft SQL Server (TCP/IP)
2. The Library DLL should automatically update to MSOLEDBSQL
3. Set the Hostname/IP to tds.cdata.com
4. Set the User to your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected]
5. Set the Password to your PAT created in Connect AI in the previous section.
6. Set the Port to 14333 👁 Configuring a SQL Server connection to Connect AI
   

Query HCL Domino from HeidiSQL

1. In the database listing on the left, find your connection to HCL Domino configured earlier.
2. Expand this connection to view individual tables or data objects present within HCL Domino.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables 👁 Querying within HeidiSQL.
   

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!