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
- On the form configuration page (New Form → Add Section), scroll to the bottom.
- Click + Add Section.
- 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:
| Field | Description | Example |
|---|---|---|
| Section Name | Internal slug for the section. Must follow slug naming rules (lowercase, no spaces). | full or reference |
| Section Order | Display sequence of this section on the form. | 1 |
| Priority | Processing priority for the section. | 1 |
| Weight (%) | Layout weight relative to other sections. | 10 |
| Schema Type | Broad category of the form element. | INPUT |
| Field Type | Specific 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:
| Field | Description | Example |
|---|---|---|
| Field Label | Label displayed next to the input on the rendered form. | Full Name |
| Field Description | Helper text or instructions shown below the label. | Insert Customer BOID |
| Placeholder Text | Ghost text inside the input before the user types. | Enter Customer Account Number |
| Default Value | Pre-filled value when the form opens. | (empty) |
| Map Input Param | Maps the field to a process input parameter or form schema field. | Select from dropdown |
Example: Full Name Field
| Setting | Value |
|---|---|
| Section Name | full |
| Section Order | 1 |
| Schema Type | INPUT |
| Field Type | STRING |
| Field Label | Full Name |
| Is Shown In List | Checked |
| Is Required | Unchecked |
Example: Reference Field
A second section can be added for a reference identifier:
| Setting | Value |
|---|---|
| Section Name | reference |
| Field Label | Reference |
| Schema Type | INPUT |
| Field Type | STRING |
| Is Shown In List | Checked |
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:
| Flag | Description |
|---|---|
| Is Shown In List | When checked, displays this field as a column in the Form Usages submissions table. |
| Is Disabled | When checked, renders the field as read-only on the form. |
| Is Required | When checked, the user must fill in the field before saving. |
| Is From Sumo | When checked, populates the field from Sumo Ledger system data. |
Saving a Section
- Review all section metadata, field properties, and behavior flags.
- Click Save (floppy disk icon) at the bottom-right of the section card.
- 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:
| Section | Field Label | Field Description |
|---|---|---|
| BOID | BOID | Insert Customer BOID |
| Account Number | Account Number | Enter Customer Account Number |
To build a multi-field form:
- Click + Add Section for each field group.
- Configure section name, schema type, field type, and label for each section.
- Set Section Order to control the display sequence (1, 2, 3, …).
- Save each section individually.
Testing the Completed Form
- Save all sections and configuration blocks.
- Open the form preview or navigate to the Form List.
- Click + on the form row to initiate a test submission.
- 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 Type | Field Type | Use Case |
|---|---|---|
| INPUT | STRING | Text 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
| Issue | Likely Cause | Resolution |
|---|---|---|
| Field validation for 'Name' failed on the 'slug' tag | Section name contains spaces or uppercase characters | Rename the section using lowercase slug format (for example, full_name instead of Full Name) |
| Stage [name] Not Allowed | Process stage not permitted for the current user role | Verify process mapping and role assignments in Configuring Forms |
| Field not visible in Form Usages table | Is Shown In List is unchecked | Enable the flag and save the section |
| Form saves but process fails | Field mapping incomplete | Map all required process parameters in the process configuration block |