Build Visualizations of HCL Domino Data in Birst

Birst is a cloud business intelligence (BI) tool and analytics platform that helps organizations quickly understand and optimize complex processes. When paired with the CData JDBC Driver for HCL Domino, you can connect to live HCL Domino data through the Birst Cloud Agent and build real-time visualizations. In this article, we walk you through, step-by-step, how to connect to HCL Domino using the Cloud Agent and create dynamic reports in Birst.

With powerful data processing capabilities, the CData JDBC Driver offers unmatched performance for live HCL Domino data operations in Birst. When you issue complex SQL queries from Birst 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). With built-in dynamic metadata querying, the JDBC driver enables you to visualize and analyze HCL Domino data using native Birst data types.

Configure a JDBC Connection to HCL Domino Data in Birst

Before creating the Birst project, you will need to install the Birst Cloud Agent (in order to work with the installed JDBC Driver). Also, copy the JAR file for the JDBC Driver (and the LIC file, if it exists) to the /drivers/ directory in the installation location for the Cloud Agent.

With the driver and Cloud Agent installed, you are ready to begin.

1. Create a new project in Birst.
2. Name the connection (e.g. CDataDomino).
3. Choose Live Access.
4. Select an agent.
5. Set Database Type to Other.
6. Set SQL Type to MSSQL
7. Set the Connection string.

   Prerequisites

   The connector requires the Proton component to be installed. Normally, Proton is distributed as part of the AppDev pack. See the HCL documentation for instructions on acquiring and installing Proton or the AppDev pack.

   Once the Proton service is installed and running, you will also need to create a user account and download its Internet certificate. This certificate can be used to set the connector certificate connection properties.

   Authenticating to Domino

   • Server: The name or IP address of the server running Domino with the Proton service.
   • Port: The port number that the Proton service is listening on.
   • Database: The name of the database file, including the .nsf extension.
   • SSLClientCertType: This must match the format of the certificate file. Typically this will be either PEMKEY_FILE for .pem certificates or PFXFILE for .pfx certificates.
   • SSLClientCert: The path to the certificate file.
   • SSLServerCert: This can be set to (*) if you trust the server. This is usually the case, but if you want to perform SSL validation, you may provide a certificate or thumbprint instead. See the documentation for SSLServerCert for details.

   Additional Server Configuration

   The connector supports querying Domino views if any are defined. Before views can be queried by the connector they must be registered with the design catalog.

   Please refer to the Catalog Administration section of the AppDev pack documentation for details on how to do this.

   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.

   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.

   Below is a typical JDBC connection string for HCL Domino:

   jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
8. Set the Driver Name: cdata.jdbc.domino.DominoDriver and click Save.

NOTE: Since authentication to HCL Domino is managed from the connection string, you can leave Security Credentials blank.

Configure HCL Domino Data Objects

Now that the connection is configured, we are ready to configure the schema for the dataset, choosing the tables, views, and columns we wish to visualize.

1. Select the Schema (e.g. Domino).
2. Click on Tables and/or Views to connect to those entities and click Apply.
3. Select the Tables and Columns you want to access and click Done.

With the objects configured, you can perform any data preparation and discover any relationships in your data using the Pronto Prepare and Relate tools.

Build a Visualization

After you prepare your data and define relationships between the connected objects, you are ready to build your visualization.

1. Select the Visualizer tool from the menu.
2. Select Measures & Categories from your objects
3. Select and configure the appropriate visualization for the Measure(s) you selected.

Using the CData JDBC Driver for HCL Domino with the Cloud Agent and Birst, you can easily create robust visualizations and reports on HCL Domino data. Download a free, 30-day trial and start building Birst visualizations today.