Add HCL Domino Data to Informatica Enterprise Data Catalog



Use the CData JDBC Driver for HCL Domino with the Informatica Enterprise Data Catalog to classify and organize data.

Informatica provides a powerful, elegant means of transporting and transforming your data. By utilizing the CData JDBC driver for HCL Domino, you are gaining access to a driver based on industry-proven standards that integrates seamlessly with Informatica's Enterprise Data Catalog. This tutorial shows how to classify and organize HCL Domino data across any environment.

Load the JDBC Driver

To load the JDBC Driver:

  1. Install the JDBC Driver on the host running Informatica. For this article, it is assumed that the driver was installed into cdata.jdbc.domino.DominoDriver.
  2. $ java -jar setup.jar
  3. Navigate to the JDBC install directory and create a zip file called genericJDBC.zip containing the driver and its license file.
  4. $ cd ~/cdata-jdbc-driver-for-domino/lib $ zip genericJDBC.zip cdata.jdbc.domino.jar cdata.jdbc.domino.lic
  5. Move the genericJDBC.zip file into the Catalog Service directory within Informatica. For this article, it is assumed that Informatica is installed into /opt/informatica. Working in this folder will probably require root permissions, so make sure to su or sudo to root before continuing.
  6. # mv genericJDBC.zip /opt/informatica/services/CatalogService/ScannerBinaries
  7. Edit the custom deployment configuration to unpack the zip file.
  8. # cd /opt/informatica/services/CatalogService/ScannerBinaries/CustomDeployer/ # nano scannerDeployer.xml

    After unpacking the existing ExecutionContextProperty nodes, add a new ExecutionContextProperty node with this content.

    <ExecutionContextProperty isLocationProperty="true" dependencyToUnpack="genericJDBC.zip"> <PropertyName>JDBCScanner_DriverLocation</PropertyName> <PropertyValue>scanner_miti/genericJDBC/Drivers</PropertyValue> </ExecutionContextProperty>
  9. Refresh the Catalog Service from the Admin console.

Configure the JDBC Resource

To configure the JDBC resource:

  1. Open the Catalog administrator and add a new JDBC resource with the following properties:
    • Driver Class: cdata.jdbc.domino.DominoDriver
    • URL: jdbc.domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;
    • 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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

    Typical additional connection string properties follow:

    JDBC;MSTR_JDBC_JAR_FOLDER=PATH\TO\JAR\;DRIVER=cdata.jdbc.domino.DominoDriver;URL={jdbc:domino:Server=https://domino.corp.com;AuthScheme=OAuthPassword;User=my_domino_user;Password=my_domino_password;};
  2. Username: user
  3. Password: password
  4. Note that the Username and Password properties are required, even if the driver you are using does not require them. In those cases, you can enter a placeholder value instead.

  5. Configure the metadata options to perform at least one source metadata scan. This scan uses the driver to determine what tables, views, and stored procedures are available through the service.
    • Source Metadata: Enable this option.
    • Catalog: Set this to the appropriate catalog for multi-catalog data sources. Otherwise, set this to CData.
    • Schema: Set this to the appropriate schema for multi-schema data sources. Otherwise, set this to the name of the service (for example, Couchbase).
    • Case-sensitivity: Generally this option should be disabled. Enable it only for data sources which are case-sensitive.
    • Import stored procedures: Enable this if you want to import stored procedure definitions in addition to tables and views.

    Other metadata scanners may be enabled as desired.

  6. Complete the driver configuration, optionally configuring custom attributes and a scanner schedule.
  7. Perform the metadata scan by navigating to the Monitoring tab and clicking Run. Depending upon the data source, this may takes a few minutes.

When the scan is complete, a summary of all of the metadata objects is displayed along with the status of the Metadata Load job. If any errors occur, you can open the Log Location link for the job to see the errors reported by Informatica or the driver.

Validate the Discovered Metadata

Open the Catalog Service browser to view the metadata extracted from the data source. Depending upon the options you selected when configuring the metadata scanner, you may see any combination of tables, views, and stored procedures for the resource you defined.

Ready to get started?

Download a free trial of the HCL Domino Driver to get started:

 Download Now

Learn more:

HCL Domino Icon HCL Domino JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with HCL Domino.