Skip to main content

Advanced Form Builder (AFB): Form Object Types & Attributes

Emily Yeomans

The Advanced Form Builder (AFB) supports a similar range of form object types found in the Simplified Form Builder to help customize forms for your organization.

This article will cover:

Before Getting Started

Important: Some features that are visible in the AFB are not supported in Sponsored Projects and should not be used when building forms, as they will cause errors. See below for specific details about each feature prior to using the AFB.

It may be useful to review the following article for reference:

Choosing a Form Object Type

Within the Shape repository panel, locate the desired object and drag and drop it onto the form canvas.

When making changes or updates, be sure to save your work by clicking on Save Draft.

2021-06-18_11-42-32.png

Understanding Form Object Types

Below is a brief description of each object type and its use within the AFB. 

Please note: Object types marked with an asterisk are not supported and should not be used in the form. If used as they will cause errors.

Data Entry Section

  • Text: Stores short free-response answers with no formatting
  • Number: Stores whole number values
  • Decimal: Stores numeric values, including non-whole numbers; allows configuration of decimal places
  • Date: Stores date values; includes a built-in calendar widget for selection
  • Multiline Text: Stores longer free-response answers with no formatting
  • Rich Text: Stores longer responses with formatting and hyperlink support
  • Attachment: Stores external files
  • Text List: Stores list of text strings, which can be pre-configured or free-response.

Selection Section

  • Radio Buttons: Stores static multiple-choice options where only one option can be selected
  • Checkbox: Stores a selected (true) or unselected (false) state
  • Drop Down (Single): Stores static multiple-choice options where only one option can be selected
  • Drop Down (Multiple): Stores static multiple-choice options where multiple options can be selected
  • Expression Field: Stores the result of a defined expression
  • Org Finder: Searches for and stores an external organization from the Admin module
  • Person Finder: Searches for and stores a person from the Admin module
  • Unit Finder: Searches for and stores a unit from the Admin module
  • Research Team: Searches for and stores people from the Admin module who are part of the record’s research team; can also define attributes like role, internal association, credit, and effort
  • AU NZ Classification Codes: Searches for and stores Australian/New Zealand classification codes. Can be configured for:
    • Field of Research (FoR)
    • Socio-Economic Objective (SEO)
    • Type of Activity (TOA)
    • Higher Education Research Data Collection (HERDC)
  • Funding Program: Stores funding program and funding round data for external organizations from the Admin module
  • Summary Budget Importer: Stores high-level budget category values: Total Direct Costs, F&A, Total Sponsor Costs, Internal Cost Share, External Cost Share, Total Cost Share, and Total Project Cost. Supports manual entry or values supplied by Budget Builder. Learn more about Budget Builder
  • SP-S2S Integration: Supports linking an SP record to a Proposals (S2S) record—either by searching for an existing record or initiating a new one
  • Human Ethics Study Search: Supports searching for and linking Human Ethics studies to the SP record by PI, Study Number, or Title
  • *Animal Oversight Protocol Search: Not supported at this time
  • *Hazard Safety Protocol Search: Not supported at this time
  • Costing Tool Search: Displays Costing records linked to the SP record
  • Ethics Monitor Search: Displays Ethics Monitor records linked to the SP record
  • Repository Search: Displays Repository records linked to the SP record
  • Outside Interests Disclosure Search: Displays summary data for research-based disclosures linked to the SP record, including:
    • Researcher’s name
    • Researcher’s role
    • Disclosure name
    • Disclosure status
    • Disclosure resolution

Display Section

  • Information: Adds static text to a form section to help clarify what users need to provide. Supports text formatting and hyperlinks.

Section Section

  • Container: Adds a container to the form canvas that can hold a form. Use this only when starting from scratch, as default forms already include a container, so adding another is usually unnecessary.
  • Section: Adds a new form section along the top header in the form builder. Once added, can define the label, and the visible/enabled conditions.
  • *Subform: Not supported at this time

Configuring Form Object Attributes

After an object has been dragged and dropped onto the form canvas, the attributes need to be populated within the right-hand panel.

To save all updates after populating attributes, click on Save Draft.

2021-06-18_11-42-32.png

Learn more about the attributes for each object type below.

Previewing and Publishing Forms

Follow the steps in the linked article to preview a form. When ready, refer to this article for guidance on publishing forms.

