Kobo Form Sharing Notification for WCS Admins
Lists of “deployed” and “archived” Kobo BNS/NRGT forms for data collection are stored in this Google Sheet.
The below “Form Sharing” workflows have been configured in OpenFn. See the form-sharing directory for the underlying code.
🎥 See this video for an overview of how the solution works, and the below sections on how to manage the forms list in the Google Sheet.
When the workflow runs, it will:
- Check the connected Kobo accounts for form updates
- Compare any updated forms with the list of deployed forms in the “Deployed” Forms Sheet
- Add any newly deployed forms to the Sheet
- Update rows in the “Deployed” Sheet if forms are archived, and then add the archived form to the “Archived” Sheet
- Assign Asana Task(s) to the WCS admin to review every form newly deployed or archived
Managing the Forms Lists in Google Sheets
This Master Forms Sheet is now the source of truth for what Kobo forms should or should not be synced to the ConSoSci database. Update the column automate_sync
to true/false to specify whether these forms should be included when either the BNS-1A Ongoing or [BNS-1B Historical] “Get forms” jobs run.
Syncing BNS/NRGT Kobo Form Submissions
Now with this Master Forms Sheet set up, there are 3 workflows configured to sync BNS and NRGT forms on an ongoing and historical basis in the ConSoSci
project.
🎥 See this video for how to manage ongoing and historical syncing of Kobo forms.
- Ongoing sync: The
[BNS1-A]
jobs will sync “deployed” Kobo forms (whereautomate_sync: true
in the deployed forms sheet).
- Historical sync: The
[BNS1-B]
jobs will sync “archived” Kobo forms (whereautomate_sync: true
in the archived forms sheet).
- On-demand sync: The
[BNS3]
job will sync all submissions for any Kobo form manually entered into this job. (This is in case you want to run syncs on-demand, but do not want to update the forms lists in the Google Sheet.)
Syncing Kobo metadata for GRM forms
An additional workflow has been set up to fetch deployed GRM form data from the Master Forms Sheet, get metadata (submission count, last submission date) from Kobo for those forms, and then update the WCS Programs Database KoboData table with the metadata.
Specifications
- Original Github technical specification and the workflow diagram (v2)
- Change request for how archived forms are managed
How to re-process Kobo form submissions & re-sync historical data
You can either:
- add the form to the archived forms list, set the column L
automate-sync: true
and run the historical job to re-sync all submissions for that form, or - specify a manual cursor in the Get FormsList Ongoing job.
🎥 See this video (minute 1:19) for guidance!