Getting Started
Dashboard
The project's widget board: charts, query tables, activity and comment feeds, countdowns, process checklists, artifact cards, a calendar and verification status on a 12-column grid that you arrange, lock, resize and download from.
On this page
- Concepts
- How to use it
- When and why
- Open the dashboard
- Customize the dashboard
- Move and resize a widget with the keyboard
- Change a widget's settings
- Download data from a widget
- Track a process with a checklist
- Remove a widget or reset the layout
- Worked example: a review board for the CubeSat EO-1 demo
- Tips and good practice
- Common mistakes
- How it connects
- The Dashboard page
- Widget types
- Sizes
- Saving, undo and roles
- Narrow windows
- Messages
- Limits
- Related pages
The Dashboard is a board of widgets for the numbers and lists you track in a project. Each widget shows live data from the model: a chart of requirement status, a table of open risks, the latest changes, a countdown to launch. You choose the widgets, place them on a 12-column grid and size them.
The layout is saved in the project, so every member of the project sees the same dashboard. Every change to it can be undone.
Concepts
- Widget: one box on the dashboard, with a title bar and a body. Each widget has a type, such as Pie Chart or Entity Table, and its own settings.
- Grid: the dashboard has 12 columns. Rows are 30 px high with a 10 px gap. A widget's position is a column and a row; its size is a width in columns and a height in rows.
- Compaction: widgets move up to fill empty space above them. When you drop or resize a widget onto others, those widgets move down to make room.
- Locked widget: a widget marked with 🔒. It stays where it is: you cannot drag or resize it, and other widgets flow around it.
- Single-use widget: Project Summary and Project Wiki can appear only once. After you add one, it leaves the Add Widget list.
- Downloads: widgets with data offer files under ⤓: chart images (PNG), tables and feeds (CSV), and the RVTMRequirements Verification Traceability Matrix A table of each requirement with how it is verified, the tests that verify it and their latest result. (CSV or Word).
How to use it
When and why
Use the dashboard as the project's status board. Home tells you what needs attention; the dashboard shows what you chose to track. Typical uses:
- During requirements work: a chart of requirement status and a table of requirements still in Draft.
- Before a review such as SRRSystem Requirements Review A milestone review that confirms the system requirements are complete and agreed before design starts. or PDRPreliminary Design Review A milestone review that confirms the preliminary design meets the requirements and is ready for detailed design.: verification coverage, open comments and a countdown to the review date.
- During integration and test: a bar chart of test case status and the RVTMRequirements Verification Traceability Matrix A table of each requirement with how it is verified, the tests that verify it and their latest result. of unverified requirements.
- For a class or a new team: a Process Checklist that walks everyone through the steps of a process.
The widgets read the model directly. A chart or table updates as soon as anyone changes the items it counts.
Open the dashboard
- Open Home in the rail, then click Dashboard in the top bar. (Or click Dashboard under Home in the rail.)
You see the dashboard. A new project starts with a default layout: Project Summary, Project Wiki, a doughnut chart of classes, Activity Feed, a Recently Modified table, a Requirement Status pie chart, Comments Feed and Quick Start.
Customize the dashboard
- Click + Add Widget in the top bar.
The Add Widget dialog lists the widget types on the left, each with a short description.
- Click a widget type.
- Enter a Widget Title. It starts as the type's name.
- Fill in the type's settings. For example, for a Pie Chart choose Enumeration as the schema type and pick Requirement: Status.
- Click Add Widget.
The widget appears in the first free space from the top of the grid, at the type's default size.
- Drag the widget's title bar to move it. Drag its bottom-right corner to resize it.
A shaded outline shows where it will land. Other widgets move down to make room. The layout saves when you release the mouse.
- Optional: click 🔓 in the title bar to lock the widget in place.
Move and resize a widget with the keyboard
Every widget can be placed and sized without a mouse, from its settings.
- Tab to the widget's ⚙ button and press Enter.
The Edit Widget dialog opens with a Position and size group.
- Set Column (1–12), Row, Width (columns) and Height (rows).
- Press Enter or click Save.
The widget moves to that position. Other widgets move down to make room.
Values outside the allowed range are corrected: the width is at most 12 columns, and the widget is kept inside the grid. A locked widget shows "This widget is locked. Unlock it (🔒) to move or resize it." instead of the position fields.
Change a widget's settings
- Click ⚙ in the widget's title bar.
- Change the Widget Title, the settings or the position and size.
- Click Save.
To rename a widget quickly, double-click its title, type the new title and confirm.
Download data from a widget
- Click ⤓ in the widget's title bar. (Only widgets with downloads have it.)
- Choose a download, for example Download Table (CSV) or Opaque Image (PNG).
The file downloads to your browser's download folder.
Track a process with a checklist
- Click + Add Widget and choose Process Checklist.
- Under Process, choose a base process such as Requirements Management (create), or Add Custom Process… and enter a Custom process name.
- Optional: tick Use Percentages in Completion Tracking to enter a percentage per step instead of a checkbox.
- Click Add Widget.
Holarch creates the process in the model: one item for the process and one child item per step, all labeled Process Task. The widget shows the steps, a progress bar and "0% complete".
- Tick each step as you finish it. Click ↗ next to a step to open the page where that step is done.
Remove a widget or reset the layout
- Remove a widget: click × in its title bar, then Remove in the confirmation. The widget's data in the model stays; only the widget goes.
- Reset the layout: choose Project ▾ → Reset Layout…, then Reset. The default layout replaces all widgets. Undo (⌘Z / Ctrl+Z) restores your layout.
Worked example: a review board for the CubeSat EO-1 demo
The CubeSat EO-1 demo project comes with a dashboard: Project Summary, a Mission Summary wiki, a Launch Countdown tied to the launch milestone, a Model Walkthrough checklist, Requirement Status and Test Case Status charts, Recent Activity, four artifact cards, Open Comments and Verification Coverage. Add a risk table for the review:
- Open the demo project, then Home → Dashboard.
- Click + Add Widget and choose Entity Table.
- Set Widget Title to Risk Register.
- Enter
class:Riskin the search query field.The field reports the number of matching entities, for example "7 matching entities".
- Set Sort by to Number and Entity Limit to 10.
- Under Columns to Display, tick Number, Name and Description.
- Click Add Widget.
The table lists RK-1 Reaction Wheel Failure, RK-3 Launch Slip and the other risks.
- Drag the widget next to Open Comments, then click 🔓 to lock it.
- Before the review, click ⤓ → Download Table (CSV) to attach the risk list to the review package.
Tips and good practice
- Keep one question per widget. A chart of requirement status and a separate table of Draft requirements read faster than one crowded table.
- Name widgets after the question, for example Unverified requirements, not Entity Table.
- Lock the widgets everyone relies on. Locked widgets do not move when someone drags another widget.
- Use attribute tests in table queries, such as
Requirement:"Status=Draft". The table's Sort by setting decides the order; anorder:token in its query has no effect. - Tie countdowns to a milestone with Use Entity For Target Date. When the milestone date changes, the countdown follows.
Common mistakes
- The chart shows "No data to display." The chosen classes or labels have no items, or the enumeration has no values. Open ⚙ and pick other values, or leave the selection empty for automatic.
- A table shows "No entities match the widget query." The query is too narrow or has a typo. Open ⚙; the count under the query field updates as you type.
- A widget does not move when dragged. It is locked (🔒), or the window is narrow. Unlock it, or use ⚙ → Position and size.
- A Process Checklist step was deleted with Remove Step. The step is an item in the model, so Remove Step deletes that item. Undo (⌘Z / Ctrl+Z) brings it back.
How it connects
- Model and Database: tables use the same query syntax as the Database, and Open in Database runs the table's query there. Chart slices and bars of classes or labels open the Database filtered to them.
- Verification: the Verification Status (RVTM) widget shows the same rows as the RVTM.
- Project Management: the Calendar widget uses the project calendar, and the Charts page has more chart types (see Project Management).
- Export: the dashboard layout travels with a project export when Include Project Preferences is on (see Import and Export).
The Dashboard page
Top bar
| Control | What it does |
|---|---|
| + Add Widget | Opens the Add Widget dialog. |
| Project ▾ | Project Preferences… (name and description), Export Project… and Reset Layout…. |
| + New Entity | Creates an item and opens it. |
Under the top bar a hint reads "Drag a widget by its title bar; resize from the bottom-right corner, or use ⚙ for exact position and size. The layout saves automatically."
Widget title bar
| Control | What it does |
|---|---|
| Title | The widget's title. Double-click to rename it (dialog Widget Title). Drag to move the widget. |
| 🔓 / 🔒 | Lock Widget / Unlock Widget. |
| ⚙ | Edit Widget (title, settings, position and size). |
| ⤓ | Reports: the widget's downloads. Shown only for widgets that have downloads. |
| × | Remove Widget, after the confirmation "Remove "title" from the dashboard?". |
The bottom-right corner of an unlocked widget is the resize handle.
The Add Widget and Edit Widget dialogs
- Add Widget shows the list of widget types, Widget Title and the type's settings. Single-use types that are already on the dashboard are not listed.
- Edit Widget shows Widget Title, the settings and Position and size: Column (1–12), Row, Width (columns) and Height (rows), with the note "Other widgets move down to make room."
- Settings errors appear at the bottom of the dialog, and the dialog stays open until you fix them.
Widget types
The Add Widget list shows the types in this order.
| Widget | What it shows | Downloads |
|---|---|---|
| Project Summary | Counts of entities, relationships, requirements, actions, diagrams and documents | — |
| Project Wiki | The project description as rich text | — |
| Wiki | A free-form rich-text note | — |
| Pie Chart | Counts by class, label or enumeration value, as a pie or doughnut | Transparent Image (PNG), Opaque Image (PNG) |
| Bar Chart | The same counts as bars | Transparent Image (PNG), Opaque Image (PNG) |
| Entity Table | The result of a database query | Download Table (CSV) |
| Activity Feed | Every change, newest first, with restore for deleted entities | Activity Feed (CSV) |
| Comments Feed | All comments in the project, newest first | Download Comments (CSV) |
| Countdown Clock | Days, hours, minutes and seconds until a date | — |
| Process Checklist | A process as a checklist of steps | — |
| Artifact Card | One diagram, document, presentation or other artifact with its thumbnail | Image (PNG) |
| All Existing | A tile browser of every artifact of one kind | — |
| Calendar | A month calendar of dated entities | — |
| Verification Status (RVTM) | Requirements with their verifying test cases and rolled-up status | RVTM (CSV), RVTM (Word) |
| Quick Start | Links to the main pages | — |
Project Summary
Six tiles: Entities, Relationships, Requirements, Actions, Diagrams (with "n saved · n derived") and Documents. Click a tile to open its page; Relationships has no page. Diagrams are counted as on the Diagrams page: saved diagrams plus derived views.
Project Wiki and Wiki
- Project Wiki shows the project description. Click Edit Wiki Content, edit the text in the rich-text editor, then click Update (or Cancel). The text is the same description as in Project Preferences…. Empty state: "No project description yet."
- Wiki is a note kept in the widget. You can add several. It edits the same way. Empty state: "Empty note."
See the rich-text editor for formatting.
Pie Chart and Bar Chart
The chart counts items in one of three ways, set under Choose Schema Type:
- Classes: one slice or bar per class. Select Classes to Display picks them; leave it empty to show every class that has items.
- Labels: one slice or bar per label, picked the same way.
- Enumeration: one slice or bar per value of an enumeration attribute, picked under Select an Enumeration to Display (listed as Class: Attribute). Items without a value count as their default, or as "(none)".
The class and label lists have a Filter… box and All and None buttons.
Other settings:
- Choose Pie Chart Type (pie only): Pie or Doughnut. A doughnut shows the Total in the middle.
- Legend Position: Top, Bottom, Left, Right or None. Bar charts place a left or right legend at the top.
- Display Bars Horizontally, X Axis Title and Y Axis Title (bar only).
Point at a slice or bar to see its count and share. Click a class or label slice or bar to open the Database filtered to it. Status values such as Approved, Rejected, Passed and Failed keep their status colors.
Transparent Image (PNG) downloads the chart without a background; Opaque Image (PNG) adds a white background for slides and documents. The file is named after the widget title.
Entity Table
| Setting | Values |
|---|---|
| Search query | A query, for example class:Requirement AND label:"Functional Requirement". Empty shows all entities. The number of matches shows under the field as you type. |
| Sort by | Modified (newest first), Created (newest first), Number or Name |
| Entity Limit | 1 to 500 rows (default 25) |
| Columns to Display | Number, Name, Class, Description, Labels, Global ID, Created On, Modified On, and any attribute, listed as Attribute (Class) |
Names link to the entity. Open in Database opens the Database with the same query. Download Table (CSV) downloads the rows and columns shown, named after the widget title.
Activity Feed
The feed lists changes, newest first: Create, Update, Delete, Restore, Relationship Added, Relationship Removed and Relationship Updated. Each line shows the class, the item, the time and a summary of what changed.
- Click details to see each changed field with its value before and after.
- A deleted entity has Restore (tooltip Restore Entity to Project). It comes back with its relationships: "Restored name".
- The feed shows 30 changes; Load More adds 30 more.
Settings: Activity type (All, Create, Update, Delete, Restore; Update includes relationship changes), Date Range (Any time, Past hour, Past day, Past week, Past month, Custom range with From and To), Class and Label.
Activity Feed (CSV) opens Activity Feed Report. It uses the widget's filters, with Limit (default 1,000) and Offset (default 0). Download CSV saves activity_feed.csv with the columns Date, Change Type, Entity Id, Entity Number, Entity Name, Class and Change Made.
Comments Feed
The feed lists the 100 newest comments with their item and date. Resolve and Reopen change a comment's state.
Settings: Comment status (All, Resolved, Unresolved), Filter Comments by Entity (Choose… or Clear), and From and To dates.
Download Comments (CSV) saves comments.csv with every comment that matches the filters: Number, Name, Class, Description, Comment, Date and Resolved.
Countdown Clock
The clock shows DAYS, HRS, MIN and SEC with "Countdown until date". After the date it counts up: "Count-up since date".
| Setting | Values |
|---|---|
| Target | Select Date or Use Entity For Target Date |
| Target Date | A date and time (with Select Date) |
| Entity and DATETIME attribute | An item and one of its date attributes, such as a milestone's start (with Use Entity For Target Date) |
| Text Color | The color of the numbers |
| Background Image Url (Before Date) and (After Date) | An image shown behind the clock before and after the date |
Note: The hosted service loads images only from Holarch itself, so an image address on another website does not show in the clock.
Process Checklist
The widget shows the process name (a link to its item), "n% complete", a progress bar and the steps.
Settings:
- Process: an existing process, a base process to create, or Add Custom Process… with a Custom process name. A custom process starts without steps.
- Use Percentages in Completion Tracking: each step takes a number from 0 to 100 instead of a checkbox. The progress is the average.
- Lock editing (hide step actions): hides the step menus and + Add Step….
Each step's ⋯ menu has Edit Step Info…, Move Row Up, Move Row Down and Remove Step. + Add Step… asks for a Step name. Steps are items, so their progress is stored in each step's Percent Complete attribute.
The base processes and their steps:
| Process | Steps |
|---|---|
| Requirements Management | 7: capture goals, write top-level requirements, break them down, trace them, draft test cases, run the Quality Checker, review and save a baseline |
| Verification & Validation | 5: choose what to verify, write procedures, link test cases, record expected outcomes, keep status current |
| Project Management | 5: start a Timeline Diagram, lay out tasks, connect dependencies, review the Gantt Chart, track work on a Kanban Board |
| Risk Management | 5: start a Risk Diagram, place risks, brainstorm risks with AI, add mitigations, chart risk burndown |
| Systems Modeling | 5: model behavior, show physical structure, explore connections in a Spider Diagram, add SysML diagrams, add other diagrams |
Artifact Card and All Existing
- Artifact Card shows one artifact as a card with its thumbnail. Choose the Card type (Diagram Card, Document Card, Presentation Card, Compilation Card, Test Suite Card, Chart Card, DoDAFDepartment of Defense Architecture Framework The US DoD framework for describing architectures as a set of viewpoints and products, such as OV-1 and SV-1. Product Card or UAFUnified Architecture Framework An OMG architecture framework that organizes views in a grid of viewpoints and aspects. It covers DoDAF and NATO needs. View Card) and the Target. Image (PNG) downloads the thumbnail.
- All Existing shows every artifact of one Type as tiles, with Find, a sort order and 6, 12, 24 or 48 tiles per page (6 by default).
The card menus are described in Artifact Cards and Tile Browsers.
Calendar
A month calendar of dated items. Move between months, click a day to show only its items, and click an item to open it. The Query setting narrows the items; empty uses the default: dated Actions, Tasks and Time entities.
Verification Status (RVTM)
Chips count the requirements per status. The table lists Requirement, Method, Test Cases and Status. Unverified requirements only hides the rest. Open Test Center opens the test page. Downloads: RVTMRequirements Verification Traceability Matrix A table of each requirement with how it is verified, the tests that verify it and their latest result. (CSV) and RVTM (Word).
Quick Start
Links to Database, Documents, Diagrams, Traceability Matrix, Import Analyzer and Help.
Sizes
Each type has a default size and a minimum size, in columns × rows.
| Widget | Default | Minimum |
|---|---|---|
| Project Summary | 12 × 4 | 3 × 3 |
| Project Wiki | 4 × 8 | 3 × 4 |
| Wiki | 3 × 8 | 2 × 4 |
| Pie Chart, Bar Chart | 4 × 8 | 3 × 7 |
| Entity Table | 4 × 10 | 3 × 6 |
| Activity Feed | 4 × 10 | 3 × 7 |
| Comments Feed | 4 × 8 | 3 × 6 |
| Countdown Clock | 3 × 7 | 2 × 5 |
| Process Checklist | 4 × 10 | 3 × 6 |
| Artifact Card | 3 × 9 | 2 × 6 |
| All Existing | 8 × 14 | 4 × 8 |
| Calendar | 6 × 12 | 4 × 9 |
| Verification Status (RVTM) | 6 × 10 | 4 × 6 |
| Quick Start | 4 × 8 | 3 × 5 |
Saving, undo and roles
- Every change to the dashboard (add, move, resize, lock, rename, settings, remove, reset) is one undo step. Press ⌘Z / Ctrl+Z to undo it.
- The layout is part of the project. All members see the same dashboard, and a change by one member reaches the others.
- Viewers and Reviewers see the dashboard but cannot change it. A change is refused with "View only: ask an owner for edit access." (Reviewers see the review-only version of the message.) Nothing is saved.
Narrow windows
When the window is narrower than about 760 px, the widgets stack in one column at their own height. Dragging and resizing are off while the grid is narrower than 700 px. Use ⚙ → Position and size to change the layout there.
Messages
| Message | Meaning and fix |
|---|---|
| "No widget types are available to add." | Every type is single-use and already on the dashboard. Remove one first. |
| "Enter a widget title." | Widget Title is empty. |
| "Pick at least one value to display." | Choose an enumeration under Select an Enumeration to Display. |
| "From date cannot be after To date" | Activity Feed custom range: fix the dates. |
| "From date is set in the future" | Activity Feed custom range: choose a past From date. |
| ""To" has to be on or after "From"." | Comments Feed: fix the dates. |
| "Select a target date." / "Choose an entity." / "Pick a DATETIME attribute; this entity has none." | Countdown Clock: complete the target, or choose an item that has a date attribute. |
| "Choose a process." / "Enter a process name." | Process Checklist: choose a process or name the custom one. |
| "Choose a target." | Artifact Card: choose an artifact. "(none in this project)" means the project has none of that kind yet. |
| "No data to display." | The chart has nothing to count. Change its settings. |
| "No entities match the widget query." | Change the table's query. |
| "No activity matches the filters." | Widen the Activity Feed filters. |
| "No comments in this project yet." | The Comments Feed is empty until someone comments. |
| "Set a target date in the widget settings (⚙)." | Countdown Clock without a valid date: open ⚙. |
| "Choose or create a process in the widget settings (⚙)." | Process Checklist without a process, or its process was deleted. |
| "Choose an artifact in the widget settings (⚙)." | Artifact Card without an artifact, or its artifact was deleted. |
| "No requirements." | The RVTM widget has no rows to show. |
| "Widget failed: …" | The widget could not draw. Open ⚙ and check its settings, or remove it and add it again. |
Limits
- 12 columns; rows of 30 px.
- Project Summary and Project Wiki: one each per dashboard.
- Entity Table: up to 500 rows.
- Comments Feed: the 100 newest matching comments are shown; the CSV holds all of them.
- Activity Feed: 30 changes at a time; the CSV default is 1,000 rows.
- One dashboard per project, shared by all members.