Common Attributes (Required)

The following attributes must be defined for every object type unless otherwise noted below.

General Section

  • ID: A unique identifier that maps to the answerKey attribute in all public API endpoints. Use lowercase letters and separate words with hyphens. For specific required ID values per object type, see this guide.
  • Label: The text displayed on the record.
  • Short Label: A dropdown with a set of fixed unique identifiers for specific objects. If the object does not match any preset option, select Other.
  • Please Specify Short Label: Displayed when Short Label is set to Other. Together, these act as another unique identifier that maps to column headers in dashboards and in-app reports. Use a human-readable format aligned with your institution’s style. Refer to the same guide for specific values required for certain form objects.
  • Value: Another unique identifier used by Report Connector to map data and by the form builder in conditional expressions. It should clearly represent the field’s meaning and cannot begin with a number.

Common Attributes (Not Required)

The following attributes are available for most object types. While not required, they help enhance form configuration options.

General Section

  • Label Position: Specifies where the label is displayed relative to other components of the object.
  • Placeholder: Text shown inside the field when unanswered, helping to guide what should be entered.
  • Label Tooltip: When provided, this text appears when hovering over the icon next to the label.
  • Default Value: Pre-fills the form object with this answer until a user manually changes it.
  • Description: Text displayed below the field to explain its purpose or how to fill it out.
  • Ignored: When set to true, hides the object from view, removes the field from the record payload, and clears any previously entered answer. When false, the object is visible, included in the payload, and stores answers. Accepts boolean values or conditional expressions.
  • Visible: When false, hides the object from display but continues to store any entered answers in the record payload. When true, the object is shown and included in the payload. Accepts boolean values or conditional expressions.
  • Enabled: When false, disables the object but retains any previously entered answers in the record payload. When true, the object is enabled and included in the payload. Accepts boolean values or conditional expressions.

Details Section

  • Provides unique attributes specific to each object type. See below for additional details.

Validation Section

  • Required: When set to true, this object must be answered before the routing process can begin. When set to false, it can remain unanswered.
  • Custom Validations: Enables conditional expressions that, when true, trigger the display of a configured message.
  • *Validation Panel Display: Not supported at this time

Error Message Section

Some object types also include preset validation attributes—see below for details.

Documentation Section

This field provides a place to add notes about the set up of this specific form object.

Customization Section 

*Style class: Not supported at this time

Attributes for Each Object Type

Expand a file below to see attribute details specific to each object type.

  • Common Attributes (from the previous section) apply to all object types, except where noted under Common Attribute Exceptions.

  • Unique Attributes include additional attributes specific to each object type.

  • Attributes marked with an asterisk (*) are visible but not supported by Sponsored Projects and should not be populated on form objects.

Text

Unique Attributes

  • Validation section 1
    • Minimum length: Minimum number of characters required for the answer
    • Maximum length: Maximum number of characters allowed for the answer
    • Validation regex: Pattern that answers must match. Contact support or your implementation specialist to learn more.
    • Validation mask: Allowed format that prevents entry of invalid values. Contact support or your implementation specialist to learn more.
  • Error Messages section
    • Minimum length: Message shown if the answer is shorter than the minimum required length
    • Maximum length: Message shown if the answer exceeds the maximum allowed length
    • Validation regex: Message shown if the answer does not match the required pattern
    • Validation mask: Message shown if the answer does not conform to the specified format

Common Attribute Exceptions

  • None

Number

Unique Attributes

  • Details section
    • Format: Format for the thousands separator

      • Available options:

        • No format: Adds no thousands separator
        • Auto: Defaults to using a comma as the thousands separator
  • Validation section 1
    • Minimum: Defines minimum allowable answer
    • Maximum: Defines maximum allowable answer
  • Error Messages
    • Minimum: Message shown if answer is less than minimum value
    • Maximum: Message shown if answer is greater than maximum value

Common Attribute Exceptions

  • None

Decimal

Unique Attributes

  • Details section
    • Fraction size: Defines the maximum number of decimal places.
      • Note: SP sets Fixed fraction size to true in all cases, so decimals are padded with 0 until the fraction size is reached.
      • Example: Fraction size = 2 → entering 12.3 stores and displays 12.30.
    • Format: Format for thousands and decimal separator

      • Available options:

        • No format: Adds no thousands separator
        • Auto: Defaults to using a comma as the thousands separator
  • Validation section 1
    • Minimum: Defines minimum allowable answer
    • Maximum: Defines maximum allowable answer
  • Error Messages section
    • Minimum: Message shown if answer is less than minimum value
    • Maximum: Message shown if answer is greater than maximum value

