Skip to content
ReferenceForDeveloper⏱ About 10 min

App Builder reference ​

App Builder's tabs: Database catalog, Registered tables, App views, Queries, Workflows, Tenant API, Link canvas (a map of views and workflow links), and Access (platform staff: who may build).

Tables ​

Nameapp_t<organization id>_<code>; the code is lower-cased, other characters become _, at most 48 characters
Added columnsid (auto number), created_at, updated_at
Column typesstring (255), int, decimal (18,4), date, datetime, text, bool
Valuesint, decimal and date (YYYY-MM-DD) are checked; bool accepts 1, true, yes, on, y; an empty value is stored as empty (NULL)
Existing tablesDatabase catalog → Import registers one of the organization's own tables without copying it

Tables can't be renamed or given new columns after they're made; make a new table and move the data with a workflow or query.

Views ​

TypeWhat people see at /app/<code>
Page (visual builder)your widgets on a 12-column grid
Grida table of the primary table's rows, with Add row for people who may write
Form, Dashboard, Workflow steptoday these show like a Grid

A view has a Primary table, optional Attached tables (lookups) and Link to other views. Publish to nav creates a menu item and adds it to the organization's pool.

Page designer ​

Edit / Preview, undo and redo, Templates, Save as component, Save page. Widgets sit on a grid (Col, Row, Width, Height).

GroupWidgets
ContentHeading, Text, Rich text, Markdown, Image, Icon, Badge / chip, Alert, Quote, List
DataStat card, KPI row, Data grid, Mini table, Form, Record detail, Search box, Filter bar, Chart
ActionButton / link, Button group, Link card, Nav list, Tabs
LayoutDivider, Spacer, Card frame, Panel, Two columns, Hero banner, Embed / iframe, Custom HTML

Data widgets take a Data table or a Named query, a page size and row limit. Templates: Blank, Dashboard, List + form, Form page, Landing / hero, Report. Applying a template replaces the page.

HTML and Markdown are cleaned before they show. Embeds show only this BMA's pages unless the organization's builder.iframe_hosts setting lists other https hosts.

Row permissions ​

A view can name permission keys for read, create, update and delete of its table's rows (config.access). With none set, people who can see the view can read, and only people with build access can write. With any set, read is required, everyone (builders too) needs the matching key, and raw SQL can no longer read that table. Set them under Row access in the New view dialog (Read permission, Create permission, Update permission, Delete permission; the lists show the registered <module>.<action> keys), through the API or in a package. An invalid set, such as one without a read key, shows its message in the dialog (invalid_access). Grant the keys to groups in Groups & RBAC.

Named queries ​

TypeDoes
SQL SELECTone SELECT on the organization's builder tables
HTTP / APIcalls a URL (GET, POST, PUT, PATCH, DELETE) with headers and a body
Builder table readreads rows of a table (search, limit)
Builder table writeinserts or updates a row from the input

Usable from app pages lets page widgets run it. {{input.name}} takes a value from the caller.

SQL rules ​

  • One statement, starting with SELECT or WITH.
  • No writes, schema changes, INTO, PRAGMA, SLEEP and similar, no comments, no ? or :name placeholders: use {{input.name}}, which is always bound as a value.
  • Only the organization's own builder tables (app_t<id>_…).
  • A LIMIT is added: 100 by default, 500 at most.

Workflows ​

The visual editor (Visual editor on a workflow card) has nodes:

NodeDoes
Condition (if/else)vars.status == complete, input.amount > 0, empty(vars.x), not empty(x); then a true and a false branch
Open viewends by sending the user to a view or route
HTTP / API callcalls a URL; Save response as variable
SQL query (SELECT)runs a query under the SQL rules; Save rows as variable
Table queryreads a builder table
Set variable, Log, End

Text fields take {{vars.x}} and {{input.x}}. A run stops after 100 steps. HTTP calls reach public addresses only, with a timeout (30 seconds by default). Run shows the log of the last run.

TriggerFires
manualRun in the editor
apiPOST /api/index.php/builder/workflows/trigger/<code> by a signed-in user (the Tenant API can't start workflows yet)
schedulefrom a Platform cron job of type internal action workflow
db_insertafter a row is added to a builder table (the table's grid, a form, POST /builder/tables/<id>/rows)
db_updateafter a row of a builder table is changed (PATCH or PUT /builder/tables/<id>/rows/<row>)

A db_insert or db_update trigger can name a table (its code) in the box next to it; empty means every table. The run gets the change as input: {{input.table}}, {{input.id}} and the row's fields, such as {{input.row.borrower}} for a borrower column. It runs after the row is saved, so a failing workflow never undoes the change (see its run log). Row writes made by a workflow that a write started don't start further workflows, so workflows can't loop.

Older graphs may still carry an http_response trigger. It never fired and is no longer offered: the editor marks it with a warning, and the graph still saves until you remove it.

Packaging ​

To move an app to another organization or install, make it a builder module: module.json with kind: "builder" plus its pages as JSON (pages/*.json). Builder modules carry no code and may be unsigned. See Modules; start from php bin/console module:new <id> --kind=builder.