Automated Continuous HubDB Replication to MongoDB

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

Configure MongoDB as a Replication Destination

Using CData Sync, you can replicate HubDB data to MongoDB. To add a replication destination, navigate to the Connections tab.

1. Click Add Connection.
2. Select the Destinations tab and locate the MongoDB 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 MongoDB connector. For more information about installing new connectors, see Connections in the Help documentation.
4. To connect to MongoDB, set the following connection properties:
   • Connection Name: Enter a connection name of your choice for the MongoDB connection.
   • Server: Enter either the host name or the IP address of the server that hosts your MongoDB instance.
   • Port: Enter the port number of the server that hosts your instance of MongoDB. The default port value is 27017.
   • Auth Scheme: Select the authentication scheme.
   • User: Set this to the database user.
   • Password: Set this to the user's password.
   • Database: Set this to the database you want to read from and write to.
   • Auth Database: Enter the name of the MongoDB database for authentication.

5. Once connected, click Create & Test to create, test and save the connection.

You are now connected to MongoDB 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 HubDB data into MongoDB and utilize it as a destination.

Configure the HubDB Connection

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

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

   There are two authentication methods available for connecting to HubDB data source: OAuth Authentication with a public HubSpot application and authentication with a Private application token.

   Using a Custom OAuth App

   AuthScheme must be set to "OAuth" in all OAuth flows. Be sure to review the Help documentation for the required connection properties for you specific authentication needs (desktop applications, web applications, and headless machines).

   Follow the steps below to register an application and obtain the OAuth client credentials:

   1. Log into your HubSpot app developer account.
      • Note that it must be an app developer account. Standard HubSpot accounts cannot create public apps.
   2. On the developer account home page, click the Apps tab.
   3. Click Create app.
   4. On the App info tab, enter and optionally modify values that are displayed to users when they connect. These values include the public application name, application logo, and a description of the application.
   5. On the Auth tab, supply a callback URL in the "Redirect URLs" box.
      • If you're creating a desktop application, set this to a locally accessible URL like http://localhost:33333.
      • If you are creating a Web application, set this to a trusted URL where you want users to be redirected to when they authorize your application.
   6. Click Create App. HubSpot then generates the application, along with its associated credentials.
   7. On the Auth tab, note the Client ID and Client secret. You will use these later to configure the driver.

   8. Under Scopes, select any scopes you need for your application's intended functionality.

      A minimum of the following scopes is required to access tables:

      • hubdb
      • oauth
      • crm.objects.owners.read
   9. Click Save changes.
   10. Install the application into a production portal with access to the features that are required by the integration.
       • Under "Install URL (OAuth)", click Copy full URL to copy the installation URL for your application.
       • Navigate to the copied link in your browser. Select a standard account in which to install the application.
       • Click Connect app. You can close the resulting tab.

   Using a Private App

   To connect using a HubSpot private application token, set the AuthScheme property to "PrivateApp."

   You can generate a private application token by following the steps below:

   1. In your HubDB account, click the settings icon (the gear) in the main navigation bar.
   2. In the left sidebar menu, navigate to Integrations > Private Apps.
   3. Click Create private app.
   4. On the Basic Info tab, configure the details of your application (name, logo, and description).
   5. On the Scopes tab, select Read or Write for each scope you want your private application to be able to access.
   6. A minimum of hubdb and crm.objects.owners.read is required to access tables.
   7. After you are done configuring your application, click Create app in the top right.
   8. Review the info about your application's access token, click Continue creating, and then Show token.
   9. Click Copy to copy the private application token.

   To connect, set PrivateAppToken to the private application token you retrieved.

   
4. Click Connect to HubDB 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 HubDB tables you wish to replicate into MongoDB, 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 HubDB data to MongoDB.

Run the Replication Job

Once all the required configurations are made for the job, select the HubDB 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 HubDB data into MongoDB, 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.