Extension Usertracking


Extension Basics

Title
Usertracking
Name
ckanext-usertracking
Type
Core extension
Description
The **User Tracking** extension for CKAN provides an interface within the CKAN admin panel to monit
CKAN versions
Download-Url (zip)
Last commit
2 years ago (2023-08-11 13:56:58)
Url to repo
Category
Data Management & Quality


Background Infos

Description (long)
Show details

Tests

ckanext-usertracking

TODO: Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video!

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.

User Engagement 1 page

Requirements

If your extension works across different versions you can add the following table:

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

Suggested values:

  • “yes”
  • “not tested” - I can’t think of a reason why it wouldn’t work
  • “not yet” - there is an intention to get it working
  • “no”

Installation

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-usertracking:

  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://gitlab.stfc.ac.uk/smdh/AEP/ckanext-usertracking cd ckanext-usertracking pip install -e . pip install -r requirements.txt

  3. Add usertracking to the ckan.plugins setting in your

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


Installation Guide

Configuration hints

TODO: Add any additional install steps to the list below. For example installing any non-Python dependencies or adding any required config settings.

To install ckanext-usertracking:

  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://gitlab.stfc.ac.uk/smdh/AEP/ckanext-usertracking cd ckanext-usertracking pip install -e . pip install -r requirements.txt

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