django-odk 0.3.0

Django Data Collection tool using ODK Collect mobile App

django-odk

Django data collection tool using ODK-collect mobile app.

Prerequisite

• Django web site up and running
• Smartphone or tablet with ODK-Collect installed
• Set of forms in Xforms format available in xml. Use https://getodk.org/xlsform/ to validate and export your forms in xml format.
• Database up & running with vector geodatabase functionality (if your ODK form use geopoint): PostGIS, Oracle Spatial, SQLite/SpatiaLite

Installation

• Run

$ pip install django-odk
$ python manage.py migrate
$ python manage.py createsuperuser

• Add odk and odkdata to your INSTALLED_APPS settings

INSTALLED_APPS = (
    ...
    'odk',
    'odkdata',
)

• Add LOCALE_PATHS and appropriate language_code in settings

LOCALE_PATHS = [os.path.join(BASE_DIR, 'odk', 'locale')]

LANGUAGE_CODE = 'en'
# LANGUAGE_CODE = 'fr'
# possible LANGUAGE_CODE on 05/10/2021 are: en, fr

• Add appropriate AUTH_USER_MODEL in settings.py

AUTH_USER_MODEL = 'auth.user'

• For a more interactive app, configure logging as explained in Lincoln Loop and messages as explained in Django

• Add is_odk_admin property to your AUTH_USER_MODEL (django.contrib.auth.models file or specific accounts.models)

    @property
    def is_odk_admin(self):
        return self.groups.filter(name='odk-admin').exists()

• Add odk.urls to the main urls.py file:

urlpatterns = [
    ...
    path('odk/', include('odk.urls'), name='odk'),
]

• Add menu or buttons to access Available form

# bootstrap5 menu item example
<li><a class="dropdown-item" href="{% url 'odk:xform_list' %}">{% trans "ODK available forms" %}</a></li>

• Add menu or buttons to access Submitted form

# bootstrap5 menu item example
<li><a class="dropdown-item" href="{% url 'odk:xformsubmit_list' %}">{% trans "ODK submitted forms" %}</a></li>

Connect to the Django admin site

• create a group 'odk-admin' with create, read, update access on odk objects
• Associate this group to the appropriate users

XForm Create & Load

Connect to django-odk => Available form => Add and follow 4 steps:

1. Build an XLSForm file with 3 tabs 'survey', 'choices', 'settings' Cfr documentation. Do not forget to add 'today' & 'username' fields in Survey tab!

2. Upload xlsx file (XForm) by clicking on 'Choose file' and Save

3. Convert xlsx file to xml XForm compatible file Thanks pyxform!

From this point, you are ready to go with form encoding on your smartphone!

Follow ODK instructions to configure the connexion to the server

Get, fill-in and submit data using ODK Collect

4. If you want to get your data back in a model instead of XML content you can run the CreateModel step. It will create a model to get your submitted data in a model formatted like your xlsx form. Thanks xlsconv! Model creation is done into odkdata app.

Get submitted data on server

Go to Submitted form menu of your server to see submitted data in XML format. Insert in odkdata model available on record edition.

Several record insert is available through admin interface. Select appropriate records (ie: those without insert date) and choose Insert in odkdata model from action dropdown list and click on 'Send' button.

What next?

Create a new app in you project like odkdata2 with templates, views and urls to manage display (with map/export xls/possible update?) of the submitted data through ODK-Collect.

Comments/Improvements welcome!

Investigate WQ Framework but I still don't see how to deploy offline forms on smartphone.