Automated Continuous HCL Domino Replication to Apache Cassandra



Use CData Sync for automated, continuous, customizable HCL Domino replication to Apache Cassandra.

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live HCL Domino data into your Apache Cassandra instance, allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure Apache Cassandra as a Replication Destination

Using CData Sync, you can replicate HCL Domino data to Apache Cassandra. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select the Destinations tab and locate the Cassandra connector.
  3. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Cassandra connector. For more information about installing new connectors, see Connections in the Help documentation.
  4. To connect to Apache Cassandra, set the following connection properties:
    • Connection Name: Enter a connection name of your choice for the Cassandra connection.
    • Server: Enter the host name or the IP address of the server that hosts the Cassandra database. The default host name is localhost.
    • Port: Enter the port number of the server that hosts the Cassandra database. The default port value is 9042.
    • Database: Enter the name of the Cassandra keyspace that contains your tables.
    • Auth Scheme: Select the authentication scheme. The default setting is Basic.
    • User: Enter the username that you use to authenticate to the Cassandra database.
    • Password: Enter the password that you use to authenticate to the Cassandra database.
    • Use SSL: Specify whether you want to use the Secure Sockets Layer (SSL) protocol. The default value is False.
    • Consistency Level: Select the number of the replicas from which you want to enforce a response before queries are considered a success.
  5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to Apache Cassandra and can use it as both a source and a destination.

NOTE: You can use the Label feature to add a label for a source or a destination.

In this article, we will demonstrate how to load HCL Domino data into Apache Cassandra and utilize it as a destination.

Configure the HCL Domino Connection

You can configure a connection to HCL Domino from the Connections tab. To add a connection to your HCL Domino account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (HCL Domino).
  3. Configure the connection properties.

    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.

  4. Click Connect to HCL Domino to ensure that the connection is configured properly.
  5. Click Save & Test to save the changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

Replicate Entire Tables

To replicate an entire table, navigate to the Task tab in the Job, click Add Tasks, choose the table(s) from the list of HCL Domino tables you wish to replicate into Apache Cassandra, and click Add Tasks again.

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication with the help of SQL queries.

Schedule Your Replication

Select the Overview tab in the Job, and click Configure under Schedule. You can schedule a job to run automatically by configuring it to run at specified intervals, ranging from once every 10 minutes to once every month.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your HCL Domino data to Apache Cassandra.

Run the Replication Job

Once all the required configurations are made for the job, select the HCL Domino table you wish to replicate and click Run. After the replication completes successfully, a notification appears, showing the time taken to run the job and the number of rows replicated.

Free Trial & More Information

Now that you have seen how to replicate HCL Domino data into Apache Cassandra, visit our CData Sync page to explore more about CData Sync and download a free 30-day trial. Start consolidating your enterprise data today!

As always, our world-class Support Team is ready to answer any questions you may have.

Ready to get started?

Learn more or sign up for a free trial:

CData Sync