Getting Started Tutorial for DHF 2.x

Building an Online Shopping Hub Tutorial

This tutorial will walk you through setting up a very simple hub for harmonizing online shopping data.

The story is:

Our company sells board games and board game accessories. We have been tasked with creating a Data Hub on top of MarkLogic. We must load all of our Product and Order data into MarkLogic and harmonize it for use in a new application. Our approach will be broken down into five main steps.

  1. Load Product data As-Is
  2. Harmonize Product data
  3. Load Order data As-Is
  4. Harmonize Order data
  5. Serve the data to downstream clients

In a Hurry?

The finished version of this tutorial is available for you to download and play with. Finished Online Shopping Hub Example


This tutorial uses QuickStart, a simple User Interface that you can run locally to start working with the Data Hub Framework quickly. With QuickStart you will have a working hub in a matter of minutes. No need to worry about deployment strategies or configuration details. Simply run the QuickStart war (java web archive) and point it at your MarkLogic installation. Quickstart is a devops tool. It is meant to be run on your development machine to aid you in quickly deploying your hub.


Before you can run the hub, you will need to have some some software installed.

  • Oracle’s Java 8 JRE (We have not tested with OpenJDK) Not sure which version you have? Try running this from a command line:
    java -version
  • MarkLogic 9 (9.0.1-1 or later, installed and initialized) Not sure? Open your web browser to http://localhost:8001 After you logon look at the top left corner for the version info: Check ML Version
  • A Modern Browser. (Chrome or FireFox work best. Use IE at your own risk.)

Common Concerns

  1. I have a MarkLogic instance but it already has awesome stuff in it. Will this tutorial mess that up? No. The Data Hub Framework is installed on isolated AppServers, Databases, etc. It is possible that the default DHF ports (8010, 8011, 8012, 8013) may already be in use already. In that case you will be warned about the conflicts and given the opportunity to change them. The DHF will not harm any existing settings.
  2. How difficult is it to remove this tutorial when I am finished? Easy. Simply click on the Settings tab at the top of QuickStart. Then click Uninstall.

Table of Contents

  1. Install the Data Hub Framework
  2. Loading Products
    1. Create the Product Entity
    2. Create the Product Input Flow
    3. Load the Product Data As-Is
  3. Harmonizing Products
    1. Browse and Understand the Product Data
    2. Modeling the Product Entity
    3. Harmonizing the Product Data
  4. Loading Orders
    1. Create the Order Entity
    2. Create the Order Input Flow
    3. Load the Orders As-Is
  5. Harmonizing Orders
    1. Modeling the Order Entity
    2. Harmonizing the Order Data
  6. Serve the Data Out of MarkLogic
  7. Wrapping Up

See Also