📦 Products

Overview

Products are the core data objects in SysHub. Each product represents a 3D assembly uploaded as a STEP file. SysHub processes the file, extracts the part hierarchy, and makes it available in the interactive 3D viewer. Products live inside projects and can have multiple versions, tasks, files, links, classes, groups, and interfaces.

What is a Product?

A product in SysHub is a named 3D assembly with:

• One or more versions (STEP files uploaded over time)
• A description and editable title
• Attached files and links
• Tasks linked to the product or to specific parts
• Classes and groups assigned to parts
• Interfaces (connections between parts, defined in the diagram view)
• Engineering schematics (PDF 2D schematics linked to specific versions)
• Its own set of collaborators (in addition to project-level collaborators)

Uploading a Product

To add a new product to a project, you need the owner role or the uploadVersions editor permission.

1. Open the project and go to the Products tab.
2. Click the Add Product button (top-right of the Products section).
3. The Add Product modal opens. Fill in:
   • Title (required) — the product name. If you select a file first, the title is pre-filled from the filename.
   • Description (optional) — a brief description of the product.
   • STEP File (required) — click the upload area or drag and drop a .step or .stp file.
   • 2D Schematic (optional) — once a STEP file is selected, a PDF upload field appears. Attach a .pdf engineering schematic to link it to version 1 automatically.
4. Click Add Product. The file begins uploading — a progress bar shows the upload percentage.
5. Once the upload completes, you are automatically navigated to the new product's detail page.

Processing Status

After the file is uploaded, SysHub processes it server-side to extract the part hierarchy and generate a 3D model. This happens automatically and usually takes a few seconds to a couple of minutes depending on file size.

The status badge is visible on the product card and in the Version History panel.

Product Cards

Each product in the Products tab is shown as a card with:

• Product name — click to open the product detail page
• Version badge — shows the current version number (e.g. v3)
• Status badge — ready, processing, or error
• Open in Viewer button — jumps directly to the 3D viewer
• Archive option — in the card's action menu

Opening a Product

There are two ways to open a product:

• Product Detail page — click the product card name. This opens the full detail view with all tabs (Info, Tasks, Classes, Groups, Interfaces, Versions, Schematics, Collaborators).
• 3D Viewer directly — click the Open in Viewer button on the product card. This skips the detail page and opens the interactive 3D viewer immediately.

Archiving Products

Archive a product to hide it from the active list without deleting it.

1. On the product card, open the action menu (three-dot icon or the Archive button).
2. Click Archive. The product moves to the archived section.

To view archived products, scroll to the bottom of the Products tab — archived products appear in a collapsible "Archived" section. To restore a product, open its card menu and click Unarchive.

Product Detail Tabs

Opening a product takes you to the Product Detail page, which has its own tab bar:

Each tab is covered in detail in the following chapters.