Getting Started Tutorial 2.x
Install the Framework

1 - Download and Install MarkLogic

2 - Download the QuickStart War

  • Create a folder for this hub project and open a command line window into it. You can create the folder however you like. Here’s an example of creating it from the command line.
mkdir data-hub
cd data-hub
  • Download the Quick Start war and place it in the folder you just created.

3 - Download the Sample Data

  • Create a folder to hold your input data
mkdir input

Your directory should look like this:

data-hub
 +-- input
 +-- quick-start-2.0.4.war

4 - Run the QuickStart

The QuickStart application is a stand-alone Java Web Application. It runs its own internal web server and serves up the application on port 8080. You do have the option to change the port as noted below. QuickStart can be run on any computer as long as there is network connectivity to your MarkLogic instance. Quickstart will communicate with MarkLogic over http.

Let’s run the Quickstart:

  1. Open a terminal window in the data-hub directory
  2. Run the War
java -jar quick-start-2.0.4.war

If you need to run on a different port then add the –server.port option

java -jar quick-start-2.0.4.war --server.port=9000

Start QuickStart

If you are on Windows you may be presented with a Firewall Notice: Firewall notice

Click Allow Access

5 - Login to the Hub

After opening the QuickStart Application you must step through a wizard to properly configure the Hub.

  1. Browse to the directory where your hub lives. If you saved and ran the Quickstart war file in the hub directory, then you should be in the correct directory. Click Next. Hub Directory

  2. Initialize your Data Hub Project Directory. Click INITIALIZE. Hub Directory

  3. You have now initialized your Data Hub Framework project. Your project folder now contains many new files and directories. If you are curious, you can read about the files in a Data Hub project. Click Next. Hub Directory

  4. Choose the Local Environment. Click Next. Hub Directory

  5. Login to the Hub with your MarkLogic credentials Hub Directory

  6. Install the Hub into MarkLogic. Click Install. You will then see a screen with progress while the Data Hub is being installed. Hub Directory

Congratulations! The Data Hub Framework is installed and ready to use. You are taken to the Dashboard page where you can see the document counts of all four hub databases. Additionally, you can clear out the databases one-by-one or in one fell swoop.

The four databases are:

  • Staging: holds incoming data
  • Final: holds harmonized data
  • Job: holds data about the jobs you run
  • Trace: holds debugging data about each document that has been harmonized

Hub Directory

Up Next

Loading Products > Create the Product Entity