Extension Harmonisation


Extension Basics


Background Infos

Description (long)
Show details

ckanext-harmonisation

A tool for harmonising metadata labels and values.

Tested with CKAN v2.2 (http://docs.ckan.org/en/ckan-2.2/).

General

The ckanext-harmonisation plugin harmonises metadata labels and values that comply with the ODM metadata scheme. The plugin uses the mongo DB as metadata repository and developed as part of the ODM project (www.opendatamonitor.eu). In order to use it, the collected metadata, raw and harmonised, need to be stored in collections with names as odm and odm_harmonised respectively.

Implementation

The extension gives the ability to an end user to harmonise specific metadata fields (Dates,Resources,Licenses,Categories) via a web form. It also provides the ability to add new mappings or update existing ones.

Building

In order to use this extension you need to have MongoDB installed.

To build and use this plugin, simply:

git clone https://github.com/opendatamonitor/ckanext-harmonisation.git
cd ckanext-harmonisation
pip install -r requirements.txt
python setup.py develop

Then you will need to update your CKAN configuration to include the new harvester. This will mean adding the ckanext-genericapiharvest plugin as a plugin. E.g.

ckan.plugins = harmonisation

Also you need to add the odm_extension settings to the development.ini file in your ckan folder.

[ckan:odm_extensions]
mongoclient=localhost
mongoport=27017
log_path=/var/local/ckan/default/pyenv/src/

Using

After setting this up, you should be able to go to: http://localhost:5000/harmonisation

In order to execute the scheduled harmonisation jobs you need to execute the harmonisation_slave.py. This script can be found in the ckanext-harmonisation plugin under controllers folder. For instance, if you have installed the CKAN under the /var/local/ckan/default/pyenv virtualenv folder, you can add the following cron job to run it automatically:

30 *
Version
Version release date
(not set)
Contact name
OpenDataMonitor
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints
Plugins to configure (ckan.ini)
harmonisation Also you need to add the odm_extension settings to the development
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions