Documentation

# Setting Up Form Widgets

Capturing field data often requires filling some attributes in the form to record the properties of surveyed points, lines or polygons. Forms can simplify the data entry and even ensure to some extent that the correct information is filled in.

Mergin Maps Input supports a number of edit widget types for forms such as drop-down options, slider, date and time, checkbox, or photos.

Forms can be configured using QGIS Documentation QGIS widget types (opens new window) .

QGIS widget Description
Preview in Mergin Maps Input
 Example project
Text Edit Text layout Mergin Maps Project documentation/test_forms (opens new window)
QR & barcode scanner Camera to scan QR and barcode layout Mergin Maps Project documentation/test_qrcode (opens new window)
Range Numeric field layout Mergin Maps Project documentation/form_setup (opens new window)
Range Slider layout Mergin Maps Project documentation/form_setup (opens new window)
Date&Time Calendar with time layout Mergin Maps Project documentation/form_setup (opens new window)
Attachment Photos from device's camera or gallery layout Mergin Maps Project documentation/form_setup (opens new window)
Checkbox Checkbox layout Mergin Maps Project documentation/form_setup (opens new window)
Value Map Drop-down menu with predefined values layout Mergin Maps Project documentation/form_setup (opens new window)
Value Relation Drop-down menu with values from another table layout Mergin Maps Project documentation/test_forms (opens new window)

In addition to the edit widgets, extra configuration can be done to the fields and form layout to make the data collection easier and more consistent. For example: setting a default value, conditional visibility and constraint enforcement.

# Multiline text

TIP

Clone Mergin Maps Project documentation/test_forms documentation/test_forms (opens new window) to follow this example!

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. In addition to a single line text, you can change the widget to accept 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.
  3. In the Widget Display tab:
    • Ensure that Text Edit is selected
    • Check the Multiline option
  4. Apply the changes. Don't forget to save and sync your project!

text

In Mergin Maps Input, the multiline text edit widget will look like this:
text

# QR code

TIP

Clone Mergin Maps Project documentation/test_qrcode documentation/test_qrcode (opens new window) to follow this example!

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 and it can be in combination of lower or upper case letters).

In Mergin Maps Input, there will be a QR code icon next to the field. Click on the QR code icon to read the QR code using your camera - the text (e.g. a link) will be filled in automatically.

qrcode

# Numbers

TIP

Clone Mergin Maps Project documentation/form_setup documentation/form_setup (opens new window) to follow this example!

Numeric fields can be handled by the Range widget, which allows two options:

  • Editable to enter a number manually
  • 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 numeric field you want to work with.
  3. In the Widget Display tab select Range from the drop-down menu.
  4. Apply the changes. Don't forget to save and sync your project!

number

In Mergin Maps Input, the editable range widget will look like the number field here:

number

# Slider

When setting up a slider, ensure your field type is integer.

  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.
  3. In the Widget Display tab:
    • select Range from the drop-down 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!

slider

In Mergin Maps Input, the slider will look like the Number of plants field. It can be filled in by moving the slider:

slider

# Date and time

TIP

Clone Mergin Maps Project documentation/form_setup documentation/form_setup (opens new window) to follow this example!

If you want to record time and date when you capture the feature, you need to make sure you have a field with Date or Date and Time type present in your survey layer.

  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 field you want to work with.
  3. In the Widget Display tab:
    • select Date/Time from the drop-down menu
    • select the Date Time Field Format
    • in Widget Display tab, check the Calendar popup option
  4. If you want to automatically insert the date (or date and time) when the feature is created, type now() as a default value in the Defaults tab.
  5. Apply the changes. Don't forget to save and sync your project!

datetime

In Mergin Maps Input, the date can be edited using a calendar pop up. If you use now() as the default value, the current date and time will be automatically filled in.

datetime

It is also possible to use custom Field Formats and Widget Displays.

WARNING

While working with QString fields with a date/time value and format function (used in a default value), it is important to match field format with a given format there.

Following types are supported:

Type: QDate

field format widget display default value value
Date - - 0000-00-00
Date - now() 2020-09-09
Date dd/MM/yyyy now() 09/09/2020

Type: QDateTime

field format widget display default value value
Time - - 00:00:00
Time - now() 12:34:56
Time HH/mm/ss now() 12/34/56
Date Time - - 0000-00-00 00:00:00
Date Time - now() 2020-09-09 12:34:56
Date Time dd/MM/yyyy hh-mm-ss now() 09/09/2020 12-34-56

Type: QString

Field Format Widget Display Default Value Value
Date - format_date(now(), 'yyyy-MM-dd') ''2020-09-09'
Custom (dd/MM/yyyy) dd/MM/yyyy format_date(now(), 'dd/MM/yyyy') '09/09/2020'
Time `` - format_date(now(), 'HH:mm:ss') '12:34:56'
Custom (HH-mm-ss) HH-mm-ss format_date(now(), 'HH-mm-ss') '12-34-56'
Date Time - format_date(now(), 'yyyy-MM-dd HH:mm:ss') '2020-09-09 12:34:56'
Custom (dd/MM/yyyy HH-mm-ss) dd/MM/yyyy HH-mm-ss format_date(now(), 'dd/MM/yyyy HH-mm-ss') '09/09/2020 12-34-56'

# Checkbox

TIP

Clone Mergin Maps Project documentation/form_setup documentation/form_setup (opens new window) to follow this example!

Checkbox field becomes handy when you want to set up a Yes/No, True/False or On/Off in your field. Some file formats, such as GeoPackage support Boolean data type. If you have a field set as Boolean, QGIS automatically assigns the checkbox for widget type.

  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.
  3. In the Widget Display tab, select Checkbox from the drop-down menu.
  4. Apply the changes. Don't forget to save and sync your project!

checkbox

In Mergin Maps Input, the status of the checkbox field can be easily toggled on/off.

checkbox

# Select value from a drop-down menu

To present the options as a drop-down menu in the form, you can use the Value Map or Value Relation widget in QGIS.

# Value Map

TIP

Clone Mergin Maps Project documentation/form_setup documentation/form_setup (opens new window) to follow this example!

  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.
  3. In the Widget Display tab:
    • select Value Map from the drop-down menu
    • for Value and Description type what you want to include in the drop-down menu (here we use: In-door, Woodland, Farmland, Grassland, Marine, Peatlands and Other).
  4. Apply the changes. Don't forget to save and sync your project!

valuemap

Now you can select the value from a drop-down menu in Mergin Maps Input!

# Value relation

TIP

Clone Mergin Maps Project documentation/test_forms documentation/test_forms (opens new window) to follow this example!

The Value Relation widget is similar to the Value Map tool, but the values for the drop-down menu come from another table (e.g. a CSV or another GeoPackage table).

The advantage of having this widget:

  • Editing the values 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 Mergin Maps Input and add the value. See Working with non-spatial tables section for more information.
  • Searching the values: when you have a large list of values, it will become cumbersome to find the right value. With this widget, you will be able to search for values in the list.
  • Selecting multiple values.

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.
  3. In the Widget Display tab:
    • select Value Relation from the drop-down menu
    • select the Layer that contains the values
    • Key column is the field that contains the values
    • Value column is the field that contains the alias (description) of the value
    • if you want to be able to select multiple values, check the Allow multiple selections option
  4. Apply the changes. Don't forget to save and sync your project!

value relation

When you open the field with Value Relation in Mergin Maps Input, you will be able to select values from the list.

value relation
value relation
value relation

# Attachments, cascade form, 1-N relations,...

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

TIP

Learn more about the form layout in Advanced Form Configuration.

← Advanced Form Configuration →