Skip to main content

Entity CRUD Portal

The Portal is an auto-generated web application that lets you interact with your deployed backend through a full CRUD interface. Unlike the Management Console (which focuses on monitoring, audit logs, and API testing), the Portal gives you a complete data management experience — browse records, create and edit data, execute Tools, and manage Entity lifecycles.

Everything in the Portal is derived from your specs. When you add a new Entity or Tool, the Portal automatically reflects it — no manual UI work required.

tip

Access the Portal at portal.fascia.run after logging in with your Fascia admin account. To give your end users access, see End-User Authentication.

Dashboard​

The Dashboard is your landing page after login. It provides a quick overview of your workspace:

Entity Cards​

Each Entity in your workspace appears as a card showing:

  • Entity name and description
  • Record count — how many records currently exist

Click any card to jump directly to that Entity's record list.

Recent Activity​

A timeline of the latest operations across your workspace:

  • Operation type (create, update, delete, transition)
  • Which Entity and record were affected
  • Whether the operation succeeded or failed
  • Timestamp

This gives you an at-a-glance view of what's happening in your system without digging into the full audit log.

Entity List​

Select any Entity from the sidebar to see all its records in a table view.

Table Features​

  • Columns are auto-generated from your Entity's field definitions
  • Sort by clicking any column header (toggles ascending/descending)
  • Filter by status using the dropdown above the table — useful for finding records in a specific lifecycle stage (e.g., only confirmed reservations)
  • Pagination at the bottom lets you navigate through large datasets and adjust page size

Field Rendering​

Fields are displayed based on their type:

  • Dates are formatted for readability
  • Enum values appear as colored badges
  • Booleans show as Yes/No
  • References to other Entities display the referenced record's identifier
  • JSON fields show a compact preview

Click any row to open the record's detail page.

Creating & Editing Records​

Auto-Generated Forms​

When you click New (from the Entity list) or Edit (from a record detail page), the Portal generates a form based on your Entity spec. Each field type gets an appropriate input control:

Field TypeInput Control
stringText input
numberNumber input
booleanToggle switch (Yes/No)
dateDate picker
datetimeDate and time picker
enumDropdown with defined options
jsonTextarea for JSON input
uuidMonospace text input
referenceLookup search (see below)

Reference Lookups​

When a field references another Entity (a foreign key), the Portal shows a search-as-you-type lookup instead of a plain text input. Start typing to search for matching records, then select from the dropdown. The selected reference displays as a label that you can clear to choose a different record.

Validation​

Forms enforce validation rules from your Entity spec:

  • Required fields are marked and checked on submit
  • Type-specific validation (e.g., valid dates, numeric ranges)
  • Error messages appear below each field

After submitting, a success notification confirms the operation, or an error message explains what went wrong.

Record Detail​

Click any record to see its full detail view.

Fields​

All field values are displayed in a read-only format. An Edit button in the header takes you to the edit form.

Status & Transitions​

If your Entity has a status machine, the current status appears as a colored badge. Below it, you'll see transition buttons for each valid next state.

For example, a Reservation in pending status might show buttons for confirm and cancel. Destructive transitions (cancel, fail, delete) are highlighted in red.

info

Clicking a transition button opens a confirmation dialog before executing. This prevents accidental state changes.

Entity-Action Buttons​

If you've created Tools that operate on a specific Entity type (like "Send Invoice" for an Order), they appear as action buttons on the detail page. Clicking one takes you to the Tool's execution form with the current record pre-selected.

Relationship Tabs​

When an Entity has hasMany relationships (e.g., a Customer has many Orders), the detail page shows tabs for each relationship.

Each tab displays:

  • A preview table with the first few fields of related records
  • Status badges for each related record
  • Creation timestamps

Click any row to navigate to that related record's detail page. Use the View All link to see the full filtered list.

Tool Execution​

Tool List​

The Tools section in the sidebar shows all deployed Tools in your workspace. Each Tool appears as a card with:

  • Tool name and description
  • Trigger type badge (HTTP, Cron, Webhook, or Queue)

Executing a Tool​

Click a Tool to open its execution form:

  1. Fill in the input fields — generated from the Tool's input schema, using the same field types as Entity forms
  2. Click Execute — sends the request to your deployed backend
  3. View the result — the response appears as formatted JSON below the form

If the Tool was triggered from an Entity-Action button, the relevant Entity ID is pre-filled automatically.

Portal vs Management Console​

FeaturePortalManagement Console
Browse & search recordsYesYes
Create & edit recordsYesNo
Status transitionsYesNo
Execute ToolsYesNo (API Test only)
Audit log viewerNoYes
System monitoringNoYes
API test consoleNoYes

Use the Portal for day-to-day data management and Tool execution. Use the Management Console for monitoring, debugging, and audit compliance.

Next Steps​