Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
96 lines (55 sloc) 3.18 KB

Getting Started With ODK

This document walks you through a very basic setup process, to get you familiar with using Open Data Kit.

You will:

Install Collect

The easiest way to install the Collect app is to get it from the Google Play store.

.. seealso:: :doc:`collect-install`

Install Aggregate (optional)

The easiest way to set up Aggregate is to :doc:`install it on Google App engine <aggregate-app-engine>`.

You'll set up a new Google Cloud project, and then run the installer locally. This will connect to your Google Cloud account and install Aggregate there.

Alternatively, if you only want to try things out, you can use the Aggregate sandbox server.

Warning

The Aggregate sandbox server is for demo purposes only. All forms and data on this server are public and are deleted every 24 hours without notice.

.. seealso:: :doc:`aggregate-install`

Create a form with Build and upload it to Aggregate

The quickest and easiest way to start using your own survey forms is to create one online with ODK Build.

  1. Go to build.opendatakit.org, create a new account, and log in. Once logged in, a blank survey is created.

  2. Give your form a name (:guilabel:`rename` in the upper left-hand corner).

  3. Add a few questions (click on question types in the :guilabel:`+Add New` bar along the bottom).

  4. Once your new form is complete, go to :menuselection:`File --> Upload form to Aggregate...` to upload your form.

    If you have your own Aggregate server, use the URI and credentials you created during setup.

    To use the sandbox, the :guilabel:`Aggregate Instance URI` is https://sandbox.aggregate.opendatakit.org. You should not need additional credentials.

.. seealso::

  `Build desktop app <https://github.com/opendatakit/build/releases/latest>`_
    To use Build locally.

  :doc:`xlsform`
    A more robust form creation tool.


Load a form into Collect from Aggregate

  1. Open Collect on your Android device.

  2. Open server settings (:menuselection:`⋮ --> General Settings --> Server`).

  3. Edit the server settings to connect to your Aggregate server or the sandbox server.

    The URI for the sandbox server is https://sandbox.aggregate.opendatakit.org.

  4. Go back to the app home screen and select :guilabel:`Get Blank Form`, then select your form.

Fill out a form and upload it to Aggregate

  1. Select :guilabel:`Fill Blank Form` to complete a survey.
  2. Select :guilabel:`Send Finalized Form` to upload your completed survey to Aggregate.

Now log back into Aggregate and see your completed survey results.