Connect to HCL Domino Data in HULFT Integrate

HULFT Integrate is a modern data integration platform that provides a drag-and-drop user interface to create cooperation flows, data conversion, and processing so that complex data connections are easier than ever to execute. When paired with the CData JDBC Driver for HCL Domino, HULFT Integrate can work with live HCL Domino data. This article walks through connecting to HCL Domino and moving the data into a CSV file.

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.

Enable Access to HCL Domino

To enable access to HCL Domino data from HULFT Integrate projects:

1. Copy the CData JDBC Driver JAR file (and license file if it exists), cdata.jdbc.domino.jar (and cdata.jdbc.domino.lic), to the jdbc_adapter subfolder for the Integrate Server
2. Restart the HULFT Integrate Server and launch HULFT Integrate Studio

Build a Project with Access to HCL Domino Data

Once you copy the JAR files, you can create a project with access to HCL Domino data. Start by opening Integrate Studio and creating a new project.

1. Name the project
2. Ensure the "Create script" checkbox is checked
3. Click Next
4. Name the script (e.g.: DominotoCSV)

Once you create the project, add components to the script to copy HCL Domino data to a CSV file.

Configure an Execute Select SQL Component

Drag an "Execute Select SQL" component from the Tool Palette (Database -> JDBC) into the Script workspace.

1. In the "Required settings" tab for the Destination, click "Add" to create a new connection for HCL Domino. Set the following properties:
   • Name: HCL Domino Connection Settings
   • Driver class name: cdata.jdbc.domino.DominoDriver
   • URL: jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;
     
     

     Built-in Connection String Designer

     For assistance 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.

     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.

2. Write your SQL statement. For example:

   SELECT Name, Address FROM ByName

3. Click "Extraction test" to ensure the connection and query are configured properly
4. Click "Execute SQL statement and set output schema"
5. Click "Finish"

Configure a Write CSV File Component

Drag a "Write CSV File" component from the Tool Palette (File -> CSV) onto the workspace.

1. Set a file to write the query results to (e.g. ByName.csv)
2. Set "Input data" to the "Select SQL" component
3. Add columns for each field selected in the SQL query
4. In the "Write settings" tab, check the checkbox to "Insert column names into first row"
5. Click "Finish"

Map HCL Domino Fields to the CSV Columns

Map each column from the "Select" component to the corresponding column for the "CSV" component.

Finish the Script

Drag the "Start" component onto the "Select" component and the "CSV" component onto the "End" component. Build the script and run the script to move HCL Domino data into a CSV file.

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