Extension DDI metadata standard support with NADA harvester


Extension Basics

Title
DDI metadata standard support with NADA harvester
Name
ckanext-ddi
Type
Public extension
Description
Import and manage DDI (Data Documentation Initiative) format datasets for statistical data
CKAN versions
Download-Url (zip)
Download-Url commit date
2015-01-01
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

This extension provides comprehensive support for the DDI (Data Documentation Initiative) standard format, developed with World Bank support for National Statistical Offices. Features include: configurable DDI field display and structure via YAML configuration, 45+ predefined DDI fields (identification, overview, production, coverage, access, contact fields), import DDI data via command line with paster command, upload DDI XML files directly through web interface with dedicated import page, manual dataset management via customized CKAN frontend form, NADA harvester plugin for automatic data import from NADA instances, configurable sections grouping related fields (identification, overview, contact), controlled vocabularies support for standardized values, flexible field types (text, markdown, url, email, vocabulary), customizable field visibility and display settings, license configuration with defaults, duplicate detection based on id_number attribute, override existing datasets option. NADA harvester supports access_type filtering (public_use, direct_access, licensed, etc.). Requires CKAN 2.3+ and ckanext-harvest for harvesting functionality.

Version
1.0.0
Version release date
2015-01-01
Contact name
Liip AG
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Install the extension:

source /home/www-data/pyenv/bin/activate

pip install -e git+https://github.com/liip/ckanext-ddi.git#egg=ckanext-ddi –src /home/www-data

cd /home/www-data/ckanext-ddi

pip install -r requirements.txt

python setup.py develop

Enable plugins in your config file:

ckan.plugins = ddi_schema ddi_theme nada_harvester

Note: Omit ddi_theme if you don’t want the frontend part.

Configuration options:

Path to DDI-specific YAML configuration file (required)

ckanext.ddi.config_file = /path/to/my/config.yml

Default license for all DDI imports if not specified

ckanext.ddi.default_license = CC0-1.0

Allow duplicate datasets (default: False)

Duplicates determined by unique id_number attribute

ckanext.ddi.allow_duplicates = True

Override existing datasets on import (default: False)

If True, existing datasets are updated; if False, new ones created

ckanext.ddi.override_datasets = False

DDI configuration file (YAML) structure:

sections: identification: Identification overview: Overview contact: Contact information

vocabularies: kind_of_data: - Sample survey data [ssd] - Census/enumeration data [cen] - Administrative records data [adm]

fields: identification: title: type: text visible: False display: Title url: type: url display_field: title visible: True display: Source overview: abstract: type: markdown visible: True display: Abstract

Command line import:

paster –plugin=ckanext-ddi ddi import [] -c

NADA harvester configuration (JSON):

{ “user”: “harvest”, “access_type”: “public_use”, “license”: “CC-BY-SA-4.0” }

Access types: “” (all), “direct_access”, “public_use” (default), “licensed”, “data_enclave”, “data_external”, “no_data_available”, “open_data”

Requires ckanext-harvest for NADA harvester functionality.

Plugins to configure (ckan.ini)
ddi_schema ddi_theme nada_harvester ddi_import
CKAN Settings (ckan.ini)
(not set)
DB migration to be executed
(not set)
<< back to Extensions