Common Attribute Exceptions

  • None

Date

Unique Attributes

  • Details section
    • Enable time: When selected, allows entering a date and time value.
      • Note: Due to limitations, if a date-time field is on the form and another field’s ignore status changes to true, the date answer gets cleared.
    • Time interval: Defines minute interval available when Enable time is selected. Options: 1, 5, 10, 20, 30.
    • Calendar start day: Day of the week in the left-most position on the calendar widget (0 = Sunday, 1 = Monday … 6 = Saturday).
  • Validation section 1
    • Minimum date: Defines earliest allowable date (absolute or relative to current date)
    • Maximum date: Defines latest allowable date (absolute or relative to current date)
  • Error Messages section
    • Minimum date: Message shown if answer is before minimum date
    • Maximum date: Message shown if answer is after maximum date

Common Attribute Exceptions

  • None

Multiline text

Unique Attributes

  • Details section
    • Maximum rows: Defines maximum number of rows before a scroll bar is added
    • Minimum rows: Defines the default number of rows displayed
  • Validation section 1
    • Minimum length: Defines the minimum character limit for the answer
    • Maximum length: Defines the maximum character limit for the answer
  • Error Messages section
    • Minimum length: Message shown if the answer is less than the minimum length
    • Maximum length: Message shown if the answer is greater than the maximum length

Common Attribute Exceptions

  • None

Rich text

Unique Attributes

  • General Section
    • *Text format: Not supported at this time
    • Minimum rows: Defines minimum rows displayed; object expands as more rows are used.
    • *Use spell checker: Not supported at this time
  • Validation section 1
    • Minimum length: Defines the minimum character limit for the answer
    • Maximum length: Defines the maximum character limit for the answer
  • Error Messages section
    • Minimum length: Message shown if the answer is less than the minimum length
    • Maximum length: Message shown if the answer is greater than the maximum length

Common Attribute Exceptions

  • None

Attachment

Unique Attributes

  • Details section
    • *Upload URL: Not supported at this time
    • *Update file URL: Not supported at this time
    • *Delete URL: Not supported at this time
    • Allow file deletions:
      • New Only: Allows deleting a file after initial upload, but not after the page is changed or reloaded
      • Yes: Allows deleting a file at any point while the record is editable
      • No: Does not allow deleting the file at any point
  • Preview type:
    • None: Shows file name only
    • Icon: Displays icon based on file extension plus file name
    • *Thumbnail: Not supported at this time
  • *Thumbnail maximum height: Not supported at this time
  • *Allowed files text: Not supported at this time
  • Drop files text: Text shown while files are hovered (default: “Dropping <X> files…”)
  • Max. files reached text: Text shown when max files has been reached
  • Select files text: Instruction text shown; default is “Drag and drop new files or click to select from file system…” if blank
  • *Has content model: Not supported at this time
  • Validation section 1
    • Minimum attachments: Defines minimum number of attachments allowed
    • Maximum attachments: Defines maximum number of attachments allowed (prevents adding more than this)
    • Valid file extensions: Comma-separated list of allowable file extensions
    • Note: The file modal is filtered by these extensions by default but can be overridden by manual upload or drag-and-drop.
  • Error Messages section
    • *Minimum attachments: Not supported at this time
    • *Maximum attachments: Not supported at this time

Common Attribute Exceptions

  • Default value: hidden and empty

Text list

