You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/metadata_xls.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,19 +28,19 @@ Metadata questions are added to XLSForm in the same way as any other question ty
28
28
29
29
Available metadata questions in XLSForm include:
30
30
31
-
|Question type| Description |
31
+
|Type| Description |
32
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 <ahref="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 <ahref="https://support.kobotoolbox.org/project_sharing_settings.html#allowing-submissions-without-authentication">authentication is required</a>.<br><br>**Note:** Because the `username` field can be edited in KoboCollect, it may not match the account used to authenticate to the server. To see which account submitted the data, refer to the automatically generated `_submitted_by` field.|
38
-
| phonenumber | Records the phone number stored in the <ahref="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 <ahref="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. Can be used to warm up the device GPS so that later GPS questions can reach accurate readings more quickly. |
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
-
| background-audio | Records audio in the background while a form is open. To learn more about this feature, see <ahref="https://support.kobotoolbox.org/recording-interviews.html">Recording interviews with background audio recording</a>. |
43
-
| 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 <ahref="https://docs.getodk.org/form-audit-log/">Form Audit Log (ODK)</a>. |
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 <ahref="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 <ahref="https://support.kobotoolbox.org/project_sharing_settings.html#allowing-submissions-without-authentication">authentication is required</a>.<br><br>**Note:** Because the `username` field can be edited in KoboCollect, it may not match the account used to authenticate to the server. To see which account submitted the data, refer to the automatically generated `_submitted_by` field.|
38
+
|`phonenumber`| Records the phone number stored in the <ahref="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 <ahref="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. Can be used to warm up the device GPS so that later GPS questions can reach accurate readings more quickly. |
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
+
|`background-audio`| Records audio in the background while a form is open. To learn more about this feature, see <ahref="https://support.kobotoolbox.org/recording-interviews.html">Recording interviews with background audio recording</a>. |
43
+
|`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 <ahref="https://docs.getodk.org/form-audit-log/">Form Audit Log (ODK)</a>. |
0 commit comments