Skip to content

Commit a0ebf7f

Browse files
authored
Create metadata_xls.md
1 parent 6896998 commit a0ebf7f

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

source/metadata_xls.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Form metadata in XLSForm
2+
3+
Metadata questions automatically gather information about the data collection process, such as the date, time, and device used, without requiring input from the respondent.
4+
5+
Metadata questions are not visible to respondents. The information collected in the background can be used for auditing, to ensure data integrity, and to support data analysis.
6+
7+
<p class="note">
8+
<strong>Note:</strong> This article focuses on adding metadata questions in <a href="https://support.kobotoolbox.org/getting_started_xlsform.html">XLSForm</a>. To learn about adding metadata questions in the KoboToolbox Formbuilder, see <a href="https://support.kobotoolbox.org/form_meta.html">Form settings and metadata</a>.
9+
</p>
10+
11+
## Adding metadata questions in XLSForm
12+
13+
Metadata questions are added to XLSForm in the same way as any other question types:
14+
15+
1. Enter the metadata question **type** in a new row, using the exact name shown [in the table below](https://support.kobotoolbox.org/metadata_xls.html#available-metadata-questions-in-xlsform).
16+
2. Include a question **name**.
17+
3. Question **labels** are not required, as they are not displayed in the form.
18+
19+
**survey worksheet**
20+
21+
| type | name | label |
22+
|:-----|:-----------|:-------------|
23+
| start | start_time | |
24+
| end | end_time | |
25+
| survey |
26+
27+
## Available metadata questions in XLSForm
28+
29+
Available metadata questions in XLSForm include:
30+
31+
| Question type | Description |
32+
|:--------------------|:-------------|
33+
| start | Records the exact time and date when a submission is started. |
34+
| end | Records the date and time when a submission is finalized. |
35+
| today | Records the date of the submission. |
36+
| deviceid | Records the unique identification of the device or browser used to collect data. The <code>deviceid</code> is automatically generated and cannot be modified by users.<br><br>**Note:** In KoboCollect, the <code>deviceid</code> is updated whenever the app is reinstalled on a device. In Enketo, the <code>deviceid</code> resets any time a new browser window is used. |
37+
| username | In KoboCollect, records the username saved in the <a href="https://support.kobotoolbox.org/kobocollect_settings.html#user-and-device-identity-settings">KoboCollect app settings</a>. If no username is set, it records the one used to sign in to the server.<br>In Enketo, records the account username only if <a href="https://support.kobotoolbox.org/project_sharing_settings.html#allowing-submissions-without-authentication">authentication is required</a>. |
38+
| phonenumber | Records the phone number stored in the <a href="https://support.kobotoolbox.org/kobocollect_settings.html#user-and-device-identity-settings">KoboCollect app settings</a>. This metadata question is not supported in Enketo. |
39+
| email | Records the email address from the <a href="https://support.kobotoolbox.org/kobocollect_settings.html#user-and-device-identity-settings">KoboCollect app settings</a>. This metadata question is not supported in Enketo. |
40+
| start-geopoint | Captures GPS coordinates when the form is first opened. |
41+
| background-geopoint | Captures GPS coordinates when a specific question is answered. The question must be specified in the <code>trigger</code> column of the <code>background-geopoint</code> question. |
42+
| audit | Captures a detailed log of the interview process, including start time, end time, location, and user actions during the entire data collection process. This metadata question is not supported in Enketo.<br><br>To learn more about using the audit question for audit logs and configuring settings, see <a href="https://docs.getodk.org/form-audit-log/">Form Audit Log (ODK)</a>. |
43+
44+
## Configuring metadata in KoboCollect
45+
46+
The user’s default email, phone number, and username can be [configured](https://support.kobotoolbox.org/kobocollect_settings.html#user-and-device-identity-settings) and modified in the KoboCollect app:
47+
1. Open the KoboCollect app.
48+
2. Tap the **Project icon** in the top right corner of your screen.
49+
3. Tap **Settings**.
50+
4. Scroll down to **User and device identity**, then **Form metadata**.
51+
5. Enter the username, phone number, and/or email address. You can also view the current device ID.
52+

0 commit comments

Comments
 (0)