VOOZH about

URL: https://www.cdata.com/kb/tech/domino-jdbc-snaplogic.rst

⇱ Integrate HCL Domino with External Services using SnapLogic


Integrate HCL Domino with External Services using SnapLogic

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData JDBC drivers in SnapLogic to integrate HCL Domino with External Services.

SnapLogic is an integration platform-as-a-service (iPaaS) that allows users to create data integration flows with no code. When paired with the CData JDBC Drivers, users get access to live data from more than 250+ SaaS, Big Data and NoSQL sources, including HCL Domino, in their SnapLogic workflows.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live HCL Domino data. When platforms 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 lets you work with HCL Domino data using native data types.

Connect to HCL Domino in SnapLogic

To connect to HCL Domino data in SnapLogic, download and install the CData HCL Domino JDBC Driver. Follow the installation dialog. When the installation is complete, the JAR file can be found in the installation directory (C:/Program Files/CData/CData JDBC Driver for HCL Domino/lib by default).

Upload the HCL Domino JDBC Driver

After installation, upload the JDBC JAR file to a location in SnapLogic (for example, projects/Jerod Johnson) from the Manager tab.

πŸ‘ Uploaded JDBC Driver (Salesforce & QuickBooks Online are shown)

Configure the Connection

Once the JDBC Driver is uploaded, we can create the connection to HCL Domino.

  1. Navigate to the Designer tab
  2. Expand "JDBC" from Snaps and drag a "Generic JDBC - Select" snap onto the designer πŸ‘ Adding a Generic JDBC snap onto the designer
  3. Click Add Account (or select an existing one) and click "Continue"
  4. In the next form, configure the JDBC connection properties:
    • Under JDBC JARs, add the JAR file we previously uploaded
    • Set JDBC Driver Class to cdata.jdbc.domino.DominoDriver
    • Set JDBC URL to a JDBC connection string for the HCL Domino JDBC Driver, for example:

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

      NOTE: RTK is a trial or full key. Contact our Support team for more information. πŸ‘ Configuring a connection (Salesforce is shown)

      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.

      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.

      πŸ‘ Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  5. After entering the connection properties, click "Validate" and "Apply"

Read HCL Domino Data

In the form that opens after validating and applying the connection, configure your query.

  • Set Schema name to "Domino"
  • Set Table name to a table for HCL Domino using the schema name, for example: "Domino"."ByName" (use the drop-down to see the full list of available tables)
  • Add Output fields for each item you wish to work with from the table
πŸ‘ Configuring a Select snap (Salesforce is shown)

Save the Generic JDBC - Select snap.

With connection and query configured, click the end of the snap to preview the data (highlighted below).

πŸ‘ Click the end of the snap to preview the data.

Once you confirm the results are what you expect, you can add additional snaps to funnel your HCL Domino data to another endpoint.

πŸ‘ Previewing data (Salesforce is shown).

Piping HCL Domino Data to External Services

For this article, we will load data in a Google Spreadsheet. You can use any of the supported snaps, or even use a Generic JDBC snap with another CData JDBC Driver, to move data into an external service.

  1. Start by dropping a "Worksheet Writer" snap onto the end of the "Generic JDBC - Select" snap.
  2. Add an account to connect to Google Sheets πŸ‘ Connecting to Google
  3. Configure the Worksheet Writer snap to write your HCL Domino data to a Google Spreadsheet πŸ‘ Writing to a Google Spreadsheet

You can now execute the fully configured pipeline to extract data from HCL Domino and push it into a Google Spreadsheet.

πŸ‘ Data written to Google Spreadsheets (Salesforce is shown)

More Information & Free Trial

Using the CData JDBC Driver for HCL Domino you can create a pipeline in SnapLogic for integrating HCL Domino data with external services. For more information about connecting to HCL Domino, check at our CData JDBC Driver for HCL Domino page. Download a free, 30 day trial of the CData JDBC Driver for HCL Domino and get started today.