Extension OpenBis OAI-PMH Harvester


Extension Basics

Title
OpenBis OAI-PMH Harvester
Name
ckanext-openbis
Type
Public extension
Description
CKAN harvester for openBis research data platform using the OAI-PMH interface
CKAN versions
Download-Url (zip)
Last commit
10 years ago (2015-04-03 00:00:00)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

CKAN Harvester for openBis (OAI-PMH)

This harvester uses the OAI-PMH interface of openBis to harvest metadata. openBis is a platform for managing research data developed by ETH Zurich (CISD).

Features

  • Harvests metadata from openBis instances via OAI-PMH protocol
  • Supports authentication with username/password
  • Allows harvesting specific sets
  • License mapping support
  • Resource creation based on source field
  • Tag handling for openBis specifics

Dependencies

  • ckanext-oaipmh
  • ckanext-harvest

Installation

Use pip to install this plugin:

source /home/www-data/pyenv/bin/activate
pip install -e git+https://github.com/openresearchdata/ckanext-openbis.git#egg=ckanext-openbis --src /vagrant
cd /vagrant/ckanext-openbis
pip install -r requirements.txt
python setup.py develop

Make sure the ckanext-oaipmh and ckanext-harvest extension are installed as well.

Setup the Harvester

  1. Add openbis_harvester to ckan.plugins in development.ini (or production.ini)
  2. Restart your webserver
  3. With the web browser go to <your ckan url>/harvest/new
  4. As URL fill in the base URL of an OAI-PMH conforming openBis instance
  5. Select Source type openBis
  6. If your OAI-PMH needs credentials, add the following to the “Configuration” section: {"username": "foo", "password": "bar"}
  7. If you only want to harvest a specific set, add the following to the “Configuration” section: {"set": "baz"}
  8. Save
  9. On the harvest admin click Reharvest

Run the Harvester

On the command line:

  1. Activate the python environment
  2. cd to the ckan directory
  3. Start the consumers (NOTE: only run 1 gather and 1 fetch consumer per server):
paster --plugin=ckanext-openbis harvester gather_consumer &
paster --plugin=ckanext-openbis harvester fetch_consumer &
  1. Run the job:
paster --plugin=ckanext-openbis harvester run

The harvester should now start and import the OAI-PMH metadata.

Version
Version release date
(not set)
Contact name
openresearchdata
Contakt email
(not set)
Contact Url


Installation Guide

Configuration hints

Erfordert ckanext-oaipmh und ckanext-harvest. Authentifizierung via Configuration: {“username”: “foo”, “password”: “bar”}. Set-Filterung via Configuration: {“set”: “baz”}.

Plugins to configure (ckan.ini)
openbis_harvester
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions