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

Adding manual instruction to save file to system when automatic save fail #301

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
2 changes: 1 addition & 1 deletion src/_templates/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
</script>
{# this is used when loading the search index using $.ajax fails,
such as on Chrome for documents on localhost #}
such as on Chrome for documents on localhost #}
<script id="searchindexloader"></script>
{{ super() }}
{% endblock %}
Expand Down
19 changes: 17 additions & 2 deletions src/getting-started-2-architect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,22 @@ You should now see some JSON in the output window. Hit the :guilabel:`Save to Fi

.. note::

The :file:`definition.csv` and :file:`properties.csv` files are updated because the *form_id* is the same as the *table_id*.
**Manual Saving (When Automatic Saving Fails)**

.. this instruction is needed when automatic saving fails.

In case you encounter an error with the :guilabel:`Save to File System` button (e.g., "Something went wrong! Please save the file manually"), follow these steps to manually save the generated JSON:

1. Copy the JSON output displayed in the output window.
2. Open a text editor (like Notepad, VSCode, or Sublime Text).
3. Paste the JSON into a new file.
4. Save the file with the name `formDef.json` in the same location as the `exampleForm.xlsx` file (typically :file:`app/config/tTables/exampleForm/forms/exampleForm`).
5. Repeat this process for any other files that failed to save (e.g., :file:`definition.csv`, :file:`properties.csv`), if needed.

.. note::

The :file:`definition.csv` and :file:`properties.csv` files are updated because the *form_id* is the same as the *table_id*.


On the :program:`Chrome` Browser, click on the :guilabel:`Preview` tab. Click on :guilabel:`Purge Database`. This will delete the earlier *Example Form* data table -- a necessary step because we are adding a :th:`Color` column to that data table. Select :guilabel:`exampleForm` if you do not already have that form open.

Expand Down Expand Up @@ -185,4 +200,4 @@ We also provide guides for setting up your own ODK-X application for each of the

However, the user guides for these tools are also useful for everyone.

Finally, to expand your knowledge of the more advanced features of the platform, such as data permission filters, read the :doc:`advanced-topics-architect`.
Finally, to expand your knowledge of the more advanced features of the platform, such as data permission filters, read the :doc:`advanced-topics-architect`.