Extension Helix


Extension Basics

Title
Helix
Name
ckanext-helix
Type
Public extension
Description
A CKAN extension hosting various plugins for the Helix project, providing validation logic, storage, and UI controls for schema-following metadata like DATACITE.
CKAN versions
Download-Url (zip)
Last commit
7 years ago (2018-11-26 20:35:16)
Url to repo
Category
Standards Compliance


Background Infos

Description (long)
Show details

ckanext-helix

This is a CKAN extension that hosts various plugins needed for the Helix project.

Requirements

This plugin requires an updated solr schema.xml

Install

pip install -r requirements.txt
python setup.py develop
paster helix --config /path/to/development.ini setup

Update CKAN configuration

Edit your CKAN .ini configuration file (e.g. your development.ini) and activate the plugins as usual. For now, the supported plugins are:

  • helix_dataset: Provides validation logic, storage logic and ui controls for schema-following metadata (e.g. DATACITE).
  • helix_package: Provides synchronization of package metadata to other databases (e.g. to the integrated CSW service, through pycsw).

Configure

Here we cover some of the basic configuration settings for ckanext-helix.

The most common settings are:

# Specify which dataset types are enabled
ckanext.helix.dataset_types = datacite

# Add extra top-level (i.e not contained in schema) metadata fields.
ckanext.helix.extra_fields = spatial
ckanext.helix.validation.relax_name_pattern = true

Additional plugins used: - ckanext-basiccharts - ckanext-geoview - ckanext-mapviews - ckanext-viewhelpers - ckanext-harvest - ckanext-spatial - ckanext-scheming

Configuration for ckanext-scheming:

scheming.organization_schemas = ckanext.scheming:helix_organization_schema.json
scheming.group_schemas = ckanext.scheming:helix_group_schema.json

Configuration for ckanext-userautoadd:

ckan.userautoadd.organization_name = helix
ckan.userautoadd.organization_role = member

Configuration for ckanext.spatial:

ckan.spatial.srid = 4326
ckanext.spatial.common_map.type = custom
ckanext.spatial.common_map.custom.url = http://{s}.basemaps.cartocdn.com/light_all/{z}/{x}/{y}.png

Uninstall

paster helix --config /path/to/development.ini cleanup
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

This plugin requires an updated solr schema.xml. Run ‘paster helix –config /path/to/development.ini setup’ after installation.

Plugins to configure (ckan.ini)
helix_dataset helix_package
CKAN Settings (ckan.ini)
# ckanext.helix.dataset_types = datacite
# ckanext.helix.extra_fields = spatial
# ckanext.helix.validation.relax_name_pattern = true
DB migration to be executed
(not set)
<< back to Extensions