How to connect to HCL Domino Data from IntelliJ

The CData JDBC Driver for HCL Domino enables you to access HCL Domino as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to HCL Domino data in IntelliJ.

Create a JBDC Data Source for HCL Domino

Follow the steps below to add the driver JAR and define connection properties required to connect to HCL Domino data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.domino.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.domino.DominoDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:domino: and includes connection properties separated with semicolons.

     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.

     A typical JDBC URL is the following:

     jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*

Edit and Save HCL Domino Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.