Skip to main content

Building Form Sections

This guide explains how to add and configure form sections and fields. Sections define the input elements users see when initiating or editing a form submission. The example workflow builds a form with Reference and Full Name fields for the sumo-user-guide form.


Adding a Section

  1. On the form configuration page (New Form → Add Section), scroll to the bottom.
  2. Click + Add Section.
  3. A new section card appears labeled 1. Section (numbered sequentially for additional sections).

Each section card has a Delete icon (red trash) in the top-right corner to remove the section.


Section Metadata

Configure the top fields on the section card:

FieldDescriptionExample
Section NameInternal slug for the section. Must follow slug naming rules (lowercase, no spaces).full or reference
Section OrderDisplay sequence of this section on the form.1
PriorityProcessing priority for the section.1
Weight (%)Layout weight relative to other sections.10
Schema TypeBroad category of the form element.INPUT
Field TypeSpecific data type of the field.STRING

Important: Section names must be valid slugs. Names with spaces or uppercase letters trigger a validation error: Field validation for 'Name' failed on the 'slug' tag.


Defining Field Properties

Below the metadata fields, the Define Field Type area configures the user-facing field:

FieldDescriptionExample
Field LabelLabel displayed next to the input on the rendered form.Full Name
Field DescriptionHelper text or instructions shown below the label.Insert Customer BOID
Placeholder TextGhost text inside the input before the user types.Enter Customer Account Number
Default ValuePre-filled value when the form opens.(empty)
Map Input ParamMaps the field to a process input parameter or form schema field.Select from dropdown

Example: Full Name Field

SettingValue
Section Namefull
Section Order1
Schema TypeINPUT
Field TypeSTRING
Field LabelFull Name
Is Shown In ListChecked
Is RequiredUnchecked

Example: Reference Field

A second section can be added for a reference identifier:

SettingValue
Section Namereference
Field LabelReference
Schema TypeINPUT
Field TypeSTRING
Is Shown In ListChecked

When Is Shown In List is checked, the field appears as a column in the Form Usages table.


Field Behavior Flags

Four checkboxes control field behavior:

FlagDescription
Is Shown In ListWhen checked, displays this field as a column in the Form Usages submissions table.
Is DisabledWhen checked, renders the field as read-only on the form.
Is RequiredWhen checked, the user must fill in the field before saving.
Is From SumoWhen checked, populates the field from Sumo Ledger system data.

Saving a Section

  1. Review all section metadata, field properties, and behavior flags.
  2. Click Save (floppy disk icon) at the bottom-right of the section card.
  3. Repeat for each additional section using + Add Section.

After all sections are saved, the form is ready for preview and testing.


Adding Multiple Sections

Forms commonly contain several sections. For example, Initiate Loan Against Share includes:

SectionField LabelField Description
BOIDBOIDInsert Customer BOID
Account NumberAccount NumberEnter Customer Account Number

To build a multi-field form:

  1. Click + Add Section for each field group.
  2. Configure section name, schema type, field type, and label for each section.
  3. Set Section Order to control the display sequence (1, 2, 3, …).
  4. Save each section individually.

Testing the Completed Form

  1. Save all sections and configuration blocks.
  2. Open the form preview or navigate to the Form List.
  3. Click + on the form row to initiate a test submission.
  4. Verify that:
    • All fields render with correct labels and placeholders.
    • Is Required fields block save when empty.
    • Is Shown In List fields appear as columns in Form Usages.
    • Clicking Save triggers the linked process stage successfully.

See Using Forms for the full end-user submission and approval procedure.


Common Schema and Field Types

Schema TypeField TypeUse Case
INPUTSTRINGText fields (names, references, account numbers)
INPUT(other types)Numeric, date, or specialized input fields

Additional schema types and field types may be available depending on your environment configuration.


Troubleshooting

IssueLikely CauseResolution
Field validation for 'Name' failed on the 'slug' tagSection name contains spaces or uppercase charactersRename the section using lowercase slug format (for example, full_name instead of Full Name)
Stage [name] Not AllowedProcess stage not permitted for the current user roleVerify process mapping and role assignments in Configuring Forms
Field not visible in Form Usages tableIs Shown In List is uncheckedEnable the flag and save the section
Form saves but process failsField mapping incompleteMap all required process parameters in the process configuration block