Connect to HCL Domino Data in NetBeans

The CData JDBC Driver for HCL Domino integrates connectivity to live HCL Domino data in IDEs that support JDBC. The JDBC standard enables you to use built-in data access wizards and other tools supporting rapid development. This article shows how to connect to HCL Domino data in NetBeans. You will create a connection and load HCL Domino data in the Table Editor.

Create a JDBC Data Source for HCL Domino in NetBeans

To create the JDBC data source, expand the Database node in the Service window, right-click the Drivers node, and select New Driver. In the New Driver wizard that results, enter the following information:

• Driver File(s): Click Add and, in the file explorer dialog that appears, select the cdata.jdbc.domino.jar file. The driver JAR is located in the lib subfolder of the installation directory.
• Driver Class: Click Find to search for the driver class inside the JAR. Then select cdata.jdbc.domino.DominoDriver from the menu.
• Name: Enter the name for the driver.

Define Connection Parameters

Follow the steps below to define required connection properties:

1. In the Service window, right-click the Database node and click New Connection.

2. In the New Connection Wizard, enter the following connection properties:

   • Driver Name: In the menu, select the CData JDBC Driver for HCL Domino.
   • User Name: Enter the username. This can also be defined in the JDBC URL.
   • Password: Enter the password. This can also be defined in the JDBC URL.

   • JDBC URL: Specify the JDBC URL.

     Connecting to Domino

     To connect to Domino data, set the following properties:

     • URL: The host name or IP of the server hosting the Domino database. Include the port of the server hosting the Domino database. For example: http://sampleserver:1234/
     • DatabaseScope: The name of a scope in the Domino Web UI. The driver exposes forms and views for the schema governed by the specified scope. In the Domino Admin UI, select the Scopes menu in the sidebar. Set this property to the name of an existing scope.

     Authenticating with Domino

     Domino supports authenticating via login credentials or an Entra ID (formerly Azure AD) OAuth application:

     Login Credentials

     To authenticate with login credentials, set the following properties:

     • AuthScheme: Set this to "OAuthPassword"
     • User: The username of the authenticating Domino user
     • Password: The password associated with the authenticating Domino user

     The driver uses the login credentials to automatically perform an OAuth token exchange.

     EntraID (formerly AzureAD)

     This authentication method uses Entra ID (formerly Azure AD) as an IdP to obtain a JWT token. You need to create a custom OAuth application in Entra ID (formerly Azure AD) and configure it as an IdP. To do so, follow the instructions in the Help documentation. Then set the following properties:

     • AuthScheme: Set this to "EntraID (formerly AzureAD)"
     • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
     • OAuthClientId: The Client ID obtained when setting up the custom OAuth application.
     • OAuthClientSecret: The Client secret obtained when setting up the custom OAuth application.
     • CallbackURL: The redirect URI defined when you registered your app. For example: https://localhost:33333
     • AzureTenant: The Microsoft Online tenant being used to access data. Supply either a value in the form companyname.microsoft.com or the tenant ID.

       The tenant ID is the same as the directory ID shown in the Azure Portal's Entra ID (formerly Azure AD) > Properties page.

     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.

     👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
     

     A typical JDBC URL is the following:

     jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;

Query HCL Domino Data

To connect to HCL Domino data, right-click the connection in the Database node and click Connect. After the connection is established, you can expand it to discover schema information.

To load a table in the Data Views window, right-click the table and then click View Data..