ETL HCL Domino in Oracle Data Integrator

Leverage existing skills by using the JDBC standard to connect to HCL Domino: Through drop-in integration into ETL tools like Oracle Data Integrator (ODI), the CData JDBC Driver for HCL Domino connects real-time HCL Domino data to your data warehouse, business intelligence, and Big Data technologies.

JDBC connectivity enables you to work with HCL Domino just as you would any other database in ODI. As with an RDBMS, you can use the driver to connect directly to the HCL Domino APIs in real time instead of working with flat files.

This article covers a JDBC-based ETL -- HCL Domino to Oracle. After reverse engineering a data model of HCL Domino entities, you will create a mapping and select a data loading strategy -- since the driver supports SQL-92, this last step can easily be accomplished by selecting the built-in SQL to SQL Loading Knowledge Module.

Install the Driver

To install the driver, copy the driver JAR (cdata.jdbc.domino.jar) and .lic file (cdata.jdbc.domino.lic), located in the installation folder, into the ODI appropriate directory:

• UNIX/Linux without Agent: ~/.odi/oracledi/userlib
• UNIX/Linux with Agent: ~/.odi/oracledi/userlib and $ODI_HOME/odi/agent/lib
• Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
• Windows with Agent: %APPDATA%\odi\oracledi\userlib and %APPDATA%\odi\agent\lib

Restart ODI to complete the installation.

Reverse Engineer a Model

Reverse engineering the model retrieves metadata about the driver's relational view of HCL Domino data. After reverse engineering, you can query real-time HCL Domino data and create mappings based on HCL Domino tables.

1. In ODI, connect to your repository and click New -> Model and Topology Objects. 👁 Create a New Model
   
2. On the Model screen of the resulting dialog, enter the following information:
   • Name: Enter Domino.
   • Technology: Select Generic SQL (for ODI Version 12.2+, select Microsoft SQL Server).
   • Logical Schema: Enter Domino.
   • Context: Select Global.
   👁 Configuring the Model
   
3. On the Data Server screen of the resulting dialog, enter the following information:
   • Name: Enter Domino.
   • Driver List: Select Oracle JDBC Driver.
   • Driver: Enter cdata.jdbc.domino.DominoDriver
   • URL: Enter the JDBC URL containing the connection string.

     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.)
     

     Below is a typical connection string:

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

   👁 Configuring the Data Server
   
4. On the Physical Schema screen, enter the following information:
   • Name: Select from the Drop Down menu.
   • Database (Catalog): Enter CData.
   • Owner (Schema): If you select a Schema for HCL Domino, enter the Schema selected, otherwise enter Domino.
   • Database (Work Catalog): Enter CData.
   • Owner (Work Schema): If you select a Schema for HCL Domino, enter the Schema selected, otherwise enter Domino.
   👁 Configuring the Physical Schema
   
5. In the opened model click Reverse Engineer to retrieve the metadata for HCL Domino tables. 👁 Reverse Engineer the Model
   

Edit and Save HCL Domino Data

After reverse engineering you can now work with HCL Domino data in ODI. To view HCL Domino data, expand the Models accordion in the Designer navigator, right-click a table, and click View data. 👁 Viewing the data.

Create an ETL Project

Follow the steps below to create an ETL from HCL Domino. You will load ByName entities into the sample data warehouse included in the ODI Getting Started VM.

1. Open SQL Developer and connect to your Oracle database. Right-click the node for your database in the Connections pane and click new SQL Worksheet.

   Alternatively you can use SQLPlus. From a command prompt enter the following:

   sqlplus / as sysdba
   

2. Enter the following query to create a new target table in the sample data warehouse, which is in the ODI_DEMO schema. The following query defines a few columns that match the ByName table in HCL Domino:

   CREATE TABLE ODI_DEMO.TRG_BYNAME (ADDRESS NUMBER(20,0),Name VARCHAR2(255));
   

3. In ODI expand the Models accordion in the Designer navigator and double-click the Sales Administration node in the ODI_DEMO folder. The model is opened in the Model Editor.
4. Click Reverse Engineer. The TRG_BYNAME table is added to the model.
5. Right-click the Mappings node in your project and click New Mapping. Enter a name for the mapping and clear the Create Empty Dataset option. The Mapping Editor is displayed.
6. Drag the TRG_BYNAME table from the Sales Administration model onto the mapping.
7. Drag the ByName table from the HCL Domino model onto the mapping.
8. Click the source connector point and drag to the target connector point. The Attribute Matching dialog is displayed. For this example, use the default options. The target expressions are then displayed in the properties for the target columns.
9. Open the Physical tab of the Mapping Editor and click BYNAME_AP in TARGET_GROUP.
10. In the BYNAME_AP properties, select LKM SQL to SQL (Built-In) on the Loading Knowledge Module tab. 👁 SQL-based access to HCL Domino enables you to use standard database-to-database knowledge modules.
    

You can then run the mapping to load HCL Domino data into Oracle.