Mergin Maps

# Setting Up Widgets in Attributes Form

Capturing field data often requires filling some attributes in the form to record the properties of surveyed points, lines or polygons. Attribute forms can simplify the data entry and even ensure to some extent that the correct information is filled in. Here, we will explore the possibilities of various QGIS Documentation QGIS widgets (opens new window) that can be used in Mergin Maps mobile app.

Extra configuration of attribute forms can be done to make data collection easier and more consistent, such as using default values, conditional visibility or constraint enforcement. These topics are covered in Attributes Form Configuration and Attributes Form Layout.

Prefer video? Check out this tutorial on how to configure QGIS widgets for survey forms.

Attributes forms can be configured using QGIS Documentation QGIS widget types (opens new window) in the Attributes Form tab in the Layer Properties.

QGIS Layer Properties Attributes Form tab

Here is an overview of widgets commonly used both in QGIS and the mobile app. Note that the widget has to be compatible with the data type of a field.

QGIS widget Description
Preview in Mergin Maps mobile app
Text Edit Text Mergin Maps mobile app text field form
Text Edit Multiline Text Mergin Maps mobile app text field form
QR & barcode scanner Camera to scan QR and barcode Mergin Maps mobile app QR code field form
Range - Editable Enter a number Mergin Maps mobile app numeric field form
Range - Slider Select a number using the slider Mergin Maps mobile app slider field form
Date/Time Calendar with time Mergin Maps mobile app date time field form
Checkbox Checkbox Mergin Maps mobile app checkbox field form
Value Map Drop-down menu with predefined values Mergin Maps mobile app value map field form
Value Relation Drop-down menu with values from another table Mergin Maps mobile app value relation field form
Attachment Photos from device's camera or gallery Mergin Maps mobile app attachment field form Mergin Maps mobile app attachment field form
Relations - Gallery Multiple photos from device's camera or gallery Mergin Maps mobile app multiple photos attributes form
Relations Multiple records linked to one feature Mergin Maps mobile app 1-N relations attributes form

Public project available

💡 These widgets can be explored in this project: Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window).

# Text

Adding or editing text is the most common method for inserting information within the forms. In QGIS, the default widget for most types of fields is the Text Edit. It can be used for single line or multiline text inputs.

QGIS Text Edit Widget Type

In the mobile app, the text can be entered manually or using voice-to-text (if your mobile device supports this feature).

Using voice to text in Mergin Maps mobile app

# Multiline text

Example project available

Multiline text option is used in this public project: Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window). Download or clone it to see this setup.

The Text Edit widget offers the option to store multiple lines within a single field.

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the field you want to work with (here: text-multiline)
  3. In the Widget Type tab:
    • Ensure that Text Edit is selected
    • Check the Multiline option ✔️
  4. Apply the changes. Don't forget to save and sync your project!

QGIS multiline text field setup

In the mobile app, the multiline text edit widget will look like this:
Mergin Maps mobile app multiline text field form

# QR code

Example project available

A QR code field is used in this public project: Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window). Download or clone it to see this setup.

To be able to scan QR codes using your camera, the field name or the field alias has to contain the word qrcode (the text is not case sensitive, it can be in combination of lower or upper case letters).

In the mobile app, there will be a QR code icon next to the field. Tap on it to scan the QR code using your camera and the content (a number, text, link, etc.) will be filled in automatically to your field.

Mergin Maps mobile app QR code field form

# Numbers

Example project available

This public project: Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window) uses various options for entering numerical data. Download or clone it to see this setup.

Number fields can be handled by the Range widget. Two options are supported by the mobile app: editable range and slider.

# Range

To set up the editable range widget:

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the integer field you want to work with (here: numbers-range-editable).
  3. In the Widget Type tab the Range widget and the Editable option should be selected by default. If this is not the case, select these options from the drop-down menus.
  4. Apply the changes. Don't forget to save and sync your project!

QGIS number editable range field form

In the mobile app, the numbers can be entered manually or by using the +/- buttons:

Mergin Maps mobile app number range field form

# Slider

To set up the Slider:

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the numeric field you want to work with (here: numbers-range-slider).
  3. In the Widget Type tab:
    • the Range widget should be selected by default (if not, select it from the menu)
    • set the edit widget to Slider
    • set the Minimum, Maximum and Step values of the slider
  4. Apply the changes. Don't forget to save and sync your project!

QGIS number range field form

In the mobile app, the Slider looks like this. The number can be filled in by moving the slider:

Mergin Maps mobile app number range field form

# Date and time

Example project available

Various options of setting up Date and Date&Time fields are included in this public project: Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window). Download or clone it to explore it in more detail.

Date or Date and Time fields can be used to record date and time. The most common use is to record when a feature was created or updated. This can be done manually or automatically by using default values.

To set up the Date/Time widget:

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the Date and Time field you want to work with (here: datetime).
  3. In the Widget Type tab and select the Date/Time widget.
    • use the default or custom Display Format
    • check the Calendar popup option ✔️
    • use the preview to confirm that this is the format you want to use to store your timestamps
  4. If you want to automatically insert the date (or date and time) when the feature is created, use now() as a default value in the Defaults tab.
  5. Apply the changes. Don't forget to save and sync your project!

QGIS date time field form

In the mobile app, the date can be edited using a calendar pop up. If you tap the icon next to field, the current date and time will be filled in.

Mergin Maps mobile app calendar form date time fields

# Custom date and time formats

Date and time fields can use custom display format.

Here are some examples:

