01 — Vision and Scope

Vision

The Entity Platform Admin Console is a web interface for managing the Universal Entity Platform model.

A new application can start with an empty model, then an authorized administrator can define:

• what kinds of entities exist,
• which properties they have,
• how properties are grouped,
• which tags are available,
• which relationships are allowed,
• which templates create useful defaults,
• and which API and UI behavior should be available.

This allows the platform to support many applications without repeatedly building custom database tables, custom CRUD APIs, and custom forms for every concept.

What It Enables

The Admin Console should allow a developer or trained administrator to create a model like this:

Entity Types
├── Customer
├── Site
├── Building
├── Room
├── Asset
├── Credential
├── Connection Method
└── Tag

Property Groups
├── Device
├── Network
├── BACnet
├── Commissioning
└── Credentials

Relationship Types
├── depends_on
├── connects_to
├── uses_credential
├── managed_by
└── applies_to

Once published, the application can use the model to provide:

• type-aware entity creation,
• generated forms,
• validated property updates,
• consistent list/detail screens,
• generic entity CRUD endpoints,
• search/filter metadata,
• relationship editors,
• tag pickers,
• audit trails,
• and permission checks.

What It Is Not

It is not a generic low-code/no-code website builder.

The platform should not attempt to let non-developers build arbitrary application logic, page layouts, integrations, background jobs, or security-sensitive workflows in Alpha.

Application-level behavior still belongs in code:

• custom workflows,
• Vault reveal/copy logic,
• remote access sessions,
• external integrations,
• multi-step approval flows,
• advanced automation,
• dangerous bulk operations,
• and tenant encryption policy.

Target Users

Platform Developer

Builds and maintains the Admin Console, generic entity API, and metadata system.

Application Developer

Uses the platform to configure entity models and build application-specific workflows.

System Administrator

May manage safe runtime configuration such as tags, property definitions, templates, and views if allowed.

Stakeholder / Manager

Needs visibility into what the system can model and how the configuration evolves.

Success Criteria

The Admin Console succeeds when:

1. A new app can start with an empty or minimal entity model.
2. Developers can add entity types without database migrations.
3. Developers can define property groups and properties through the UI.
4. Developers can define allowed relationship types through the UI.
5. Runtime data stays valid when metadata changes.
6. Dangerous changes require validation, review, and publishing.
7. The frontend can consume metadata to build consistent forms and screens.
8. The backend can expose scalable, type-aware generic CRUD APIs.
9. All changes are auditable.
10. The system remains understandable and maintainable by a small team.