Unique Attributes

  • Data source section
    • Data source: Static is the only supported option
    • Items: Ability to type in and order pre-configured options
    • *Navigation URL: Not supported at this time
    • *Target: Not supported at this time
  • Validation section1
    • Maximum elements: Maximum number of items that can be selected
    • Minimum elements: Minimum number of items that must be selected
  • Error Messages section
    • Minimum items: Message shown if fewer than the minimum are selected
    • Maximum items: Message shown if more than the maximum are selected
    • Third party vendor bugs with these fields
      • Error message fields mapped to the wrong fields
        • If text is added to the “Minimum items error message” field, it will actually apply to the Maximum elements field value.
        • If text is added to the “Maximum items error message” field, it will apply to the Minimum elements field value.
    • Error message field values are not persisted
      • After saving and publishing values in these fields, if the form builder is opened again, the fields will be empty.
      • If you want custom message text, you must re-populate these fields each time a new form revision is saved and published.
  • Workarounds for the existing third party vendor bugs
    • Both issues above can be avoided if the “Minimum items error message” field and “Maximum items error message” field are left blank. In this case, a default message is displayed when the Minimum elements or Maximum elements conditions are not met.
    • Default message text
      • Minimum: “You need to add a minimum of <X> items”
        • Where <X> is the value set in the Minimum elements field
      • Maximum: “The number of items that can be added is <Y>”
        • Where <Y> is the value set in the Maximum elements field

Common Attribute Exceptions

  • None

Radio buttons

Unique Attributes

  • Data Source section
    • Data source: Static is the only supported option
  • Details section
    • Items: Select the grid icon to open the modal to define and order static options
    • Orientation: Choose vertical or horizontal (defaults to vertical)
    • Text option: Text entered displays as last option; selecting it reveals a free-text entry field

Common Attribute Exceptions

  • None

Checkbox

Unique Attributes

  • None

Common Attribute Exceptions

  • None

Drop Down (single)

Unique Attributes

  • Details section
    • Items: Select the grid icon to open the modal to define and order static options
  • Autocomplete section
    • Enable autocomplete: When selected, the field allows typing to filter options
    • Input min. length: Number of characters required before results display (applies only when autocomplete is enabled)
  • Error Messages section
    • *Invalid selection: Not supported at this time

Common Attribute Exceptions

  • None

Drop Down (multiple)

Unique Attributes

  • Details section
    • Items: Select the grid icon to open the modal to define and order static options
  • Autocomplete section
    • Enable autocomplete: When selected, allows typing to filter options
    • Input min. length: Characters required before results display (applies only with autocomplete)
  • Validation section 1
    • Minimum elements: Minimum number of items that must be selected
    • Maximum elements: Maximum number of items that can be selected
  • Error Messages section
    • Minimum items: Message shown if fewer than minimum items selected
    • Maximum items: Message shown if more than maximum items selected
    • *Invalid selection: Not supported at this time

Common Attribute Exceptions

  • None

Expression field

Unique Attributes

  • General section
    • Expression: Defines the expression that sets the answer for this object. Refer to other objects by their value attribute. Supports mathematical expressions and conditions.
      • Conditional syntax example: {{ condition ? value_if_true : value_if_false }}
      • Example: If radio with value attribute radio1 has answers “Yes”, “No”, “N/A”, use {{ radio1 == 'Yes' ? 'Yes' : 'No' }} to return “Yes” only when radio1 equals “Yes”.
      • Reference the same syntax described in this article to set up a condition within an expression.
  • Details section
    • Decimal Value: Select if the expression result should be formatted as a decimal
    • Fraction size: Maximum number of decimals (Fixed fraction size true — decimals padded with 0 to reach fraction size)
    • Format: Format for thousands and decimal separator

      • Available options:

        • No format: Adds no thousands separator
        • Auto: Defaults to using a comma as the thousands separator

Common Attribute Exceptions

  • Default value: hidden and empty
  • Enabled: hidden and unselected (field is disabled by default)

Org Finder

Unique Attributes

  • Validation section 1
    • Minimum elements: Minimum number of items that need to be selected
    • Maximum elements: Maximum number of items that can be selected
  • Error Messages section
    • Minimum items: Message shown if fewer than the minimum are selected
    • Maximum items: Message shown if more than the maximum are selected
    • *Invalid selection: Not supported at this time

Common Attribute Exceptions

  • None

Person Finder

Unique Attributes

  • Validation section 1
    • Minimum elements: Minimum number of items that need to be selected
    • Maximum elements: Maximum number of items that can be selected
  • Error Messages section
    • Minimum items: Message shown if fewer than the minimum are selected
    • Maximum items: Message shown if more than the maximum are selected
    • *Invalid selection: Not supported at this time

Common Attribute Exceptions

  • None

Unit Finder

