ODK Briefcase

ODK Briefcase is a desktop application that can locally store survey results gathered with ODK Collect. It can also be used to make local copies and CSV exports of data from ODK Aggregate (or compatible servers) and push data to those servers.

ODK Briefcase is part of Open Data Kit (ODK), a free and open-source set of tools which help organizations author, field, and manage mobile data collection solutions. Learn more about the Open Data Kit project and its history here and read about example ODK deployments here.

• ODK website: https://opendatakit.org
• ODK Briefcase usage instructions: https://opendatakit.org/use/briefcase
• ODK community mailing list: http://groups.google.com/group/opendatakit
• ODK developer mailing list: http://groups.google.com/group/opendatakit-developers
• ODK developer Slack chat: http://slack.opendatakit.org
• ODK developer Slack archive: http://opendatakit.slackarchive.io
• ODK developer wiki: https://github.com/opendatakit/opendatakit/wiki

Setting up your development environment

1. Fork the briefcase project (why and how to fork)

2. Clone your fork of the project locally. At the command line:

    git clone https://github.com/YOUR-GITHUB-USERNAME/briefcase
   

We recommend using IntelliJ IDEA for development. On the welcome screen, click "Import Project" and navigate to your briefcase folder. Select Create project from existing sources and select defaults through the wizard. Once the project is imported, right-click on the res folder, click on Mark Directory as, then select Resources Root.

The main class is org.opendatakit.briefcase.ui.MainBriefcaseWindow. This repository also contains code for three smaller utilities with the following main classes:

• org.opendatakit.briefcase.ui.CharsetConverterDialog converts CSVs to UTF-8
• org.opendatakit.briefcase.ui.MainClearBriefcasePreferencesWindow clears Briefcase preferences
• org.opendatakit.briefcase.ui.MainFormUploaderWindow uploads blank forms to Aggregate instances

Contributing code

Any and all contributions to the project are welcome. ODK Briefcase is used across the world primarily by organizations with a social purpose so you can have real impact!

If you're ready to contribute code, see the contribution guide.

Downloading builds

Current and previous production builds can be found on the ODK website.