Skip to main content
← All capabilities
Available now

Platform capability · Generated Settings Screens

Describe your settings and get a working settings screen

The platform builds the admin screen from your list of settings

An app describes its settings, and the platform builds the admin screen for them. Settings are arranged in tabs, sections and groups. Each field has a type, a label, validation, a default value and the levels it can be set at. The operator console shows the editor, works out the value that applies at each level, hides secret values and shows or hides fields depending on other fields.

Built in

What you get

  • Settings are declared in tabs, sections, groups and fields, with no screen code to write
  • At least 19 field types: schedule, duration, business hours, colour, phone, locale, time zone, currency, country, URL, email, image, OAuth credentials, SMTP, webhook, secret and more
  • A field can be shown or hidden depending on the value of another field
  • Each field says where it can be set: platform, region, organization, app instance, user or operator
  • The value that applies is the most specific one that is set. An empty level takes the value from the wider one
  • Secret fields are hidden in admin views and left out of public views
  • A group of settings is saved and checked as a whole
  • Choice lists can be fixed or loaded from an API
  • Validation and default values are defined once with the setting and apply on every screen
  • Every published app gets its settings screens in the operator console this way
Under the hood

How it works

Settings screens are built from the declaration

Every app collects dozens of settings, and every settings screen is the same hand-built form: the same validation, the same hidden secrets, the same rule that one field shows only when a switch is on. With the platform you declare the settings. The platform shows the editor, enforces the types, hides the secrets and works out the right value for the level you are editing.

Field types and validation

Real settings are more than text and numbers. They include schedules, durations, business hours, OAuth client credentials, SMTP connections, webhook addresses, colours, locales and time zones. Each type has its own input with its own validation. An operator edits a schedule with a schedule picker and a secret with a hidden field, which avoids typing mistakes in a plain text box.

One setting, several levels

A setting can be defined for the whole platform and overridden for an organization, an app instance, a member or an operator. The screen shows the value that applies and which level it came from. An empty level takes the value from the wider one. Product code reads the final value and does not deal with the levels.

Want a deeper walkthrough of Generated Settings Screens?

A solution architect will demo the live service against your domain model.

Get a deployment assessment