Unique Attributes

  • Validation section 1
    • Minimum elements: Minimum number of items that need to be selected
    • Maximum elements: Maximum number of items that can be selected
  • Error Messages section
    • Minimum items: Message shown if fewer than the minimum are selected
    • Maximum items: Message shown if more than the maximum are selected
    • *Invalid selection: Not supported at this time

Common Attribute Exceptions

  • None

Research Team

Unique Attributes

  • Details section
    • Allow External Researchers: If selected, shows an association radio for each member (internal or external). If not selected, only internal members allowed.
    • Allow creation of new external researchers: Only displayed if "Allow External Researchers" is enabled. When selected, allows both searching Admin and adding new researchers on the fly. If not selected, only existing Admin researchers can be added.
    • Display Credit Field: If selected, each internal team member will have the Credit field displayed.
    • Credit Field required: Shown only if the general Required setting and Display Credit Field are selected; makes Credit required for each team member.
    • Display Sponsored Effort: If selected, each internal team member will have Sponsored Effort fields displayed.
    • Sponsored Effort required: Shown only if general Required and Display Sponsored Effort are selected; makes Sponsored Effort required.
    • Display Cost Share Effort: If selected, Cost Share Effort fields are displayed.
    • Cost Share Effort required: Shown only if general Required and Display Cost Share selected; makes Cost Share required.
    • Default Effort Format: Can be set to either Percentage or Months (this defines the default display format; users can toggle on the record).
  • Validation section
    • Required: Controls whether the object is required. If selected, Name, Role, and Internal/External Association fields must be populated. If not selected, no fields in research team are required.

Common Attribute Exceptions

  • Default value: hidden and empty

AU NZ Classification Codes

Unique Attributes

  • Details section

    • Code Type: Select between FOR, SEO, TOA, HERDC — selection dictates which fields are displayed.

    • FOR Code fields:
      • Minimum Number of Codes (1): Define minimum number of codes required (valid range 1–99)
      • Maximum Number of Codes (99): Define maximum number of codes allowed (valid range 1–99)
      • Limit to four digit codes: When selected, only shows codes down to four-digit level; when unselected, shows to six-digit level.
      • Include Percentage: If displayed, percentages are required to equal 100%
    • SEO Code fields:
      • Minimum Number of Codes (1): Valid range 1–99
      • Maximum Number of Codes (99): Valid range 1–99
      • Limit to four digit codes: Option to limit to four-digit level
      • Include Percentage: If displayed, percentages must equal 100%
    • TOA Code fields:
      • Minimum Number of Codes (1): Valid range 1–4
      • Maximum Number of Codes (4): Valid range 1–4
      • Include Percentage: If displayed, percentages must equal 100%
    • HERDC Code fields:
      • Minimum Number of Codes (1): Valid range 1–26
      • Maximum Number of Codes (26): Valid range 1–26
      • Exclude subcategories from options: When selected, only category-level codes are shown
      • Include Percentage: If displayed, percentages must equal 100%

Common Attribute Exceptions

  • Default value: hidden and empty

Funding Program

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Summary Budget Importer

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

SP-S2S Integration

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Human Ethics Study Search

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Costing Tool Search

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Ethics Monitor Search

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Repository Search

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Outside Interests Disclosure Search

Unique Attributes

  • None

Common Attribute Exceptions

  • Default value: hidden and empty

Information

Unique Attributes

  • None

Common Attribute Exceptions

  • Label: not required
  • Short label: not required
  • Value: Used to contain the displayed text (not just a unique identifier)
  • Placeholder: hidden and empty
  • Tooltip: hidden and empty
  • Required: hidden and unselected

Container

Unique Attributes

  • None

Common Attribute Exceptions

  • ID: Do not modify from the default value
  • Label: hidden and empty
  • Short label: not required
  • Ignored: hidden and unselected

Section

Unique Attributes

Validation Section

  • *Server validation URL: Not supported at this time
  • *Server validation result path: Not supported at this time
  • *Result message: Not supported at this time
  • *Server validation method: Not supported at this time

Common Attribute Exceptions

  • ID: Do not modify from the default value
  • Short label: not required
  • Ignored: hidden and unselected
  • *Label tooltip: Not supported at this time

1 Values outside of the minimum - maximum range can still be entered and saved for the object types that have these attributes, but the relevant error messages will be displayed in that case. ↩

Related to

Related articles