Connect to HCL Domino Data as a SQL Server Linked Server

SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect Cloud, linked servers provides instant access to HCL Domino data from your SQL Server database. This article demonstrates how to connect to HCL Domino using Connect Cloud and query HCL Domino data in SQL Server Management Studio (SSMS).

CData Connect Cloud provides a pure SQL Server interface for HCL Domino, allowing you to query data from HCL Domino without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect Cloud pushes all supported SQL operations (filters, JOINs, etc.) directly to HCL Domino, leveraging server-side processing to return the requested HCL Domino data quickly.

Configure HCL Domino Connectivity for SQL Server

Connectivity to HCL Domino from SQL Linked Servers is made possible through CData Connect Cloud. To work with HCL Domino data from SQL Linked Servers, we start by creating and configuring a HCL Domino connection.

1. Log into Connect Cloud, click Connections and click Add Connection
2. Select "HCL Domino" from the Add Connection panel
3. Enter the necessary authentication properties to connect to HCL Domino.

   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.

4. Click Create & Test
5. Navigate to the Permissions tab in the Add HCL Domino Connection page and update the User-based permissions.

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

1. Click on your username at the top right of the Connect Cloud app and click User Profile.
2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
3. Give your PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to HCL Domino from SQL Server using Connect Cloud

To establish a connection from SQL Server Linked Server to the CData Connect Cloud Virtual SQL Server API, follow these steps.

1. Open Microsoft SQL Server Management Studio.
2. In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.
3. The New Linked Server dialogue opens. On the General page, enter the following information:
   • Enter a name for the server in the Linked server field.
   • Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
   • In the Data source field, enter tds.cdata.com,14333
   • In the Catalog field, enter enter the Connection Name of the CData Connect Cloud data source you want to connect to (for example, Domino1).
4. Select the Security page. At the bottom, select the radio button labeled Be made using this security context and enter the following information:
   • Remote login - enter your CData Connect Cloud username. This is displayed in the top-right corner of the CData Connect Cloud interface. For example, test@cdata.com.
   • With password - enter the PAT you generated on the Settings page.
5. Click OK to create the server.
Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.

Execute Queries

You can now execute queries to the HCL Domino linked server from any tool that can connect to SQL Server. An example SQL query would be: SELECT * FROM [CDATA CONNECT CLOUD].[Domino1].[Domino].[ByName] We have successfully created a linked server that allows us to query HCL Domino data.

Get CData Connect Cloud

To get live data access to 100+ SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect Cloud today!