Managing Forms in Central¶
Forms are at the heart of Open Data Kit. Once fetched onto a mobile device from ODK Central, they define the questions, validation, and logic to be presented during data collection. They also serve to organize the data coming back from mobile devices.
In ODK Central, there are four important steps to understand when managing a data collection project:
- Form design is where you define the form itself, laying out many details like the questions and acceptable responses. ODK Central itself does not help with form design. Instead, please take a look at the many available tools and the introduction to form design for help creating your form.
- Form upload is done after you have a working form design. Here you log into ODK Central and upload your new form so that Central knows that it exists. Once you do this, it will become available to any mobile device connected to the server for download and submission upload.
- Data extraction and analysis can occur either at the end of the project, or continually as the project runs. Either way, ODK Central provides several different methods for extracting and analyzing your submission data. This is covered in the Form Submissions article.
- Form lifecycle tools let you manage the lifecycle of your data collection project: ongoing projects can be left alone to stay open, but many projects need a way to wrap things up. ODK Central provides tools to help control, for example, when workers using ODK Collect are allowed to download each form's definition, or separately to upload submissions to each form.
For more information about how to accomplish each of these tasks, please read on.
Uploading a form to ODK Central¶
Once you have an XForms
.xml file in hand, we strongly recommend that you first double check that it is valid using ODK Validate. Once you have confirmation that your form will work, the next step will be to upload it into ODK Central. To do this, log into the management website, and navigate to the Forms listing page by clicking on at the top of the screen.
From there, click on the Create a new form button on the right side of the screen, and you should see a popup appear:
You can either click on the choose one button to browse for your XForms
.xml file, or if you already have it handy somewhere, you can drag it over the gray box and drop it to select it. Either way, once you have chosen your file (you will see the name of your file at the bottom of the gray box when you do), you can click on the Create button immediately below to upload the form.
Some errors you may see:
- You may see a message that reads A resource already exists with xmlFormId value(s) of xyz. If you do, there already exists a form on this server with the same unique designation. If you are using XLSForm, try changing the name of the file. If you designed the form by hand, please check the
id="…"attribute immediately inside the
- You may see a message that says A form previously existed which had the same formId and version as the one you are attempting to create now. To prevent confusion, please change one or both and try creating the form again. This means there once was a form on the server that has since been deleted that has exactly the same formId (see the previous bullet point) and version designation as the one you are now trying to upload. Central won't accept the new form, because this conflict could cause confusion with mobile devices that still have the old form sitting around. To upload this form, change either the formId (again, see the previous bullet point) or update the version and try again.
Once the form is successfully uploaded, you will be taken to the Form Overview page.
The Form Overview page¶
Here, you can get a brief summary of the status of your form, and recommended next steps. You are automatically taken here when you upload a new form or click on the form name in the Form listing page. You can also get back here from other form-related pages by clicking thetab below the name of the form.
The documentation on this page is a more detailed introductory explanation of form management in ODK Central, but the checklist you find on the Overview page is tailored to the current status of your form and your server and is a great place to look when you aren't sure what to do next.
In the future, look forward to seeing even more useful information at-a-glance on this page.
Forms With Attachments¶
If your uploaded form references any external files (images, audio, or video included as part of your question prompts, or data lookup files used to populate selection lists), Central will see this and open up some additional displays and controls you will need to provide those external files:
If you see this extra Upload Form Media Files checklist step and Media Files tab at the top of your form overview, then Central believes you need to upload some files associated with this form. If the checklist step has been checked off, then you've already completed this task: great work! Otherwise, click on thetab at the top to see what files you'll need to provide.
This form design references three files that we'll need to provide, one of which we've already uploaded. You can see the name and expected type of the file in the table, as well as when the file was last uploaded. You can click on the name of any uploaded file to download what Central has for it. To upload a new one, you'll want to drag-and-drop one or more files onto the table.
On File Types and Contents
While Central will detect the type of file the form design expects, and will verify that the name of any uploaded file matches one that is expected, Central will not double-check the type of the file, nor the contents of the file for you. So, just because Central accepts your file does not necessarily mean that it will work correctly.
Bulk-uploading Many Attachments At Once¶
If you select and drag many files at once onto the table, Central will automatically try to match each file with a name in the table. You'll have a chance to see what it came up with and confirm that things look okay before the upload begins. You will see a warning if one or more of your dragged files don't match any of the expected names.
Uploading One Attachment¶
If you drag a single file onto the table, you'll have the option of which table row you'd like to upload that file into. This way, if the file isn't named exactly what Central expects, you can still upload a file into that slot without having to rename it on your own computer. But if the file does have the appropriate name, you can drop it somewhere other than a specific slot (for example, just below or just above the table) to have Central match it up with the correct slot automatically.
Seeing Form Submissions¶
To see the current submissions uploaded to Central for a form, you can click on the Managing Form Submissions in Central article.tab below the name of the form. Here, you will see a summary table of all known submissions, and you will find multiple options for downloading and analyzing your submission data. This page and these options are covered in more detail in the
Managing Form Lifecycle¶
Forms can be in one of three lifecycle stages: Open, Closing, and Closed. All forms start in Open state when they are first created. You can see what each of these means below:
|State||Available for download to apps||Accepts new submissions from apps|
As you can see, you can use the Closing state to prevent further distribution of a form while still allowing the final few submissions to come in, while the Closed state effectively turns the form off completely. You can always set the form lifecycle stage to whatever you want: you can always, for example, re-open a closed form.
To set the form lifecycle stage, go to the Form Settings page by clicking on thetab under the name of the form at the top of the page. Here, you will find the three possible stages on the left side. Clicking on one will immediately set the new stage: it is not necessary to click on any Save button.
Deleting a Form¶
Do not delete a form until you are completely sure you never need a form or its submissions again. If you only want to turn the form off so that it doesn't appear to users of mobile data collection apps, we suggest using the form lifecycle controls explained above.
If you are certain you wish to delete a form, you can find the option on the Form Settings page: click on the Delete this form button.tab under the name of the form at the top of the page. On the right side of this page, you will find the