Use the CData JDBC Driver for HCL Domino in MicroStrategy Desktop

MicroStrategy is an analytics and mobility platform that enables data-driven innovation. When you pair MicroStrategy with the CData JDBC Driver for HCL Domino, you gain database-like access to live HCL Domino data from MicroStrategy, expanding your reporting and analytics capabilities. In this article, we walk through adding HCL Domino as a data source in MicroStrategy Desktop and creating a simple visualization of HCL Domino data.

The CData JDBC Driver offers unmatched performance for interacting with live HCL Domino data in MicroStrategy due to optimized data processing built into the driver. When you issue complex SQL queries from MicroStrategy 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 (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can use native MicroStrategy data types to visualize and analyze HCL Domino data.

Connect to and Visualize HCL Domino Data using MicroStrategy Desktop

In addition to connecting to HCL Domino in MicroStrategy enterprise products, you can connect to HCL Domino in MicroStrategy Desktop. Follow the steps below to add HCL Domino data as a dataset using JDBC and create visualizations and reports of HCL Domino data.

1. Open MicroStrategy Desktop and create a new dossier.
2. In the datasets panel, click New Data, select Databases, and choose Select a Table as the Import Option.
3. Add a new data source and choose the DSN-less data sources option.
4. Choose Generic in the Database menu and Generic DBMS in the Version menu.
5. Click the link to show the connection string and opt to edit the connection string. In the Driver menu, select MicroStrategy Cassandra ODBC Driver. (MicroStrategy requires a certified driver to interface through JDBC; the actual driver will not be used.)
6. Set the connection string as follows and click OK:
   • Add the JDBC keyword to the connection string.
   • Set MSTR_JDBC_JAR_FOLDER to the path of the JAR file for the JDBC driver. (C:\Program Files\CData JDBC Driver for HCL Domino\lib\ on Windows.)
   • Set DRIVER to cdata.jdbc.domino.DominoDriver, the driver class.
   • Set URL to the JDBC URL for the HCL Domino driver, setting the necessary connection properties.

     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.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

   A typical connection string follows:

   JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.domino.DominoDriver;URL={jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;};
   

   👁 Creating a new data source for HCL Domino.
   
7. Right-click on the new data source, and choose Edit catalog options.
8. Edit the SQL Statement to SELECT * FROM SYS_SCHEMAS to read the metadata from the JDBC Driver.
9. Select the new data source to view the available tables. You may need to manually click the search icon in the Available Tables section to see the tables.
10. Drag tables into the pane to import them. 👁 Select tables to import.
    Note: Since we create a live connection, we can import whole tables and utilize the filtering and aggregation features native to the MicroStrategy products.
11. Click Finish and choose the option to connect Live. Live connections are possible and effective, thanks to the high-performance data processing native to CData JDBC Drivers.
12. Choose a visualization, choose fields to display, and apply any filters to create a new visualization of HCL Domino data. Data types are discovered automatically through dynamic metadata discovery. Where possible, the complex queries generated by the filters and aggregations will be pushed down to HCL Domino, while any unsupported operations (which can include SQL functions and JOIN operations) will be managed client-side by the CData SQL engine embedded in the driver. 👁 Visualize HCL Domino data.
    
13. Once you are finished configuring the dossier, click File -> Save.

Using the CData JDBC Driver for HCL Domino in MicroStrategy Desktop, you can easily create robust visualizations and reports on HCL Domino data. Read our other articles for connecting to HCL Domino data in MicroStrategy Developer and connecting to HCL Domino data in MicroStrategy Web for more examples.