Glossary

Dataset

A dataset is an identifiable collection of structured data objects (distribution list) unified by some criteria (authorship, subject, scope, spatial or temporal extent…) this is called metadata.

Harvest Plan

The harvest plan is the configuration used to import data into your catalog. https://github.com/GetDKAN/harvest/blob/master/schema/schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "harvest-plan",
  "type": "object",
  "title": "Harvest Plan",
  "required": [
    "identifier",
    "extract",
    "load"
  ],
  "properties": {
    "identifier": {
      "type": "string",
      "title": "The plan's identifier",
      "pattern": "^(.*)$"
    },
    "extract": {
      "type": "object",
      "title": "Extract",
      "required": [
        "type",
        "uri"
      ],
      "properties": {
        "type": {
          "type": "string",
          "title": "Class utilized to extract the data from the source."
        },
        "uri": {
          "type": "string",
          "title": "The URL or Location of the Source",
          "examples": [
            "http://demo.getdkan.com/data.json"
          ]
        }
      }
    },
    "transforms": {
      "type": "array",
      "title": "The Transforms for the Harvest",
      "additionalProperties": false,
      "items": {
        "type": "string"
      }
    },
    "load": {
      "type": "object",
      "title": "The Load settings for the Harvest",
      "required": [
        "type"
      ],
      "properties": {
        "type": {
          "type": "string",
          "title": "Class utilized to load the harvested data."
        }
      }
    }
  }
}

JSON Schema

Schema is a human and machine readable vocabulary that allows you to annotate a list of properties and validate JSON documents.

Metadata

Metadata is structured information that describes, explains, locates, or otherwise makes it easier to retrieve, use, or manage a data resource. The challenge is to define and name standard metadata fields so that a data consumer has sufficient information to find, process and understand the described data. The more information that can be conveyed in a standardized regular format, the more valuable data becomes.

There are a number of specifications for dataset metadata. By default, DKAN ships with a "Project Open Data"-inspired schema for datasets.