Tutorial 10 · Release
Library & Project Dashboards
12 min read
What you'll learn
- How to open the Library Dashboard and use it to query, filter, and CSV-export your organization's parts inventory
- Where org-wide Channel Defaults live and how they connect back to Tutorial 5: Designing with Channels
- How to open the Project Dashboard and what the Active Diagram table controls
- How to read the four analytics tiles: Release Maturity, Data Completeness, Project Metrics, Build Time Estimate
- How to tune project-wide Build time rules that drive the build-time estimate
- How to generate a project-wide Combined BOM and run a Bulk Export across many diagrams or harnesses
- How to run Project Rules Checks across every active diagram at once
Prerequisites
- Complete Tutorial 3: Building Library Parts so your library has parts to query in the Library Dashboard.
- Complete Tutorial 4: Make your First Diagram and Tutorial 6: Harness Editor so the project has real content to roll up.
- Complete Tutorial 7: Versioning — every tile in the Project Dashboard reads from a specific version of each diagram.
- Tutorial 9: BOMs & Exports is helpful — the Project Dashboard's Combined BOM and Bulk Export are the project-scope equivalents of what you learned there.
Two dashboards, two scopes
Artifact has two reporting surfaces named "dashboard," and it helps to keep them straight:
- Library Dashboard — organization scope. Reports on your shared parts library: query and filter the inventory, export it to CSV, and configure channel defaults. Opened from the Library sidebar.
- Project Dashboard — project scope. Rolls up the diagrams in one project: release maturity, data completeness, metrics, a build-time estimate, a combined BOM, bulk export, and project-wide rules checks. Opened per project.
This tutorial covers the Library Dashboard first (Part A), then the Project Dashboard (Part B).
Part A — The Library Dashboard
·A1. Open the Library Dashboard
In the Library sidebar header, click the Library Dashboard button (purple book icon — tooltip Library Dashboard). It opens as a tab titled Library Dashboard, with a count of how many items your library holds in the top-right.
The page is split into two groups: Channel Defaults at the top, and a Search / Query builder below it.
Screenshot
·A2. Configure Channel Defaults
The Channel Defaults group sets the default cable or bundle of conductors applied to a new channel of each protocol, so freshly drawn channels arrive pre-wired. This is the same panel referenced in Tutorial 5: Designing with Channels — see that tutorial for the full role-to-wire mapping workflow. Only Editors and Administrators can change these; everyone else sees them read-only.
·A3. Build a query over your inventory
The Search / Query group lets you filter your library and choose which columns to project before viewing or exporting the results.
- Quick Presets — one click loads a ready-made query. Options include All items overview, Missing procurement data, Without datasheets, Updated in last 30 days, and Full parameter export. A preset just fills in the filters and columns below; tweak them afterward.
- Filters — narrow the result set by:
- Item kind — Devices, Inline Components, Terminals, Connectors, Cables, Contacts, Backshells, Accessories, Tools, Harness Treatments (toggle the kinds you want).
- Updated since — Any time, Last 7 / 30 / 90 days.
- Plus name search and missing-data toggles that the presets set for you.
- Columns — tick column groups to include: General (Type, Categories, Description; Name is always included), Parameters (top-level tech specs), Procurement (part numbers, manufacturer, supplier, lead time, cost, inventory), Counts (ports, pins, tools, accessories, files), Files (datasheet references), and Audit (created/updated info).
- Click Run Query to populate the results table, or Reset to clear filters and columns back to defaults.
Screenshot
·A4. Read results and export to CSV
After Run Query, the results table lists every matching part, one row per item, with the columns you selected. Sort by clicking a column header, and click a part's name/reference to open it in the Library editor. A summary line reports totals — how many items matched, and how many have procurement data and files.
When you're happy with the view, click Download CSV to export exactly those rows and columns (the file is named library-dashboard-{date}.csv). The button stays disabled until you've run a query that returns rows. Value columns that carry units export a paired … Unit column so values and units stay aligned on re-import.
Screenshot
Part B — The Project Dashboard
1Open the Project Dashboard
Two entry points reach the same tab:
- Hamburger menu (☰) → Project Dashboard (purple speedometer).
- Diagrams sidebar → the purple speedometer button in the project header. Tooltip: Project Dashboard.
The tab title is Project Dashboard with a purple speedometer icon. Inside the tab, the page heading reads {projectName}: Project Configuration. A circular refresh button next to the heading (tooltip Refresh project data) reloads everything; the same data also refreshes when you change which diagrams or versions are active.
If the dashboard is already open, both entry points just switch to its existing tab — there is only one Project Dashboard per project.
Screenshot
2Choose what counts as "active"
Every analytics tile, the Combined BOM, the Bulk Export panel, and the Rules Checks all operate on the Active Diagram table at the top. Every diagram in the project appears in this table.
- Per-row checkbox — tick or untick to include/exclude this diagram from every section below. All rows are checked by default.
- Version dropdown — appears only when a diagram has multiple versions. Pick the version each tile should read (the GitBranch icon marks it). Choices persist per project in your browser.
- Status column — uppercase pill: Released, Snapshot, Draft, or Cancelled. Hover to see who last edited that version.
- Open icon (↗) — jumps to the chosen version in a new diagram tab.
Take a minute up front to uncheck any diagrams that are out of scope (work-in-progress prototypes, archived experiments). Everything below the table immediately recomputes.
Screenshot
3Read the Release Maturity tile
The first tile under Project Analytics is Release Maturity. It is read-only — you can't click into it — but it gives you the headline view of where the project stands.
It splits into two subsections:
- Diagrams (N) — total active diagrams, a large % Released number, and a stacked bar with counts of Released, Snapshot, Draft, and Cancelled based on the version you picked for each row.
- Harnesses (N) — same breakdown for every harness across those active diagrams; each harness inherits its parent diagram's status.
4Check Data Completeness
The Data Completeness tile estimates how close the project is to being build-ready. The big number at the top is a weighted release readiness percentage; underneath are five progress rows with their own (numerator/denominator):
- Components with P/N
- Ports with P/N
- Wires with P/N
- Wires with length
- Wires connected (weighted double — disconnected wires hurt readiness the most)
Click the expand arrow (↗) — tooltip View per-diagram breakdown — to open the Data Completeness modal. The modal lists every active diagram with its individual readiness score and per-metric counts, and offers an Export CSV button for offline review.
5Skim the Project Metrics tile
Project Metrics is the at-a-glance inventory rollup across all active diagrams. The 3×3 grid covers:
- Devices, Connectors, Splices
- Wires, Cables, Pin Conns (with a "X pins total" hint)
- Mass, Cost, Max Lead (with a part-name hint identifying the long-lead item)
Expand the tile for a per-diagram modal called Project Metrics with the same columns plus an Export CSV button.
This is the fastest way to answer questions like "how much harness mass is in the latest release across the whole platform?" without opening individual BOMs.
6Estimate and tune build time
The Build Time Estimate tile shows a single headline number (e.g. 12.5 h or 45 min) with a stacked bar of where that time goes: Terminations, Connector seats, Splices, Device mounting, Routing, Setup.
The estimate is driven by Build time rules — project-wide minutes-per-unit values shared by everyone with access to this project.
- Click the expand arrow on the Build Time Estimate tile. Tooltip: View per-diagram breakdown and edit rules.
- The modal opens with Build time rules at the top.
- Edit any of the six numeric fields. Each change auto-saves after a short debounce (you'll see Saving…).
- Per termination (min) — every wire endpoint that lands on a pin
- Per connector seat (min) — mating and securing a connector
- Per splice (min) — splice assembly + heat shrink
- Per device (min) — mounting and labeling a device
- Per meter routing (min) — layout and dressing the harness
- Per-harness setup (min) — fixture/setup overhead per harness
- Reset to defaults restores the built-in numbers if you want a clean slate.
- The per-diagram table below shows total time and the breakdown by category for every active diagram.
The subtitle under Build time rules confirms scope: Shared across all users on this project. Viewers see the alternative subtitle Editor permission required to change and the inputs are disabled.
Screenshot
7Generate a Combined BOM across the project
The Combined BOM section under the analytics tiles rolls every active diagram into a single Bill of Materials.
- Click View to open the Project Bill of Materials modal with the full table.
- Inside the modal, click Download CSV for the exported file, or click any reference name in the table to open the source diagram and select that item.
- As a shortcut, click Download in the Combined BOM section header to skip the modal and download
{projectName}_bom.csvdirectly.
The button label changes to Building... while Artifact assembles the data. Buttons are disabled until the underlying diagram cache finishes loading.
8Run a Bulk Export
Bulk Export is the project-scope version of Export Diagram (Tutorial 9: BOMs & Exports). Unlike per-diagram export, it can fan out across many diagrams and harnesses in one job — but it's PDF-only.
- Expand the Project Files panel (collapsed by default).
- Use the Search diagrams or harnesses... field or scroll the list to find what you need. Each row shows
{diagramName} ({versionName})with indented Cable-icon rows for each registered harness. - Tick the rows you want — nothing is pre-selected. The header tracks
({X of Y selected}); Select all files / Unselect all files is a one-click toggle. - Click the Export ({N}) button at the top of the section.
- The Bulk Export Settings: modal opens:
- Download Mode: — Individual PDFs or Single .zip archive
- Additional Exports: — Pin Tables, Connection Tables, BOMs (with Combined sub-checkbox), Diagram Comments, Comment Threads
- Length Unit, Mass Unit, Cable Mass Unit — same unit pickers as per-diagram export
- Click Export N PDF(s) or Export N PDF(s) (.zip).
- A progress modal takes over with title Exporting N PDF(s) showing live diagram previews on the left and per-file status (
Pending,Generating PDF…,Done,Error,Cancelled) on the right. The footer reads Please don't close this window and offers Cancel.
Output naming:
- Individual PDFs —
{diagramName}_{versionName}.pdf(or with_{harnessName}appended for harness exports). - ZIP archive —
export_{YYYY-MM-DD}.zip; collisions inside are suffixed_2,_3, …
Screenshot
9Run Project Rules Checks
The Project Rules Checks section runs a curated set of checks across every active diagram in one pass — it's the project-scope sibling of the in-diagram ERCs pane.
- Tick the checks you want to run:
- Duplicate Pin Assignments — only available here; finds cross-diagram pin conflicts.
- Components without P/Ns, Ports without P/Ns, Wires without P/Ns, Undefined Lengths, Disconnected Wires — the same ERCs you ran per-diagram.
- TX/RX Compatibility (Coming Soon) — disabled.
- Click Run. The button changes to Running....
- Results render inline:
- Green clipboard icon — passed (expand for "No issues found across N diagram(s)" detail).
- Red count + clipboard-X — failed.
- For ERC failures, expand the row to see
{diagramName} ({versionName})with N issue(s). Click any of those to open the diagram with the Rules pane focused on that specific check, already run. - For Duplicate Pin Assignments, each conflict lists the device/port/pin and shows Diagram(s): buttons that open each diagram and highlight the offending wires.
- Clear Results (circular arrow, tooltip Clear Results) resets everything.
Screenshot
Summary
You worked with both of Artifact's dashboards. In the Library Dashboard you queried, filtered, and CSV-exported your organization's parts inventory and saw where channel defaults are configured. In the Project Dashboard you used the Active Diagram table to scope what every section operates on, read the four analytics tiles (release maturity, completeness, metrics, build time), tuned project-wide build time rules, generated a Combined BOM and a Bulk Export PDF batch, and ran Project Rules Checks for cross-diagram issues like duplicate pin assignments. Together these are the views you'll keep open for library housekeeping, release readiness reviews, and program-level reporting.
What's next
- → Tutorial 11: Linking Artifact to Onshape — push individual harness data into Onshape's Wire and Cable tool.
- → Tutorial 13: Collaboration — share dashboard insights with teammates through comments and shareable links.
