Skip to content
omnismith docs

Create and Edit Entities

An Entity represents an active data record instantiated from a specific Template (e.g. a specific server prod-app-01, a customer ACME Corp, or a ticket #104).

1. Creating an Entity in the UI

Section titled “1. Creating an Entity in the UI”
  1. Navigate to Entity Operations → Entities via the navigation launcher.
  2. Select your target template from the Template Gateway (e.g. Server Node).
  3. Click + Create Entity.
  4. The dynamic entry form renders all attached attributes:
    • Dimensions: Text fields, dates, flags, and dropdown selection lists.
    • Metrics: Initial numeric values (e.g. Initial CPU % or Balance).
    • References: Searchable dropdowns pointing to target entities.
  5. Click Save.

Entity search list and entity details interface

2. Entity Detail Workspace Tabs

Section titled “2. Entity Detail Workspace Tabs”

When you select an entity from the search list, the detail workspace provides three dedicated tabs:

  • Attributes: View and edit the current value of every dimension, metric, list option, and reference link.
  • History: Review the complete immutable audit change log of every edit, detailing what changed, when, and by whom.
  • Chart: Analyze interactive time-series plots for numeric metric attributes over historical time windows.

3. Dynamic Field Validation

Section titled “3. Dynamic Field Validation”

Omnismith automatically validates attribute inputs on save:

  • Required Fields: Ensures mandatory dimensions and references are populated.
  • Data Type Safety: Enforces numeric ranges, valid date formats (YYYY-MM-DD), ISO timestamps, and strict List options.
  • Reference Integrity: Verifies that referenced target entities exist and are active.

💡 Developer Architecture Note

Section titled “💡 Developer Architecture Note”

[!NOTE] Programmatic API Ingestion: Entities do not need to be created manually. Monitoring agents, IoT background workers, and webhooks can ingest and update entities programmatically:

  • OpenAPI Endpoint: POST /api/v1/entity/template/{templateId}
  • Batch / Delta Updates: Update specific attribute keys without overwriting unchanged fields.
  • Backfilled Timestamps: Send explicit updated_at timestamps to log historical metric data points during network offline buffering.

Next Steps

Section titled “Next Steps”

[!TIP]