File tree Expand file tree Collapse file tree 1 file changed +64
-0
lines changed
Expand file tree Collapse file tree 1 file changed +64
-0
lines changed Original file line number Diff line number Diff line change 11# Import data from Kobo
2+
3+ [ KoboToolbox] ( https://www.kobotoolbox.org/ ) is a set of tools for data collection. It allows user to create forms and
4+ collect data.
5+
6+ ---
7+
8+ ### Prerequisites
9+
10+ KoboToolbox integration is configured with the following variables
11+ ``` shell
12+ KOBO_KF_URL
13+ KOBO_MASTER_API_TOKEN
14+ KOBO_PROJECT_VIEW_ID
15+ KOBO_API_TOKEN
16+ ```
17+
18+ these are defined in the Constance configuration in the [ Admin Interface] ( ../interfaces.md#admin-interface ) :
19+
20+ ```
21+ Home › Constance › Config > Remote System Tokens
22+ ```
23+
24+ The variables control which data can be imported from KoboToolbox:
25+
26+ 1 . When variables below are set:
27+ ``` shell
28+ KOBO_KF_URL
29+ KOBO_MASTER_API_TOKEN
30+ KOBO_PROJECT_VIEW_ID
31+ ```
32+ data from forms under specific project view can be imported
33+ 2. When variables below are set:
34+ ` ` ` shell
35+ KOBO_KF_URL
36+ KOBO_API_TOKEN
37+ ` ` `
38+ data from forms of the specific user can be imported
39+ ---
40+
41+ # ## Processing
42+
43+ In the [Collector Interface](../interfaces.md#collector-interface), navigate to the ** [Programmes]** menu item on the left, then click the
44+ ** [Import Data]** button and choose the ** [Kobo]** tab. If you see the message below before you can import data
45+
46+ ` ` ` text
47+ Please set country iso code for office to use Kobo import
48+ ` ` `
49+
50+ you have to set ` Kobo country code` for the office you use in admin interface.
51+
52+ The Kobo import form contains following configuration parameters:
53+
54+ - ** Batch Name** – a custom batch name if needed.
55+
56+ - ** Project id** – a project view id KoboToolbox forms belong to.
57+
58+ - ** Individual records field** - a prefix used in form to group individual data. All the individual data is grouped
59+ under this key in JSON we get from KoboToolbox.
60+
61+ - ** Check Before** – a flag to not import data on any data inconsistency.
62+
63+ - ** Fail if Alien** – a flag to not import data if it contains unknown fields.
64+
65+ Once settings are configured, you can click ** [Import]** to start import or click ** [Close]** to cancel it.
You can’t perform that action at this time.
0 commit comments