Adding Custom Fields to a Datastore

This article walks through adding a new custom field, configuring its options and seeing it appear in forms and views.

Step-by-Step

1. Open Architect Panel → Datastores → (your datastore) → Fields.
2. Click Add Field.
3. Pick the field type (see the field types reference for guidance).
4. Configure basic properties:
   • Label — what users see.
   • Internal key — used in code/API (auto-suggested from label).
   • Help text — short explanation shown beneath the field.
   • Placeholder — greyed-out example text.
5. Validation rules:
   • Required / optional.
   • Min/max for numbers and dates.
   • Regex pattern for text.
   • Custom validation function.
6. Advanced options:
   • Indexed (for fast searching/filtering).
   • Encrypted (for sensitive data).
   • Default value when a row is created.
   • Visibility per layout / per group.
7. Save. The field is immediately available throughout the platform.

What Happens Behind the Scenes

• A new column is added to the datastore's table.
• Existing rows get the default value (or NULL if no default).
• Forms, browse views and API responses pick up the field automatically.
• Search index updated if the field is marked searchable.

Worked Examples

• Customer industry: Dropdown field, options pulled from a master list, indexed for filtering, default “Unknown”.
• NPS score: Number field, min 0, max 10, indexed for reporting.
• Sensitive notes: Text area, encrypted at rest, visible only to admin group.
• Computed renewal date: Formula field — subscription_start_date + INTERVAL 1 YEAR.
• Linked account manager: Linked record to Users datastore, filtered to users in “Sales” group.