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 walks through 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 and .lic file, located in the installation folder, into the ODI appropriate directory:

• UNIX/Linux without Agent: ~/.odi/oracledi/userlib
• UNIX/Linux with Agent: $ODI_HOME/odi/agent/lib
• Windows without Agent: %APPDATA%\Roaming\odi\oracledi\userlib
• Windows with Agent: %APPDATA%\Roaming\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.
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.
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.

     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.

     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.

     Below is a typical connection string:

     jdbc:domino:Server=https://domino.corp.com;Database=names.nsf;Port=3002;SSLClientCertType=PEMKEY_FILE;SSLClientCert=full_path_of_certificate.pem;SSLServerCert=*
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.
5. In the opened model click Reverse Engineer to retrieve the metadata for HCL Domino tables.

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.

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.

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