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.

You'll need an ActivityInfo account to use this extension.

pip install git+https://github.com/okfn/ckanext-activityinfo@0.1.0#egg=ckanext-activityinfo

Also, add activityinfo to the ckan.plugins setting in your CKAN config file.

This extension adds the following resource extra fields to CKAN resources:

• activityinfo_form_id: the ActivityInfo form ID
• activityinfo_database_id: the ActivityInfo database ID
• activityinfo_status: the download status (e.g. 'pending', 'in_progress', 'complete', 'error')
• activityinfo_progress: the download progress (0-100)
• activityinfo_error: any error message if the download failed
• activityinfo_format: the format of the downloaded data (e.g. 'csv', 'xls')
• activityinfo_form_label: the label of the ActivityInfo form

You'll need to add them to ckan.extra_resource_fields to allow searching resources (action resource_search) by these fields.

ckan.extra_resource_fields = activityinfo_form_id activityinfo_database_id activityinfo_form_label activityinfo_status

You will get error is extra fields are not added to ckan.extra_resource_fields and you try to search resources by these fields. For example:

These 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

AGPL