Ready to get started?

Download a free trial of the HCL Domino Driver to get started:

 Download Now

Learn more:

HCL Domino Icon HCL Domino JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HCL Domino.

Connect to HCL Domino Data in RazorSQL



Connect to HCL Domino from wizards and query HCL Domino data from the GUI in the RazorSQL database management tool.

The CData JDBC Driver for HCL Domino enables standards-based access from third-party tools, from wizards in IDEs to data management and analysis tools. This article shows how to connect to HCL Domino using wizards in RazorSQL.

Create a JDBC Data Source for HCL Domino Data

  1. Open the RazorSQL application and, in the Connections menu, select Add Connection Profile -> Other -> JDBC.
  2. In the Connection Wizard that appears, set the following properties:
    • Driver Location: Set this property to the path to the lib subfolder in the installation directory.
    • Driver Class: Set the driver class to cdata.jdbc.domino.DominoDriver.
    • Username: Enter the username. (This property can also be set in the JDBC URL.)
    • Password: Enter the password. (This property can also be set in the JDBC URL.)
    • JDBC URL: Enter connection parameters. The JDBC URL begins 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.

      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=*

Query HCL Domino Data and Select Tables

After establishing a connection, the wizard will close and the connection will be available in the connections panel. You can then query the tables.