Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Line edits docs #294

Merged
merged 5 commits into from
Oct 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions briefcase-forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ Pulling forms from ODK Aggregate

- Open *ODK Briefcase*.
- In the window which opens up select :guilabel:`pull` tab.
- Select Aggregate 0.9.x or Aggregate 1.0 in the :guilabel:`pull data from` drop-down.
- Select Aggregate 0.9.x or Aggregate 1.0 in the :guilabel:`pull data from` the drop-down.
- Enter the url of your ODK Aggregate server in :guilabel:`url` option. For instance `https://proj1.appspot.com` and click on connect.
- You can either leave the username blank if the anonymousUser is granted Data Viewer permissions, or specify an ODK Aggregate user (Account Type 'ODK') that has been granted Data Viewer permissions.
- A list of forms will be displayed. Select the ones you want to pull and click on :guilabel:`pull` button at the bottom of window. The forms will be pulled to ODK Briefcase Storage on your local system.
- You can either leave the username blank if the anonymousUser is granted Data Viewer permissions or specify an ODK Aggregate user (Account Type 'ODK') that has been granted Data Viewer permissions.
- A list of forms will be displayed. Select the ones you want to pull and click on :guilabel:`pull` button at the bottom of the window. The forms will be pulled to ODK Briefcase Storage on your local system.

.. warning::

Expand All @@ -34,16 +34,16 @@ Pushing forms to ODK Aggregate
- In the window which opens up select :guilabel:`push` tab.
- Select Aggregate 1.0 in the :guilabel:`push data to` drop-down.
- Enter the url of your ODK Aggregate server in :guilabel:`url` option. For instance `https://proj1.appspot.com` and click on connect.
- You can either leave the username blank if the anonymousUser is granted Data Viewer permissions, or specify an ODK Aggregate user (Account Type 'ODK') that has been granted Data Viewer permissions.
- A list of forms will be displayed. Select the ones you want to push and click on :guilabel:`push` button at the bottom of window. The forms will be pushed to ODK Aggregate Server.
- You can either leave the username blank if the anonymousUser is granted Data Viewer permissions or specify an ODK Aggregate user (Account Type 'ODK') that has been granted Data Viewer permissions.
- A list of forms will be displayed. Select the ones you want to push and click on :guilabel:`push` button at the bottom of the window. The forms will be pushed to ODK Aggregate Server.


.. warning::

- ODK Briefcase will abort a push attempt if the form definition already on the ODK Aggregate server differs in any way from the form definition in the ODK Briefcase Storage area.
- ODK Briefcase does not work with Google accounts (Account Type 'Google').


.. tip::

- If the form definition has changed but the changes do not affect the data model, you can make a copy of the storage area, replace the copy's form definition file with that from the server, and then push the data up from this storage area copy.
Expand All @@ -70,7 +70,7 @@ Pulling from Android 2.x and earlier device
- In the window which opens up select :guilabel:`pull` tab.
- Select `Mounted Android SD Card` in the :guilabel:`pull data from` drop-down.
- Click :guilabel:`Choose` and select the appropriate mounted SD card.
- A list of forms will be displayed. Select the ones you want to pull and click on :guilabel:`pull` button at the bottom of window. The forms will be pulled to ODK Briefcase Storage on your local system.
- A list of forms will be displayed. Select the ones you want to pull and click on :guilabel:`pull` button at the bottom of the window. The forms will be pulled to ODK Briefcase Storage on your local system.
- On the Android device, open ODK Collect and delete the filled-in forms.

.. warning::
Expand All @@ -95,17 +95,17 @@ Pulling from Android 4.x and later device


.. tip::
- You can use the *Custom path to ODK Directory* any time you want to pull forms from custom loaction.
- You can use the *Custom path to ODK Directory* any time you want to pull forms from custom location.
- You can confirm that the forms have been successfully pulled into ODK Briefcase by confirming a successful pull status or by verifying the data appearing in a CSV export file.

.. warning::
- ODK Briefcase does not work with the USB-mounted Media device (MTP) protocol, which replaced the USB-mounted drive protocol on Android 4.x devices.
- ODK Briefcase does not support pushing blank forms to ODK Collect. You can manually install the forms on your ODK Collect device.
- ODK Briefcase does not support pushing blank forms to ODK Collect. You can manually install the forms on your ODK Collect device.


.. _export-forms:

Export forms to CSV
Export forms to CSV
---------------------

- Open *ODK Briefcase*.
Expand Down Expand Up @@ -152,8 +152,3 @@ To get help about the command line operation type `java -jar path_to_jar -help`.
.. code-block:: console

$ java -jar "/home/pc123/Desktop/ODK Briefcase v1.8.0 Production.jar" -help





6 changes: 3 additions & 3 deletions briefcase-vs-aggregate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Briefcase
Aggregate
------------

- Aggregate provides ready-to-deploy server to provide blank forms to ODK Collect.
- Aggregate provides a ready-to-deploy server to provide blank forms to ODK Collect.
- It accepts finalized forms from ODK Collect and manages and visualizes the collected data.
- Export data as CSV file, KML file, JSON file (e.g., as CSV files for spreadsheets, or as KML files for Google Earth).
- It can be used to publish data to external systems.
Expand All @@ -35,7 +35,7 @@ Aggregate
ODK Briefcase as a replacement for ODK Aggregate
--------------------------------------------------

ODK Briefcase can pull data directly off ODK Collect devices, but does not support pushing blank forms to ODK Collect. To use ODK Briefcase as a replacement for ODK Aggregate, you must manually install the forms on your ODK Collect device.
ODK Briefcase can pull data directly off ODK Collect devices but does not support pushing blank forms to ODK Collect. To use ODK Briefcase as a replacement for ODK Aggregate, you must manually install the forms on your ODK Collect device.

To manually install forms onto your ODK Collect device:

Expand All @@ -45,6 +45,6 @@ To manually install forms onto your ODK Collect device:
- Run ODK Collect
- Choose "Fill Blank Form".

ODK Collect will scan the directory for new forms, parse them, and make them available in this list. It can take several moments for large forms to appear. When ODK Collect has completed scanning for new forms, it will display "Finished scanning". All forms are loaded in the second line at the top of this screen.
ODK Collect will scan the directory for new forms, parse them, and make them available in this list. It can take several moments for large forms to appear. When ODK Collect has completed scanning for new forms, it will display "Finished scanning". All forms are loaded on the second line at the top of this screen.

The steps for pulling data directly into ODK Briefcase from your Android device differs between the :ref:`Android 2.x <pull-from-android2.x>` and :ref:`Android 4.x <pull-from-android4.x>` devices.
Loading