Extension Harvestnotification


Extension Basics

Title
Harvestnotification
Name
ckanext-harvestnotification
Type
Public extension
Description
The **Harvest Notification** extension for CKAN enhances the core CKAN harvest functionality by ena
CKAN versions
Download-Url (zip)
Last commit
a year ago (2024-03-27 21:40:52)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Tests

ckanext-harvestnotification

This extension provides a plugin that adds configuration to specify the recipients of harvester email notifications. Configuration for harvester email notifications from ckanext-harvest must be set to use this feature. Users must also have email notifications enabled in their user settings.

Requirements

This extension requires ckanext-harvest (https://github.com/ckan/ckanext-harvest) to be installed along with any of the following configuration options.

If you want to send an email when a Harvest Job fails, you can set the following configuration option in the ini file:

ckan.harvest.status_mail.errored = True

If you want to send an email when completed Harvest Jobs finish (whether or not it failed), you can set the following configuration option in the ini file:

ckan.harvest.status_mail.all = True

Compatibility with core CKAN versions:

CKAN version Compatible?
2.7 yes
2.8 not tested
2.9 not tested

Installation

To install ckanext-harvestnotification:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Install ckanext-harvest (https://github.com/ckan/ckanext-harvest#installation)

  3. Clone the source and install it on the virtualenv

    git clone https://github.com/OpenGov/ckanext-harvestnotification.git cd ckanext-harvestnotification pip install -e . pip install -r requirements.txt

  4. Add harvest_notification to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  5. Restart CKAN. For example if you’ve deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Config sett

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


Installation Guide

Configuration hints

To install ckanext-harvestnotification:

  1. Activate your CKAN virtual environment, for example:

    . /usr/lib/ckan/default/bin/activate

  2. Install ckanext-harvest (https://github.com/ckan/ckanext-harvest#installation)

  3. Clone the source and install it on the virtualenv

    git clone https://github.com/OpenGov/ckanext-harvestnotification.git cd ckanext-harvestnotification pip install -e . pip install -r requirements.txt

  4. Add harvest_notification to the ckan.plugins setting

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