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.

Query HCL Domino Data in ColdFusion



Write standard ColdFusion data access code to connect to HCL Domino data.

The CData JDBC Driver for HCL Domino seamlessly integrates connectivity to HCL Domino data with the rapid development tools in ColdFusion. This article shows how to connect to HCL Domino data in ColdFusion and query HCL Domino tables.

Create a JDBC Data Source for HCL Domino in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

  1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

    The JAR and license for the driver are located in the lib subfolder of the installation directory.

    Restart the server after this step.

  2. Add the driver as a data source:

    From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

  3. Populate the driver properties:

    • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:domino: and is followed by the connection properties in a semicolon-separated list of name=value pairs.

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

      jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
    • Driver Class: Enter the driver class. The driver class is cdata.jdbc.domino.DominoDriver.
    • Driver Name: Enter a user-defined name for the driver.
    • Username: Enter the username used to authenticate.
    • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData HCL Domino data source in the Actions column. After reporting a status of OK, the HCL Domino data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to HCL Domino. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

<cfquery name="DominoQuery" dataSource="CDataDomino"> SELECT * FROM ByName WHERE City = <cfqueryparam value="#City#" cfsqltype="cf_sql_varchar"> </cfquery> <cfdump var="#DominoQuery#">

Below is the equivalent in CFScript:


<cfscript>
result = queryExecute(
  "SELECT * FROM ByName WHERE City = ?", 
  [
    { value="Miami", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataDomino" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following:

http://MyServer:8500/query.cfm?City=Miami