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.

Add HCL Domino Data to Informatica Enterprise Data Catalog



Use the CData JDBC Driver for HCL Domino with the Informatica Enterprise Data Catalog to classify and organize data.

Informatica provides a powerful, elegant means of transporting and transforming your data. By utilizing the CData JDBC Driver for HCL Domino, you are gaining access to a driver based on industry-proven standards that integrates seamlessly with Informatica's Enterprise Data Catalog. This tutorial shows how to classify and organize HCL Domino data across any environment.

Load the JDBC Driver

To load the JDBC Driver:

  1. Install the JDBC Driver on the host running Informatica. For this article, it is assumed that the driver was installed into cdata.jdbc.domino.DominoDriver.
  2. $ java -jar setup.jar
  3. Navigate to the JDBC install directory and create a zip file called genericJDBC.zip containing the driver and its license file.
  4. $ cd ~/cdata-jdbc-driver-for-domino/lib $ zip genericJDBC.zip cdata.jdbc.domino.jar cdata.jdbc.domino.lic
  5. Move the genericJDBC.zip file into the Catalog Service directory within Informatica. For this article, it is assumed that Informatica is installed into /opt/informatica. Working in this folder will probably require root permissions, so make sure to su or sudo to root before continuing.
  6. # mv genericJDBC.zip /opt/informatica/services/CatalogService/ScannerBinaries
  7. Edit the custom deployment configuration to unpack the zip file.
  8. # cd /opt/informatica/services/CatalogService/ScannerBinaries/CustomDeployer/ # nano scannerDeployer.xml

    After unpacking the existing ExecutionContextProperty nodes, add a new ExecutionContextProperty node with this content.

    <ExecutionContextProperty isLocationProperty="true" dependencyToUnpack="genericJDBC.zip"> <PropertyName>JDBCScanner_DriverLocation</PropertyName> <PropertyValue>scanner_miti/genericJDBC/Drivers</PropertyValue> </ExecutionContextProperty>
  9. Refresh the Catalog Service from the Admin console.

Configure the JDBC Resource

To configure the JDBC resource:

  1. Open the Catalog administrator and add a new JDBC resource with the following properties:
    • Driver Class: cdata.jdbc.domino.DominoDriver
    • URL: jdbc.domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
    • 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.

    Typical additional connection string properties follow:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.domino.DominoDriver;URL={jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*};
  2. Username: user
  3. Password: password
  4. Note that the Username and Password properties are required, even if the driver you are using does not require them. In those cases, you can enter a placeholder value instead.

  5. Configure the metadata options to perform at least one source metadata scan. This scan uses the driver to determine what tables, views, and stored procedures are available through the service.
    • Source Metadata: Enable this option.
    • Catalog: Set this to the appropriate catalog for multi-catalog data sources. Otherwise, set this to CData.
    • Schema: Set this to the appropriate schema for multi-schema data sources. Otherwise, set this to the name of the service (for example, Couchbase).
    • Case-sensitivity: Generally this option should be disabled. Enable it only for data sources which are case-sensitive.
    • Import stored procedures: Enable this if you want to import stored procedure definitions in addition to tables and views.

    Other metadata scanners may be enabled as desired.

  6. Complete the driver configuration, optionally configuring custom attributes and a scanner schedule.
  7. Perform the metadata scan by navigating to the Monitoring tab and clicking Run. Depending upon the data source, this may takes a few minutes.

When the scan is complete, a summary of all of the metadata objects is displayed along with the status of the Metadata Load job. If any errors occur, you can open the Log Location link for the job to see the errors reported by Informatica or the driver.

Validate the Discovered Metadata

Open the Catalog Service browser to view the metadata extracted from the data source. Depending upon the options you selected when configuring the metadata scanner, you may see any combination of tables, views, and stored procedures for the resource you defined.