Skip to content

Add a button to a form

How-to8 minPractitioner

Before you start

A Button lets people do something from the formFormThe set of blocks and components people fill in for a module.Open glossary ↗ itself: pick related records, open another form, scan a barcode. Each button has an action, a label and, when it feeds a Table, an event name. This page configures one.

  1. In the Form builder, open the Components tab and drag Button into a block.
  2. Click the cog icon on the button card. The Button Configuration panel opens on the right.
  3. Fill in the three parts described below.
  4. Click Done, then Save on the form.

The card previews the button with its label. A Button takes one column in a 2 col block.

Basic Information

SettingWhat it does
Button LabelThe text on the button. Give every button a label
Button PositionControls the order when there are several buttons
Click Event NameA name other components listen to. Use letters, numbers and underscores

Button Display

SettingWhat it does
Styling (CSS)CSS that changes how the button looks
Disabled IfA Smart Script that evaluates to true when the button should be disabled
Enable role-based disabilityOnly the roles you choose under Permitted Roles can use the button
Enable conditional visibilityReveals Visible If, a Smart Script that is true when the button should show
Enable role-based visibilityOnly the roles you choose see the button

Action Type offers five actions in the Form builder.

Action TypeWhat a click does
Get DataOpens a pop-up list of records from a module. The records people tick go to a Table
Dynamic FormOpens another module’s form in a pop-up
Data EntrySends a signal that makes a Table add a row. It needs no other setting
Barcode ScannerOpens a scanner and writes the result into fields
Render PageOpens a custom page in a dialog, rendered against the current record

Every action also needs the Click Event Name if a Table is to react to it.

Get Data. Module to Load Data From, Records per Page, and a Filter Clause. The clause is evaluated against the current record, and its final condition must start with WHERE. Add Sorting Rules with + Add Rule: a Field and a Sort Direction of Ascending or Descending.

Dynamic Form. Module to Show Form For, then:

  • Redirect to record on form save
  • Allow only a single submission for this form
  • Open in edit mode if a submission is found
  • Submission Checking Field, the field used to look for an earlier submission

Under URL Parameters, + Add Parameter fills the opened form: Target form field to fill and Source field / value. Tick Set value manually to type a fixed value instead of choosing a field.

Barcode Scanner. Module to Load Data From, Target Barcode Field, Target View Field and Target Image Field.

Render Page. Page to Render. The page is bound to this module.

  • Give each button a Click Event Name. A Table lists buttons by that name under Add a way.
  • To start a workflow from a record, add an action to its Smart view.

Check yourself

Karim wants a button that opens a pop-up list of vendors, and the ticked vendors should become rows in a Table. Which Action Type does he choose?
Show the answer

Get Data. Get Data loads records from a module into a pop-up. The Table lists the button under Add a way as Picks records.

What can the Click Event Name contain?
Show the answer

Use letters, numbers and underscores. The field's hint says alphanumeric and underscores only, no spaces.

What's next

Last checked