Extension DataVic Reporting


Extension Basics

Title
DataVic Reporting
Name
ckanext-datavic-reporting
Type
Public extension
Description
Custom reporting extension for Data.Vic
CKAN versions
Download-Url (zip)
Download-Url commit date
2021-10-27
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

Custom CKAN reporting extension for Data.Vic that provides scheduled report generation and management. Creates CSV reports for organizations with configurable frequencies (monthly/yearly). Reports include dataset statistics and can be sent to specified email addresses based on user roles.

Version
0.0.1
Version release date
2021-10-27
Contact name
Salsa Digital
Contakt email
Contact Url
(not set)


Installation Guide

Configuration hints

Database setup:

. /app/ckan/default/bin/activate

ckan datavic_reporting initdb –config=/app/ckan/default/production.ini

Creates two tables: report_schedule (config) and report (instances)

Configuration:

Configure scheduled report frequencies on /ckan-admin/config page

Comma-separated list of frequencies

ckan.datavic_reporting.scheduled_reports_path = /app/filestore/reports

Create scheduled report job:

. /app/ckan/default/bin/activate

ckan datavic_reporting createjob {frequency} –config=/app/ckan/default/production.ini

Replace {frequency} with ‘monthly’ or ‘yearly’

Reports saved to: {path}/org_id/{yyyy}/{mm}/general_report_{timestamp}.csv

API Endpoints:

POST /api/action/report_schedule_create - params: report_type, org_id, sub_org_ids, frequency, user_roles, emails

POST /api/action/report_schedule_update - params: id + create params

GET /api/action/report_schedule_delete - params: id

GET /api/action/report_schedule_list - params: state (active|deleted)

GET /api/action/reports_list - params: id (report_schedule.id)

Plugins to configure (ckan.ini)
datavic_reporting
CKAN Settings (ckan.ini)
# ckan.datavic_reporting.scheduled_reports_path = /app/filestore/reports
DB migration to be executed
datavic-reporting
<< back to Extensions