Integrate HCL Domino Data in the Pentaho Report Designer

The CData JDBC Driver for HCL Domino data enables access to live data from dashboards and reports. This article shows how to connect to HCL Domino data as a JDBC data source and publish reports based on HCL Domino data in Pentaho.

Connect and Create a Report

1. Copy the JAR file of the driver, located in the lib subfolder of the installation directory, to the \Report-Designer\lib\jdbc\ folder in the Pentaho directory.
2. Run the report-designer.bat file in the \Report-Designer\ folder to open the Report-Designer UI.

3. Create a new data source with the driver by clicking Data -> Add Data Source -> Advanced -> JDBC (Custom) and then creating a new HCL Domino connection. In the resulting dialog, configure the connection properties as shown below.

   • Custom Connection URL property: Enter the JDBC URL. This starts with jdbc:domino: and is followed by a semicolon-separated list of connection properties.

     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 URL:

     jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
   • Custom Driver Class Name: Enter cdata.jdbc.domino.DominoDriver.
   • User Name: The username to authenticate with.
   • Password: The password to authenticate with.

Add HCL Domino Data to a Report

You are now ready to create a report with HCL Domino data.

1. Add the HCL Domino source to your report: Click Data -> Add Data Source -> JDBC and select the data source.

2. Configure the query. This article uses the one below:

   SELECT Name, Address FROM ByName WHERE City = 'Miami'
3. Drag a chart onto your report and double-click it to edit the chart. Run the report to display the chart. You can use the results of this query to create a simple chart for the ByName table.
4. Finally, run the report to see the chart.