Form metadata in XLSForm

Last updated: 25 Nov 2025

Metadata questions automatically gather information about the data collection process, such as the date, time, and device used, without requiring input from the respondent.

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.

Note: This article focuses on adding metadata questions in XLSForm. To learn about adding metadata questions in the KoboToolbox Formbuilder, see Form settings and metadata.

Adding metadata questions in XLSForm

Metadata questions are added to XLSForm in the same way as any other question types:

  1. Enter the metadata question type in a new row, using the exact name shown in the table below.

  2. Include a question name.

  3. Question labels are not required, as they are not displayed in the form.

survey worksheet

type

name

label

start

start_time

end

end_time

survey

Available metadata questions in XLSForm

Available metadata questions in XLSForm include:

Type

Description

start

Records the exact time and date when a submission is started.

end

Records the date and time when a submission is finalized.

today

Records the date of the submission.

deviceid

Records the unique identification of the device or browser used to collect data. The deviceid is automatically generated and cannot be modified by users.

Note: In KoboCollect, the deviceid is updated whenever the app is reinstalled on a device. In Enketo, the deviceid resets any time a new browser window is used.

username

In KoboCollect, records the username saved in the KoboCollect app settings. If no username is set, it records the one used to sign in to the server.
In Enketo, records the account username only if authentication is required.

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.

phonenumber

Records the phone number stored in the KoboCollect app settings. This metadata question is not supported in Enketo.

email

Records the email address from the KoboCollect app settings. This metadata question is not supported in Enketo.

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.

background-geopoint

Captures GPS coordinates when a specific question is answered. The question must be specified in the trigger column of the background-geopoint question.

background-audio

Records audio in the background while a form is open. To learn more about this feature, see Recording interviews with background audio recording.

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.

To learn more about using the audit question for audit logs and configuring settings, see Form Audit Log (ODK).

Configuring metadata in KoboCollect

The user’s default email, phone number, and username can be configured and modified in the KoboCollect app:

  1. Open the KoboCollect app.

  2. Tap the Project icon in the top right corner of your screen.

  3. Tap Settings.

  4. Scroll down to User and device identity, then Form metadata.

  5. Enter the username, phone number, and/or email address. You can also view the current device ID.