Skip to content

amruthkiran94/ODK-Documentation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 

Repository files navigation

Note: Updated docs coming up..

INTRODUCTION

ODK or the Open Data Kit is an Open source suite of tools to build, collect and manage data, especially in resource constrained environments. Built by a team of developers across the world, major organisations from the likes of Google, WHO and Red Cross use the ODK for collecting data using a variety of tools built and optimised for mobile and web-based applications. Tools such as, ODK Collect for the mobile based data collection both in online and offline environments. ODK Aggregate, the remote server for the central database and management of forms and ODK Briefcase, the desktop application for handling everything in between.

USECASES

ODK, being open sourced and completely free allows a wide range of applications to be built for specific use-cases around the world. A few of them are listed below:

Field Data collection

  • Hungry Cities Project - Indian Institute for Human Settlements, Bangalore.
  • Ebola Aid in Africa - Measure effectiveness of relief efforts.
  • Forest Monitoring in Indonesia.

Data Management

  • ODK Aggregate to push, pull and export forms.
  • ODK-QGIS integration for spatial data support.
  • ODK for researchers by London School of Hygiene and Tropical Medicine.

Creating Survey Forms for ODK

There are two methods to creating the survey forms:

This is the official web-based tool developed to quickly create simple forms using drag-drop features on a web browser. Although it is quite easy to create and upload forms onto servers, it is only viable for simple or short surveys. More complicated surveys with many questions and interconnected logic might be quite hard to replicate on a web-based tool. This is recommended for simple surveys or for testing.

Using XLSForm (Excel based)

Excel (Offline) based form building offers more flexibility and customisation as compared to its web-based counterpart. The Excel (.XLSX) worksheet created will have the following information on different sheets:

  1. Survey
  2. Choices
  3. Settings

The "Survey" sheet will house the questions from the questionnaire provided to us. As well as some technical requisites such as the "Data Type", "Name", "Label" and more. Please refer to our example worksheet and the documentation on "ODK Questions Types" and "XLS Forms" for further details on the same.

XLSForm is a form standard created to help simplify the authoring of forms in Excel. Authoring is done in a human readable format using a familiar tool that almost everyone knows - Excel. XLSForms provide a practical standard for sharing and collaborating on authoring forms. They are simple to get started with but allow for the authoring of complex forms by someone familiar with the syntax described here.

The "Choices" sheet will contain a variable and its corresponding question from the Survey sheet to the many options that question might have (as prepared in the questionnaire). These options will be reflected on the ODK Collect App along with the Questions.

"Settings" would contain the "form title", "ID", "Version" and a "Submission URL". These have to be setup prior to conversion (to XLS) and each variable would be unique to the survey question version being edited and have to be updated with new versions that come later. The "Submission URL" would point to the Google Drive account where these forms would be submitted as results in Excel sheets. Here we use account # 2 (gsl@iihs.ac.in) which is only accessible by IIHS.

Convert Survey Form to XLS format

Once the questions, options and settings are filled in, the Excel worksheet needs to be converted into ODK ready format. The format is XLS. The Excel can be converted to XLS on this link. This converted form now can be uploaded onto the Google Drive account setup with the following credentials:

Username : iihs.ncdhr@gmail.com

Password : test123iihs

The same credentials will be updated into the ODK collect app so that the forms can be access by the surveyors.

Platform to Manage Survey Forms

The account iihs.ncdhr@gmail.com is used to store the converted XLS forms, which can be accessed by the ODK Collect App. This account will also store the media files (Images and Videos) from each surveyor's submission in a folder called "Open Data Kit" with folders ordered by survey version edits. Create a folder for each new project and upload the XLS form into this folder.

Setting Up ODK Collect App

The ODK collect is an Android based application to collect field based survey data from forms created via Excel(XLS). This renders the form into a sequence of human readable format with logic, constraints and repetitive sub-structures. Each user would be provided with the same questions as entered in the XLS form in a clean user-interface which can also work in offline mode (once the form has been downloaded).

The app has the following tabs/buttons:

  • Fill Blank Form

To start survey with newly downloaded blank form

  • Edit Saved Form

Edit previously completed form

  • Send Finalized Form

Send Competed form to Server

  • View Sent Form

View all sent forms from this device

  • Get Blank Form

Download new/blank form from server

  • Delete Saved Form

Delete existing instances of the form from device (blank and completed)

1

ODK Collect Main Menu

The sections under ODK Aggregate and Google Drive/Sheets in Settings would need to be updated based on the type of server installed. More information can be accessed here.

If the server is based on Google Drive:

3

If the Server is based on AWS-Aggregate:

4

How to Submit a form?

Once the server has been linked on the ODK application, the following methodology can be used to download a blank form and start the survey.

5

Internet connectivity is required to download the blank form and to submit the completed form from and to the server. While it is not necessary to have internet connectivity while running the survey, some questions such as obtaining location information might not work without it.

Platform to Manage Submitted Forms

Currently two platforms have been tested to host submitted data for its storage and management. Google Drive/Sheets and ODK Aggregate.

Google Drive

6

Google Drive form Management

If the setup to pull and push via Google Drive is used then the Submitted forms or results are stored in the gsl@iihs.ac.in (Google Drive). Prior to this, Create a folder with an empty Google Sheet preferable named with the version of the form created. "Share" the sheet by creating a link that anyone can view and edit from the "Share" button on the top-right of the page.

