Skip to content

TNRIS/ckanext-datasetapproval

 
 

Repository files navigation

CKAN

ckanext-datasetapproval

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

Installation

To install ckanext-datasetapproval:

Note: if you're using ckanext_scheming extension, add 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, for example:

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

  2. Clone the source and install it on the virtualenv

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

  3. 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).

  4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:

    sudo service apache2 reload

Approval Flow for Dataset

  1. All publisher users can save datasets as drafts for later editing, while creating/updating datasets without publishing it to the public.

Screenshot 2022-11-23 at 8 43 38 AM

  1. Users with editor role in organization can create a dataset and submit it for approval Editors user get this message

Screenshot 2022-11-23 at 9 02 22 AM

Submit for approval by clicking finish button. Screenshot 2022-11-23 at 9 02 32 AM

  1. Organization admin receives the email notification when dataset is submitted for approval. Example:

Screenshot 2022-11-23 at 9 04 30 AM

4. Users with admin role in organization can reivew with approving or rejecting the dataset.

Screenshot 2022-11-23 at 9 06 14 AM

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

Screenshot 2022-11-23 at 9 08 13 AM

6. If dataset is rejected, it will be visible to only editor and syasadmin users.

Screenshot 2022-11-23 at 9 06 56 AM

5. If dataset is rejected, editor can edit the dataset and submit it for approval again.

License

AGPL

About

Dataset review workflow implementation for CKAN.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 56.5%
  • HTML 35.4%
  • JavaScript 7.9%
  • CSS 0.2%