ActivityInfo is a Information management software for the social sector.
- Documentation: https://www.activityinfo.org/support/docs/index.html
- API Reference: https://www.activityinfo.org/support/docs/api/index.html
- Source code (old version): https://github.com/bedatadriven/activityinfo
A CKAN extension to connecto to your ActivityInfo account with your CKAN instance.
| CKAN version | Compatible? |
|---|---|
| 2.9 and earlier | not tested |
| 2.10 | yes |
| 2.11 | yes |
You'll need an ActivityInfo account to use this extension.
pip install git+https://github.com/okfn/ckanext-activityinfo@0.1.0#egg=ckanext-activityinfoAlso, add activityinfo to the ckan.plugins setting in your CKAN config file.
ActivityInfo resources can be configured to update automatically (daily or weekly) with a limited number of runs (1 to 20). These settings are available in the resource creation and edit forms.
To enable automatic updates, you need to set up a cron job (or equivalent scheduler) that runs the sync-auto-updates CLI command periodically.
The command checks all resources that are due for an update, enqueues background download jobs using each resource's original creator API key, and exits.
As example. Run the sync command at a frequency that matches your shortest update interval. If you have daily resources, run it at least once a day:
# Run every 6 hours (covers both daily and weekly resources)
0 */6 * * * /usr/bin/ckan -c /etc/ckan/production.ini activityinfo resources sync-auto-updates >> /var/log/ckan/activityinfo-sync.log 2>&1jobs:
- name: activityinfo-sync
command: ckan -c /etc/ckan/production.ini activityinfo resources sync-auto-updates
schedule: "0 */6 * * *"# Preview what would be updated without actually running
ckan activityinfo resources sync-auto-updates --dry-run
# Enable verbose logging
ckan activityinfo resources sync-auto-updates -vThis extension adds the following resource extra fields to CKAN resources:
activityinfo_form_id: the ActivityInfo form IDactivityinfo_database_id: the ActivityInfo database IDactivityinfo_status: the download status (pending,exporting,downloading,complete,error)activityinfo_progress: the download progress (0-100)activityinfo_error: any error message if the download failedactivityinfo_format: the format of the downloaded data (e.g.csv,xlsx)activityinfo_form_label: the label of the ActivityInfo formactivityinfo_auto_update: automatic update frequency (never,daily,weekly)activityinfo_auto_update_runs: how many times automatic updates should run (1-20)activityinfo_last_updated: ISO timestamp of the last automatic updateactivityinfo_auto_update_count: how many automatic updates have been completed so faractivityinfo_user: the CKAN username who created the resource (used for automatic update authentication)
You'll need to add them to ckan.extra_resource_fields in your CKAN config:
ckan.extra_resource_fields = activityinfo_form_id activityinfo_database_id activityinfo_form_label activityinfo_status activityinfo_progress activityinfo_error activityinfo_format activityinfo_auto_update activityinfo_auto_update_runs activityinfo_last_updated activityinfo_auto_update_count activityinfo_userThese are the configuration settings that can be set in your ckan.ini file:
# Define where to save temporary files downloaded from ActivityInfo.
# If not set or "sys_tmp", the system temporary directory will be used.
ckanext.activityinfo.tmp_dir = /path/to/tmp/dir
If you need to implement this extension in a way that it can be enabled/disabled with a feature flag, you can
define the following setting in your ckan.ini file:
# activityinfo_enabled defaults to true, so the extension is enabled by default. You can set it to false to temporarily disable the extension.
ckanext.activityinfo.activityinfo_enabled = false
Disabling the extension will only hide the option to create new ActivityInfo resources in the CKAN UI, but it won't affect existing ActivityInfo resources.
Also, the UI access for users to add or edit their ActivityInfo API key in their user profile will be hidden, but the API key will still be valid and can be used to download data from ActivityInfo for existing resources.
Hiding elements from the UI is just a soft way to disable this extension. This is not a hard disable.
Log in to your ActivityInfo account and generate an API key:
Go to Account settings -> API Tokens -> add.
Then define a label and the access level (Read or Read/Write) and click on "Generate".
You'll need to add this API key to your CKAN user profile.
This extension also provides some CLI commands to list your ActivityInfo databases and forms.
You can run these commands with the ckan CLI tool. For example:
# Get databases list
ckan activityinfo databases list -t <your_api_key> -v
# Get forms list for a specific database
ckan activityinfo forms list -t <your_api_key> -d <database_id> -v --include-sub-forms