The "Submission URL" in the created survey form (3rd tab/sheet) needs to be updated with the link to this empty sheet.

ODK Aggregate on AWS

7

AWS-Aggregate Management

ODK Aggregate is a server-side implementation/tool to manage forms and submissions. The server can be setup on multiple platforms like Amazon Web Services (AWS), Google Cloud, Apache-Tomcat and others.

AWS based ODK Aggregate was tested and the steps to install the server on an AWS instance can be followed here.

Analysis

Once the surveys are completed and consistent backups are created, the Excel sheet based analysis can be carried out with the "result" sheet in the account gsl@iihs.ac.in.

Pivot Tables

The first tab in the "result" excel sheet is the user-wise submission. This would be our main datasheet. Using this sheet and the corresponding answers to the questions, simple pivot tables and charts would be created to visualise the outcome of the surveys.

Create a new excel sheet and copy the complete datasheet from the "result" excel file. Create as many new tabs required in this new worksheet, this depends on the number of questions. See sample file for more information.

Pivot table are easy to create and enables to quickly compare multiple elements in an excel datasheet. Visit here to learn more.

Charts

Once Pivot tables are created, corresponding charts or pivot charts can be simultaneously created for each question. Visit here to learn more.

Macros

Analysing over 50 questions can be quite a manual task. Using VisualBasic Macros built for Microsoft Excel, we can automate large workflows with simple set of code modules.

First, Enable Developer mode in Excel by following the steps below:

    • On the File tab, go to Options > Customize Ribbon.
    • Under Customize the Ribbon and under Main Tabs, select the Developer check box.
    • After you show the tab, the Developer tab stays visible, unless you clear the check box or have to reinstall a Microsoft Office program.

Secondly, open the VB editor (Alt+F11) and select worksheet and insert module. Write or paste the VB code into the module, save and run as per module requirement.

Here are some links to macros and its supporting resources:

Example Macro to create Pivot Chart

Sub createPivotChart1a()

Dim PvtTbl As PivotTable
Dim rngChart As Range
Dim objChart As Chart
Set PvtTbl = Worksheets("Sheet14").PivotTables("PivotTable1")

'use the Charts.Add Method to add a new chart sheet in the workbook, which is represented as a Chart object

'adds new chart sheet before or after specified sheet:
ActiveWorkbook.Charts.Add Before:=Worksheets("Sheet14"), Count:=1

'Alternate 1: to add new chart sheet before the active sheet, use below code line:
'Set objChart = Charts.Add
'Alternate 2: to add new chart sheet after the last worksheet, use below code line:
'ActiveWorkbook.Charts.Add After:=Worksheets(Worksheets.Count)

'set as active worksheet:
Set objChart = ActiveSheet

'set range for the PivotChart, based on the existing PivotTable:
Set rngChart = PvtTbl.TableRange2

'specify the source data for the PivotChart, name of chart sheet and the chart type:
With objChart
.SetSourceData rngChart
.Name = "PivotChart1"
.ChartType = xlColumnClustered
End With

End Sub

Appendix-A

Do's and Don'ts before/while you start creating forms

  • Options such as
    • Others
    • Did not answer
    • Don't know/Can't say
    • Not Applicable, should be included for all relevant questions
  • Add "[DO NOT READ ALOUD]" for questions/options that need not be asked.
  • Make sure to include all possible options. For example: if the options are 1 day, 2 days and more than 3 days, then where would 3 days be recorded?
  • "Specify Other" column is asked only if the responded has chosen "other" in the previous question. Do not ask questions for which they have answered "No" already.
  • Save the Excel file as a new file using "_V[number]" for every major edit (_V1, V2 ...)
  • Make sure to change the form_title, form_id and version in the settings tab of the Excel sheet for every new version/edit.

Do's and Don'ts for settings up ODK collect

1.Check the following: 1. Downloading Blank form successfully from server (Google or Aggregate) 2. Flow of the questions (If questions are being missed or repeated) 3. The logic of nested questions 4. Test the submission URL by conducting a sample survey with the created form and try sending the form. This confirms that the submission URL is working.

Caution: In questions requiring multiple options, if the respondent's response involves more than 3 responses, the Google Sheet registers the answer as a Date. (i.e. if 1,2 and 3 options are registered as 01-02-2003). To Avoid this, conduct a sample survey and submit the results with these multiple options. The column names are auto populated, identify the columns with these specific multiple options questions and change the data type as follows:

"Format" -> "Number" -> "Plain Text"

                 This ensures the responses are saved as numbers (i.e. 1,2,3)

Do's and Don'ts while survey is being conducted

  • Take regular backups of the submitted forms
  • In cases of forms being updated (additional questions, options etc…)
    1. Make a new version of the survey form with corresponding naming conventions and ensure the surveyors do not delete the older versions from their ODK Collect application. This is so that, older submissions can still be carried out (deletion of blank forms prohibits the submission of the said form).
    2. New surveys should also be submitted to a new Google Sheets file. Repeat the instructions to setup the "Result" Sheet as described in the sections above (with changes to the settings tab also).

Resources:

About

Updated Documentation on ODK and its tools

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published