Extension User Tracking


Extension Basics

Title
User Tracking
Name
ckanext-usertracking
Type
Public extension
Description
Adds an Activity tracking tab in the CKAN admin page to show user engagement and activity data with CSV export capability.
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-08-11 15:56:58)
Url to repo
Category
Visualization & Analytics


Background Infos

Description (long)
Show details

ckanext-usertracking

The user tracking plugin adds an Activity tracking tab in the CKAN admin page to show engagement/activity data.

The plugin serves as an MVC for displaying 3 tables which inform of the user, organisational and individual-page engagement.

This necessitates the creation of the table user_activity_tracker which is populated via JS embedded in all CKAN pages which send POST request to the usertracking middleware.

The plugin also provides a CLI command to export the last x days of user_activity_tracker into a CSV.

Requirements

Compatibility with core CKAN versions:

CKAN version Compatible?
2.6 and earlier not tested
2.7 not tested
2.8 not tested
2.9 yes

Installation

To install ckanext-usertracking:

  1. Activate your CKAN virtual environment, for example:

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

  1. Clone the source and install it on the virtualenv:

git clone https://gitlab.stfc.ac.uk/smdh/AEP/ckanext-usertracking cd ckanext-usertracking pip install -e . pip install -r requirements.txt

  1. Add usertracking to the ckan.plugins setting in your CKAN config file.

  2. Restart CKAN.

Config settings

None at present.

Developer installation

To install ckanext-usertracking for development, activate your CKAN virtualenv and do:

git clone https://github.com/.../ckanext-usertracking.git
cd ckanext-usertracking
python setup.py develop
pip install -r dev-requirements.txt

ckan -c /etc/ckan/default/ckan.ini usertracking export usertracking.csv

Tests

To run the tests, do:

pytest --ckan-ini=test.ini

License

AGPL

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


Installation Guide

Configuration hints

Creates table user_activity_tracker. CLI command available: ckan -c /etc/ckan/default/ckan.ini usertracking export usertracking.csv

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