Validate HCL Domino Data with QuerySurge

QuerySurge is a smart data testing solution that automates data validation and testing. When paired with the CData JDBC Driver for HCL Domino, QuerySurge can work with live HCL Domino data. This article walks through connecting to HCL Domino data from QuerySurge.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HCL Domino data. When you issue complex SQL queries 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). Its built-in dynamic metadata querying allows you to work with and analyze HCL Domino data using native data types.

Connecting to HCL Domino Data in QuerySurge

To connect to live HCL Domino data from QuerySurge, you need to deploy the JDBC Driver JAR file to your QuerySurge Agent(s) and add a new connection from the QuerySurge Admin view.

Deploy the JDBC Driver

1. Download the CData JDBC Driver for HCL Domino installer, unzip the package, and run the JAR file to install the driver.
2. Once the driver is installed, stop the Agent Service.
3. Copy the JAR File (and license file if it exists) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for HCL Domino\lib\) to your Agent(s) (QuerySurge_install_dir\agent\jdbc).
4. Restart the Agent Service.

For more information on deploying JDBC drivers for QuerySurge, refer to the QuerySurge Knowledge Base.

Configure a New Connection to HCL Domino

1. Log into QuerySurge and navigate to the Admin view.
2. Click Configuration -> Connections in the Administration Tree.
3. Click Add to create a new connection.
4. In the QuerySurge Connection Wizard, click Next.
5. Name the connection (e.g. CData JDBC Connection to HCL Domino).
6. Set the Data Source to "All Other JDBC Connections (Connection Extensibility)" and click Next.
7. Set the Driver Class to cdata.jdbc.domino.DominoDriver and click Next.

8. Set the Connection URL using the necessary connection properties to authenticate with HCL Domino. Your Connection URL will look something like the following:

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

   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.

   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.

9. Set the Test Query to enable the Test Connection button for the Connection (e.g. SELECT * FROM ByName LIMIT 1) and click Next.
10. Click Test Connection to ensure the connection is configured properly and click Save to add the connection.

Once the connection is added, you can write SQL queries against your HCL Domino data in QuerySurge.

Compare HCL Domino Data Queries with a QueryPair

With the connection configured, you can follow the steps below to compare querying HCL Domino data with a QueryPair.

1. Select "Design Library" from the Design Menu
2. Click QueryPairs under QuerySurge Design
3. Click "Create New QueryPair"
4. Name the QueryPair and click Save
5. In either the Source or Target panes, select the connection created above (select the same connection to query HCL Domino twice or another connection to perform a comparison)
6. Write queries in the Editor for each pane, e.g. SELECT * FROM ByName
7. Click the "Design-Time Run" tab to execute the queries
8. When the query execution is finished, click "View Query Results" to see the HCL Domino data returned by the query

Download a free, 30-day trial of the CData JDBC Driver for HCL Domino and start working with your live HCL Domino data in QuerySurge. Reach out to our Support Team if you have any questions.