Notes

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

HTML formatting

The following HTML tags are supported in notes:

TagAttribute

a

href, style

img

src, width, height, border, alt, style

video¹

autoplay, controls, height, loop, muted, poster, preload, width

audio¹

autoplay, controls, loop, muted, preload

source¹

media, src, type

span

style

table

width, height, cellpadding, cellspacing, border, style

div

style, align

font

size, color, style

figure

style

figcaption

style

dd, dl, dt

style

h1, h2, h3, h4, h5, h6

style

tr

height, valign, align, style

td, th

height, width, valign, align, colspan, rowspan, nowrap, style

p

style

b, strong, i, em, u, ul, ol, li, tbody, br, hr

abbr

title

sub

style

sup

style

¹Only supported in the Survey123 web app.

You can also 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.

Caution:

Dynamic labels are not supported in choice lists.

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 display read-only text in the form. 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.

You can add special note questions to customize elements of the form UI. These notes are named with the generated_note_ prefix, and fields are not created in the feature layer for these notes when the survey is published. For more information, see Customize form elements.

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.

Customize form elements

You can customize elements of the form UI using note questions with specific names. Elements that you can customize include the thank you screen, form title, and footer. The question names are as follows:

Question nameForm element

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

When customizing form elements, consider the following:

  • All of these elements are visible in the Survey123 web app, while only the form title is visible in the Survey123 field app.
  • You can provide translations for generated_note_ questions. For more information, see Translate form elements.
  • All of these notes support HTML content, except for generated_note_form_submit_text.
  • You can include values from the survey response in these notes using the ${question_name} syntax.
  • If a survey has a generated_note_form_title note question, the form_title on the settings sheet will be ignored.
  • If a survey has a generated_note_prompt_submitted note question, the thank you screen content set in the Survey123 web designer will be ignored.
  • Note questions with the generated_note_ prefix are not shown as notes in the form, and fields are not created in the feature layer for these questions when the survey is published.