Quick Start Guide

This guide walks you through the minimal, end-to-end workflow to set up your first schema, populate data, track metrics, and build a visual dashboard in Omnismith.

---

⏱️ Step-by-Step Workflow (10–15 Minutes)

Step 1: Create or Select a Project

1. Log into your Omnismith workspace.
2. From the top left header menu, click the Project Switcher to select an existing project or click + Create Project to set up a new workspace.

---

Step 2: Choose Your Setup Method

When starting in a fresh project, you can choose:

• Option A (Instant Blueprint): Click Install on a featured blueprint (e.g. Crisis Management or IT Asset Tracker) from the welcome dialog to deploy ready-made templates and sample data in seconds.
• Option B (Custom Schema): Click Start Empty to define your data model step-by-step from scratch (detailed below).

---

Step 3: Define Attributes (Data Building Blocks)

If building custom data models, define your attributes first:

1. Navigate to Data Modeling → Attributes in the sidebar navigation launcher.
2. Click + Create Attribute.
3. Create your key fields. For example, for an IT Server & Service SLA Tracker:
   • Hostname: Type = Dimension, Data Type = String (Standard text field)
   • Environment: Type = List, Options = [Production, Staging, Development]
   • Status: Type = List, Options = [Online, Degraded, Offline]
   • CPU Usage (%): Type = Metric, Data Type = Number (Numeric field tracked over time)
   • Latency (ms): Type = Metric, Data Type = Number (Numeric field tracked over time)

[!NOTE] Dimensions vs. Metrics: Use Dimensions for static or categorical properties (e.g. Hostname, Environment, Status). Use Metrics for numeric values that change continuously over time and will be plotted on time-series analytics charts.

---

Step 4: Create a Template (Schema Blueprint)

1. Navigate to Data Modeling → Templates.
2. Click + Create Template.
3. Enter a title (e.g. Server Node) and description.
4. On the Attributes tab, attach the attributes you defined in Step 3 (Hostname, Environment, Status, CPU Usage, Latency).
5. Click Save Changes.

---

Step 5: Create and Update Entities (Data Records)

1. Navigate to Entity Operations → Entities (or select Server Node from the navigation sidebar).
2. Click + Create Entity.
3. Fill in initial attribute values:
   • Hostname: prod-app-server-01
   • Environment: Production
   • Status: Online
   • CPU Usage (%): 42
   • Latency (ms): 15
4. Click Save.
5. Update metric attributes periodically (e.g. update CPU Usage to 88 and Latency to 120). Omnismith automatically logs every metric update into the time-series database with exact timestamps.

---

Step 6: Explore Filtered Queries & Historical Analytics

1. Search & Filter: On the Entity list page, click Filter to query entities by specific conditions (e.g., Environment = Production AND Status = Online).
2. Audit History: Open an entity and click the History tab to inspect the complete change audit log of every attribute update.
3. Metric Chart: Click the Chart tab to visualize how metric values (like CPU Usage or Latency) have changed over time with configurable bucket widths (minute, hour, day).

---

Step 7: Build Your First Dashboard View

1. Navigate to Dashboards → Search.
2. Click + Create Dashboard and enter a name (e.g., Infrastructure Operations Portal).
3. Click + Add Block to place a chart or summary block onto your dashboard canvas.
4. Select the target Template (Server Node) and metric fields to aggregate.
5. Drag and resize blocks to customize your layout.

---

Next Steps & Deep Dives

[!TIP] Now that you’ve completed your first workflow:

• Learn how the underlying data engine works in Key Concepts.
• Configure relation attributes in Reference Relations.
• Set up automatic alerts in Automation & Notifications.