Connect to HCL Domino Data in the Denodo Platform

Denodo Platform is a data virtualization product providing a single point of contact for enterprise database data. When paired with the CData JDBC Driver for HCL Domino, Denodo users can work with live HCL Domino data alongside other enterprise data sources. This article explains how to create a virtual data source for HCL Domino in the Denodo Virtual DataPort Administrator.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HCL Domino data. When you issue complex SQL queries to HCL Domino, the driver pushes supported SQL operations, like filters and aggregations, directly to HCL Domino and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze HCL Domino data using native data types.

Create the HCL Domino Virtual Port

To connect to live HCL Domino data from Denodo, you need to copy the JDBC Driver JAR file to the external library directory for Denodo and create a new JDBC Data Source from the Virtual DataPort Administrator tool.

1. Download the CData JDBC Driver for HCL Domino installer, unzip the package, and run the JAR file to install the driver.
2. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for HCL Domino\lib\) to the Denodo external library directory (C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-domino-19).
3. Open the Denodo Virtual DataPort Administrator tool and navigate to the Server Explorer tab.
4. Right-click "admin" and select New -> Data source -> JDBC. 👁 Creating a new JDBC data source.
   
5. Configure the JDBC Connection:
   • Name: your choice, e.g.: domino
   • Database adapter: Generic
   • Driver class path: C:\Denodo\Denodo Platform\lib-external\jdbc-drivers\cdata-domino-19
   • Driver class: cdata.jdbc.domino.DominoDriver

   • Database URI: Set this to a JDBC URL using the necessary connection properties. For example,

     jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;

     👁 Configuring the JDBC connection (NetSuite is shown).
     

     Information on creating the Database URI follows:

     Built-In Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the HCL Domino JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     	java -jar cdata.jdbc.domino.jar
     	

     Fill in the connection properties and copy the connection string to the clipboard.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     
6. Click the "Test connection" button to confirm the configuration and click Save.

View HCL Domino Data in the VirtualPort Administrator Tool

After creating the data source, you can create a base view of HCL Domino data for use in the Denodo Platform.

1. Click the "Create base view" button in the newly created VirtualPort (admin.Domino).
2. Expand the object tree and select the objects (tables) you wish to import. 👁 Selecting objects to import (NetSuite is shown).
   
3. Click the "Create selected" button to create views of the HCL Domino data.
   Optional: Click "Create associations from foreign keys" to define relationships between the objects.
4. With the view(s) created, navigate to a table (cdata_domino_byname) in the Server Explorer and double-click the selected table.
5. In the new tab, click "Execution panel" to open a query panel.
6. Customize the query in the "Execute" tab or use the default:

   SELECT * FROM cdata_domino_byname CONTEXT ('i18n'='us_est', 'cache_wait_for_load'='true')
   

   👁 Configuring the query to view the data.
   
7. Click Execute to view the data. 👁 Viewing the data.
   

With the base view created, you can now work with live HCL Domino data like you would any other data source in Denodo Platform, for example, querying HCL Domino in the Denodo Data Catalog.

Download a free, 30-day trial of the CData JDBC Driver for HCL Domino and start working with your live HCL Domino data in Denodo Platform. Reach out to our Support Team if you have any questions.