Custom Display Format Preview
dd.MM.yyyy 12.01.2024
MMMM d yyyy January 12 2024
HH:mm:ss 12:34:56
yyyy-MM-dd HH:mm:ss 2020-09-09 12:34:56
dd/MM/yyyy HH-mm-ss 09/09/2020 12-34-56

# Checkbox

Example project available

Checkbox widget is used in this public project Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window). Download or clone it to see the setup.

Checkbox field becomes handy when you want to set up a Yes/No, True/False or On/Off in your field.

If you have a field set as Boolean in your GeoPackage layer, QGIS assigns the checkbox widget type by default.

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the field you want to work with (here: checkbox).
  3. In the Widget Type tab, the Checkbox widget should be set by default (if not, select it from the drop-down menu).
  4. Apply the changes. Don't forget to save and sync your project!

QGIS checkbox field form

Checkbox widget can be also used for Text (string) fields:

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the field you want to work with (here: checkbox-string).
  3. In the Widget Type tab, select the Checkbox widget and define values for the Checked and for the Unchecked state. Here we use Yes and No.
  4. Apply the changes. Don't forget to save and sync your project!

QGIS checkbox field form

In the mobile app, the status of the checkbox field can be easily toggled on/off.

Mergin Maps mobile app checkbox field form

# Select value from a drop-down menu

Selecting values from a drop-down menu is faster then typing them in manually and it also ensures that there are no typos or spelling variations. To present the options as a drop-down menu in the form, you can use the Value Map or Value Relation widgets in QGIS.

There are some benefits of using the Value Relation widget, such as:

  • Option to select multiple values from the list (in this case, the field needs to be of text data type).
  • The layer that contains values can be edited in the field. For example, if you have missed a value in your list for the drop-down menu, you can edit the table in the mobile app, add the value and use it during your survey. See Working with non-spatial tables for more details.
  • Searching the values: if you have a large list of values, it will become cumbersome to find the right value. With Value Relation widget, you have the option to search for values in the list in the mobile app.

# Value Map

Value map widget is used to select a value from a drop-down menu. Values are defined in the widget. They cannot be changed or added from the mobile app and only one value can be selected.

If you want to use multiple selections in a field or need to add new values during the survey, check out the Value Relation widget.

Example project available

This public project Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window) contains a Value Map field. Download or clone it to see the setup.

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the field you want to work with (here: valuemap)
  3. In the Widget Type tab, select the Value Map option from the drop-down menu and fill in the table below.
    Value is what will be stored in the field (these can be coded values or shortened names, here we use 1, 2, 3). Description is what will be displayed in the form and in the attributes table (here: value 1, value 2, value 3).
  4. Apply the changes. Don't forget to save and sync your project!

QGIS value map field form

Now you can select the value from a drop-down menu in the mobile app:
Mergin Maps mobile app value map field form

# Value Relation

Example project available

This public project Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window) contains a Value Relation setup. Download or clone it to explore it in more detail.

The Value Relation widget is similar to the Value Map widget, but the values for the drop-down menu come from another layer (usually a non-spatial table).

To have the option to safely add new values when working collaboratively, the value table should have a unique field with UUID values. This field should use the uuid() function as a default value, so that every new entry has its UUID.

To set up Value Relation in QGIS:

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the field you want to work with (here: value-relation-multi-select)
  3. In the Widget Type tab, select Value Relation from the drop-down menu and set it up as follows:
    • Select the Layer that contains the values (here: value-relation-table)
    • Key column is the field that contains the values (here: uuid)
    • Value column is the field that contains the alias (description) of the value (here: value)
    • Check the Allow multiple selections option ✔️ if you want to have the option to select multiple values
  4. Apply the changes. Don't forget to save and sync your project!

QGIS value relation field form

Using UUID as key field

Why UUID? FID can be changed during synchronisation. If multiple surveyors add new entries to the value table, features can end up with wrong values.

On the other hand, QGIS Documentation UUID (opens new window) (Universally Unique Identifier) is guaranteed to be unique and will not be changed when synced. Therefore, we recommend using UUID if you want to add new values during the survey.

When you open the field with Value Relation in the mobile app, you will be able to select values from the list.

Mergin Maps mobile app value relation multiple selection

# Attachment

Example project available

Basic attachment widget is set up in the public project Mergin Maps Project documentation/form-widgets documentation/form-widgets (opens new window).

When there is a field with the Attachment widget type in a survey layer, the mobile app automatically sees it as a field to capture photos. Such field exists in a survey layer in the basic Mergin Maps project (created by using New basic QGIS project option when creating a project in QGIS). If you create your survey layers manually, you will need to set it up.

  1. Right-click on a layer, select Properties and go to the Attributes form tab.
  2. In the list of Available Widgets select the text field you want to work with (here: attachment)
  3. In the Widget Type tab, select Attachment from the drop-down menu:
    • Default path defines where images will be saved. If it is not defined, the project home folder will be used.
    • Store the path as Relative to project path or Relative to default path depending on how you want to store the paths.
  4. Apply the changes. Don't forget to save and sync your project!

QGIS form photo attachment

In the mobile app, you have the option to take a picture using the camera or upload a picture from the gallery of your mobile device:
Mergin Maps mobile photo attachment

More about this topic

There are much more settings related to photos that can improve your workflow, such as storing them in a custom folder, resize them automatically or customise their name. Learn more about this topic in Capturing Photos.

# Cascade forms, 1-N relations, form layout,...

There is much more you can do to set up your forms efficiently, such as:

← Attributes Form Configuration →