Connect to HCL Domino Data in RapidMiner

This article shows how you can easily integrate the CData JDBC driver for HCL Domino into your processes in RapidMiner. This article uses the CData JDBC Driver for HCL Domino to transfer HCL Domino data to a process in RapidMiner.

Connect to HCL Domino in RapidMiner as a JDBC Data Source

You can follow the procedure below to establish a JDBC connection to HCL Domino:

1. Add a new database driver for HCL Domino: Click Connections -> Manage Database Drivers.
2. In the resulting wizard, click the Add button and enter a name for the connection.
3. Enter the prefix for the JDBC URL: jdbc:domino:
4. Enter the path to the cdata.jdbc.domino.jar file, located in the lib subfolder of the installation directory.
5. Enter the driver class: cdata.jdbc.domino.DominoDriver
6. Create a new HCL Domino connection: Click Connections -> Manage Database Connections.
7. Enter a name for your connection.
8. For Database System, select the HCL Domino driver you configured previously.
9. Enter your connection string in the Host box.

   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 Azure Active Directory 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.

   AzureAD

   This authentication method uses Azure Active Directory as an IdP to obtain a JWT token. You need to create a custom OAuth application in Azure Active Directory 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 "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 Azure Active Directory > 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.

   A typical connection string is below:

   Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;
10. Enter your username and password if necessary.

You can now use your HCL Domino connection with the various RapidMiner operators in your process. To retrieve HCL Domino data, drag the Retrieve operator from the Operators view. With the Retrieve operator selected, you can then define which table to retrieve in the Parameters view by clicking the folder icon next to the "repository entry." In the resulting Repository Browser, you can expand your connection node to select the desired example set.

Finally, wire the output to the Retrieve process to a result, and run the process to see the HCL Domino data.