Versions Compared

Version Old Version 22 New Version 23
Changes made by

Kai Cowger

Gillian Javetski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Overview

By default, CommCare offers a few features to help manage forms on the device. Since some of these features are not visible until discovered, and thus somewhat confusing, this page lays out the basics of how forms are managed.

...

When the features are disabled, incomplete and saved form records are not created, and all of the user interface options pertaining to them will be removed from the CommCare application's home screen.

Incomplete Forms

Warning
title

Feature Constraints

Please read the Feature Constraints section before using Incomplete Forms for your project workflows.


Overview of incomplete forms

...

There are 2 ways you can save a form as incomplete:

  1. Pressing the back button during form entry (to cancel entry and return to CommCare) results in a popup asking whether changes to the form should be saved. If the user chooses to save the changes, the current form will be saved and marked as incomplete.

  2. During form entry, if the user brings up the soft menu and chooses Save Form, the form will be saved in its current form as incomplete.

Once you have saved the form as incomplete, it will be saved in an encrypted format to the device's storage.

...

There are two ways to resume entry of an incomplete form

  1. From the CommCare home screen, select Incomplete under the Form Records heading, navigate to the incomplete form, and select it.

  2. If the form is associated with a case, then the next time the user selects that same case and form they will have the option to resume the incomplete form. A dialog box will ask whether the user wants to resume the form which that had previously started and saved as incomplete. From here, the user can resume entry, start a new form, or delete the incomplete form (and start a new form).

If you choose to continue an incomplete form, the original incomplete form you saved will remain saved on the phone unless you save it again or complete the form. If a user pressed the back button and chooses to not save their changes, for instance, the original incomplete form remains as it was before form entry. If the user presses Save Form on the menu, however, it will update the existing saved form with the new version.

Feature Constraints

title
Info

Feature Constraints

Saved Incomplete Forms have the following 2 major structural constraints that you should be aware of.

  1. Saved Incomplete Forms are not synced with CommCareHQ and are only stored locally on the mobile device

    1. Consequence: If you lose access to your mobile device, say, it breaks or is lost, Incomplete Forms saved on the device will not be recoverable.

    2. Consequence: If you uninstall an application with incomplete forms, Incomplete Forms saved on the device will not be recoverable.

  2. Saved Incomplete Forms are not updated when you make updates to your app or the data the incomplete forms rely on

    1. Consequence #1: If a form is saved as incomplete, and

certain

    1. certain app updates like changes to the form's structure or changes to the assets used by the form (say, images or audio) are made, it can prevent mobile workers from resuming the

incomplete

    1. incomplete form.

    2. Consequence #2: If a form is saved as incomplete, and then resumed after data (say, case properties) the form relies on has changed, the form will have undefined/unpredictable behavior


Removing an incomplete form

...

Below are some recommendations if using incomplete forms:

  • It is important not to leave incomplete forms open for a long time, because this makes it more likely that case data will be changed before the form is actually submitted. For example, if you have an incomplete form about a particular case, and then fill out another form that updates the same case prior to finishing the incomplete form, your case data may not reflect the most recent information.

  • In addition if a project uses incomplete forms, the Form Completion Time report will likely not be accurate, as uses the total time from when the form was first opened until the time when the form was closed. If an incomplete form is left open for a long time this will throw off the average used in this report and it will appear that users are taking a very long time to complete forms.

  • If you are using the User Case feature to do something like assign unique IDs, please be aware that

    for

    for unique IDs to be assigned correctly, the user must complete one registration form before starting the next. In the case of simultaneous incomplete forms, the same value will be loaded in those forms, resulting in duplicate IDs.

  • Incomplete forms on Web Apps are deleted automatically after 7 days.

Unsent Forms

Once a form has been entered and processed by CommCare it is stored in an encrypted format to be sent to the server as soon as a connection is available. These unsent forms aren't available to view individually, but the number of unsent forms can be checked by navigating to the CommCare home screen and reading the message underneath the Sync with Server button. If that message does not contain a notification about unsent forms, all forms have been sent.

...