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
Draft Mode: All publisher users can save datasets as drafts for later editing while creating/updating datasets without publishing them to the public.
Submit for Approval: Users with editor role in an organization can create a dataset and submit it for approval.
Email Notification: Organization admin receives an email notification when a dataset is submitted for approval.
Review: Users with admin role in an organization can review with approving or rejecting the dataset.
Approved: If a dataset is approved by admin, it will be published and visible to all users.
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
- Activate your CKAN virtual environment:
. /usr/lib/ckan/default/bin/activate
- 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
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).
Restart CKAN:
sudo service apache2 reload
License
AGPL