Notes

Notes provide further information and instruction when designing your survey. Notes can contain text, images, video, or audio.

Style notes

XLSForm supports the following limited subset of HTML syntax for styling notes in your form:

Format typeHTMLResult

Font color

<font color="red"></font>

Text is in red.

Hyperlink

<a href="http://www.esri.com"></a>

Link to website.

Bold

<b></b>

Text is bold.

Italics

<i></i>

Text is in italics.

Heading 1

<h1></h1>

First heading format.

Heading 2

<h2></h2>

Second heading format.

Center

<center></center>

Text is centered.

Blockquote

<blockquote></blockquote>

Text is indented blockquote.

Underlined

<u></u>

Text is underlined.

Typewrite

<tt></tt>

Text is in typewrite font.

Strikethrough

<s></s>

Text is in strikethrough font.

You can also use a hyperlink to provide links to phone numbers and emails. The following example will display in your survey as a link that, when selected, will have the user's phone dial the number.

<a href="tel:555-555-5555">555-555-5555</a>

If the device is not a phone, the user will instead be prompted to select a phone app they have installed. This is ideal for situations such as presenting emergency numbers.

Similarly, you can also link to an email address. This, for example, would open the device's chosen email client when selected and send an email to the address referenced.

<a href="mailto:example@example.com">Email</a>

The same HTML syntax can also be applied to labels.

Dynamic labels

Notes, labels, and hints in your survey can display the contents of another question by referring to the question name in the text using the format ${field_name}. This can be useful to display the contents of fields that don't need to be exposed otherwise, such as calculations based on previous answers, or the name of a person being surveyed from a previous question in the label of the next question.

Calculations can't be performed in a label or hint. If you want to display the results of a calculation, make sure the calculation is in a question.

Visually combine notes

The XLSForm format only allows one of each type of media (image, video, or audio) to be added to a note question. To work around this limitation, subsequent notes will be visually merged so that they appear as one note in your form. This means you can include multiple note fields one after another in your survey. When viewing the form, the notes will appear as a single note.

Notes in the feature layer

Depending on how a note is configured in the XLSForm, the question behaves differently when the survey is published.

If a note is given a name, a string field is created for the note. A user filling out your survey in the Survey123 field app cannot input anything in this field, but any default or calculated value held in it will be submitted to the feature layer. Note questions with a name can also be omitted from the feature layer by setting bind::esri:fieldType to null.

If a note has no name, no field is generated for the note in the feature layer. It acts only to store and display read-only text. The note question will be shown in the Schema tab with a generated_note_ prefix and a null field type.

If a republished survey will add a field to the feature layer, you will be warned that this change will add a field.

Note:

Note question names in surveys created in the Survey123 website are prefixed with generated_note_ to ensure the note doesn't get a field in the feature layer. These prefixed field names should not be removed or renamed, and the question should not have bind::esri:fieldType set to null, as this will cause a conflict in the website.

Rewrite UI elements

By providing notes with specific names, it's possible write new content for elements of the form UI.

Note:

Only generated_note_form_title is used by the field app. The rest of these notes are only used by the web app.

All of these notes support HTML content, except for generated_note_form_submit_text.

Question nameContent

generated_note_form_title

Form title

generated_note_form_description

Survey description

generated_note_form_submit_text

Submit button text

generated_note_form_footer

Survey footer

generated_note_prompt_submitted

Thank you screen content