Configure Your Data for Explorer

Model-Driven Visualization

Data Hub Explorer enables you to view entity models and browse harmonized documents associated with each entity model. To learn more about entity models, see Entities.

View an example entity model.

   {
    "info": {
      "title": "EmployeeDetail",
      "version": "0.0.1",
      "baseUri": "http://example.org/"
    },
    "definitions": {
      "Department": {
        "required": [
          "dept_no"
        ],
        "pii": [],
        "elementRangeIndex": [
          "dept_no"
        ],
        "rangeIndex": [],
        "wordLexicon": [],
        "properties": {
          "dept_no": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          },
          "dept_name": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          }
        }
      },
      "EmployeeDetail": {
        "required": [
          "emp_no",
          "first_name",
          "last_name"
        ],
        "pii": [
          "birth_date"
        ],
        "elementRangeIndex": [
          "emp_no",
          "birth_date"
        ],
        "rangeIndex": [],
        "wordLexicon": [],
        "properties": {
          "emp_no": {
            "datatype": "long"
          },
          "birth_date": {
            "datatype": "date"
          },
          "first_name": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          },
          "last_name": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          },
          "gender": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          },
          "hire_date": {
            "datatype": "date"
          },
          "work_exp": {
            "datatype": "array",
            "items": {
              "$ref": "#/definitions/WorkExperience"
            }
          }
        }
      },
      "Title": {
        "required": [
          "emp_no",
          "title"
        ],
        "pii": [],
        "elementRangeIndex": [
          "emp_no",
          "from_date",
          "to_date"
        ],
        "rangeIndex": [],
        "wordLexicon": [],
        "properties": {
          "emp_no": {
            "datatype": "long"
          },
          "title": {
            "datatype": "string",
            "collation": "http://marklogic.com/collation/codepoint"
          },
          "from_date": {
            "datatype": "date"
          },
          "to_date": {
            "datatype": "date"
          }
        }
      },
      "WorkExperience": {
        "required": [
          "emp_no",
          "dept_no"
        ],
        "pii": [],
        "elementRangeIndex": [
          "emp_no",
          "dept_no"
        ],
        "rangeIndex": [],
        "wordLexicon": [],
        "properties": {
          "emp_no": {
            "datatype": "long"
          },
          "dept_no": {
            "datatype": "string"
          },
          "from_date": {
            "datatype": "date"
          },
          "to_date": {
            "datatype": "date"
          },
          "dept_name": {
            "$ref": "#/definitions/Department"
          },
          "titles": {
            "datatype": "array",
            "items": {
              "$ref": "#/definitions/Title"
            }
          }
        }
      }
    }
  }

View an example harmonized document. The harmonized document is based on the previous example entity model.

   {
    "envelope": {
      "headers": {
        "sources": [
          {
            "name": "EmployeeDetail"
          }
        ],
        "createdOn": "2019-10-09T18:10:47.033043-07:00",
        "createdBy": "admin"
      },
      "triples": [],
      "instance": {
        "EmployeeDetail": {
          "emp_no": 12345,
          "birth_date": "1962-10-12",
          "first_name": "David",
          "last_name": "Smith",
          "gender": "M",
          "hire_date": "1990-03-12",
          "work_exp": {
            "emp_no": 12345,
            "dept_no": "d007",
            "dept_name": "Sales",
            "titles": [
              {
                "title": {
                  "title": "Staff",
                  "from_date": "1990-04-26",
                  "to_date": "1997-04-25"
                }
              },
              {
                "title": {
                  "title": "Senior Staff",
                  "from_date": "1992-04-25",
                  "to_date": "9999-01-01"
                }
              }
            ]
          }
        },
        "info": {
          "title": "EmployeeDetail",
          "version": "0.0.1"
        }
      },
      "attachments": {
        "emp_no": 12345,
        "birth_date": "1962-10-12",
        "first_name": "David",
        "last_name": "Smith",
        "gender": "M",
        "hire_date": "1990-03-12"
      }
    }
  }

Data Hub Explorer Roles

MarkLogic Data Hub provides the following default roles in your Data Hub Explorer project:


Role Name	Role Description
flowDeveloper Note: Data Hub Service role name.	Views entity models: entities and properties. Browses documents associated with each entity model. For details, see Instance Security Roles.
flowOperator Note: Data Hub Service role name.	Views entity models: entities and properties. Browses documents associated with each entity model. For details, see Instance Security Roles.
data-hub-explorer-architect	Views entity models: entities and properties. However, this role: Cannot browse documents associated with each entity model.

To create users and assign preconfigured roles to users with Data Hub Service, see Create a DHS Instance User Account.

Environment

Data Hub Explorer is available in a non-certified development environment on MarkLogic Data Hub Service (DHS).

Version Differences

If you are upgrading from 5.0 or an earlier version, be aware that facets are not available for documents generated from Data Hub 5.0 or an earlier version flows. To learn more about using facets in Data Hub Explorer, see Use Facets with Data Hub Explorer.

Version 5.0 and earlier

For documents generated from Data Hub 5.0 or an earlier version flows, you cannot filter documents with facets. You can browse documents generated by all available steps, except Ingestion step.


Step	Filter with Facets	Browse Documents
Ingestion
Mapping
Matching	N/A	N/A
Merging	N/A	N/A
Mastering
Custom

Note: Matching and Merging steps are not available in Data Hub version 5.0 and earlier.

Version 5.1 and later

For documents generated from Data Hub 5.1 or a later version flows, you can filter documents with facets and browse documents generated by all available steps, except Ingestion step.


Step	Filter with Facets	Browse Documents
Ingestion
Mapping
Matching
Merging
Mastering
Custom

Important: Documents generated from Custom steps must conform to the envelope pattern in Data Hub version 5.1 and later. See Envelope Pattern.