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 edit #465

Merged
merged 8 commits into from
Jan 31, 2018
Merged

Line edit #465

merged 8 commits into from
Jan 31, 2018

Conversation

richa208
Copy link
Contributor

@richa208 richa208 commented Jan 30, 2018

addresses #96

What is included in this PR?

changes are made to :

  • briefcase-api.rst
  • briefcase-forms.rst

- 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` 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 anonymous user is granted Data Viewer permissions or specify an ODK Aggregate user (Account Type 'ODK') that has been granted Data Viewer permissions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The case here is important because it matches the Aggregate UI.


.. warning::

ODK Briefcase will abort a pull attempt if the local copy of the form definition file differs in any way from the copy being pulled from the server or ODK Collect device.

.. tip::

If the form definition has changed but the changes only affect the question text and do not alter the structure of the collected data (or change the formId or version), you can create a new ODK Briefcase Storage area, pull data into that, then manually copy the instances from there into your original storage area.
If the form definition has changed but the changes only affect the question text and do not alter the structure of the collected data (or change the formed or version), you can create a new ODK Briefcase Storage area, pull data into that, then manually copy the instances from there into your original storage area.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be reverted. It's formId as in form identifier.


Pulling form data from Aggregate Server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: console

$ java -jar "ODK Briefcase v1.4.4 Production.jar" --form_id market_prices --storage_directory ~/Desktop --aggregate_url https://my_server.appspot.com --odk_username my_username --odk_password my_password

This command pulls form data with id market_prices from Aggregate server at `https://my_server.appspot.com` and stores data in Briefcase's storage directory on the :file:`~/Desktop`
This command pulls from data with id market_prices from Aggregate server at `https://my_server.appspot.com` and stores data in Briefcase's storage directory on the: file:`~/Desktop`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be reverted.

@@ -21,7 +21,7 @@ The APIs used:

1. OpenRosa Form Discovery API
2. download forms and media files using URLs form discovery.
3. ``view/submissionList`` to obtain a chunk of submission keys.
3. ``view/submissionlist`` to obtain a chunk of submission keys.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure that the API requires it, but to be safe, it should be case-sensitive. This change should be reverted.

@@ -31,9 +31,9 @@ Push

Interfaces used during Push actions.

1. *formUpload* to upload a form and its media files to ODK Aggregate.
1. *form upload* to upload a form and its media files to ODK Aggregate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not 100% sure that the API requires it, but to be safe, it should be case-sensitive. This change should be reverted.

@richa208
Copy link
Contributor Author

@yanokwa Sorry for the trouble 😅 I have made the requested changes!

@richa208 richa208 changed the title Changed Line edit Jan 30, 2018
@adammichaelwood adammichaelwood merged commit 31850d3 into getodk:master Jan 31, 2018
@yanokwa
Copy link
Member

yanokwa commented Jan 31, 2018

Thanks for sending in this PR, @richa208. I'm looking forward to your next!

@richa208
Copy link
Contributor Author

Sure @yanokwa 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants