Extension Dataset Approval Workflow


Extension Basics

Title
Dataset Approval Workflow
Name
ckanext-datasetapproval
Type
Public extension
Description
CKAN extension providing a dataset approval/rejection workflow before making datasets public, with email notifications to organization admins.
CKAN versions
Download-Url (zip)
Last commit
3 years ago (2023-03-03 06:10:26)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

ckanext-datasetapproval

An extension which provides a feature to approve or reject a dataset before making it public.

This extension implements a complete dataset review workflow for CKAN.

Approval Flow for Dataset

  1. Draft Mode: All publisher users can save datasets as drafts for later editing while creating/updating datasets without publishing them to the public.

  2. Submit for Approval: Users with editor role in an organization can create a dataset and submit it for approval.

  3. Email Notification: Organization admin receives an email notification when a dataset is submitted for approval.

  4. Review: Users with admin role in an organization can review with approving or rejecting the dataset.

  5. Approved: If a dataset is approved by admin, it will be published and visible to all users.

  6. Rejected: If a dataset is rejected, it will be visible only to editor and sysadmin users. The editor can edit the dataset and submit it for approval again.

Installation

Note: If you’re using ckanext_scheming extension, add a new field to the schema configuration YAML file:

- field_name: publishing_status
  label: Publishing Status
  form_snippet: null
  display_snippet: null
  validators: ignore_missing publishing_status_validator
  1. Activate your CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
  1. Clone the source and install it on the virtualenv:
git clone https://github.com/datopian/ckanext-datasetapproval.git
cd ckanext-datasetapproval
pip install -e .
pip install -r requirements.txt
  1. Add dataset_approval to the ckan.plugins setting in your CKAN config file (by default the config file is located at /etc/ckan/default/ckan.ini).

  2. Restart CKAN:

sudo service apache2 reload

License

AGPL

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


Installation Guide

Configuration hints

Works with ckanext-scheming. Requires email configuration for notifications.

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