Overview
SysHub tracks every STEP file you upload for a product as a numbered version. The Versions tab on the Product Detail page shows the complete history, lets you compare what changed between versions, and allows you to open or download any historical version.
Version List
Versions are listed in reverse chronological order (newest first). Each row shows:
- Version number badge (e.g. v3)
- Upload date and time
- Title (if set) โ shown after the date, separated by a dot
- Change count โ number of parts added or removed compared to the previous version (shown for ready versions)
- Status badge โ ready, processing, or error
- Expand chevron โ click to expand the version row
Uploading a New Version
When your design changes, upload a new STEP file to create the next version. Requires the uploadVersions permission or owner role.
- Go to the Versions tab on the Product Detail page.
- Click Upload New Version (top of the versions list).
- The Update Step modal opens. Select a
.stepor.stpfile from your computer. - Optionally add a version title and description to document what changed.
- Click Upload. The file uploads and a new version entry appears with processing status.
- Once processing completes, the status changes to ready and the new version becomes the current version.
Version Status
| Status | Meaning |
|---|---|
| processing | The STEP file is being parsed. The viewer is not yet available for this version. |
| ready | Processing complete. The version can be viewed, downloaded, and compared. |
| error | Processing failed. No 3D data is available. Try re-uploading the file. |
Expanding a Version
Click anywhere on a version row (or the chevron icon) to expand it. The expanded view shows:
- The version title and description (if set)
- A View this version button โ opens the 3D viewer for this specific version
- A Download STEP button โ downloads the original STEP file (with file size shown)
- The Version Diff panel โ shows what parts were added or removed compared to the previous version
Editing Version Metadata
You can add or update the title and description of any ready version after it has been processed. Requires editInfo permission or owner role.
- Expand the version row.
- Click the pencil icon (edit button) that appears next to the version row header.
- Edit the title and/or description in the inline fields that appear.
- Click Save. The metadata updates immediately.
Viewing a Specific Version
You can open the 3D viewer for any historical version, not just the current one.
- Expand the version row.
- Click View this version. The 3D viewer opens for that specific version.
The viewer URL includes the version ID (/versions/:versionId/viewer), so you can bookmark or share a link to a specific version.
Downloading the STEP File
The original STEP file for each version can be downloaded at any time.
- Expand the version row.
- Click Download STEP. The file size is shown next to the button.
- A secure signed URL is generated and the download begins automatically.
Version Diff (Change Comparison)
When a version is expanded, the Version Diff panel shows a comparison between this version and the one before it. This makes it easy to see exactly what changed in the assembly.
| Indicator | Meaning |
|---|---|
| + Added | Parts that exist in this version but not in the previous one |
| โ Removed | Parts that existed in the previous version but are gone in this one |
- The diff is only shown for ready versions that have a previous version to compare against.
- The first version of a product has no diff (nothing to compare to).
- The change count badge on the collapsed row shows the total number of added + removed parts.
Deleted Parts & Tasks
When a part is removed in a new version, any tasks that were linked to that part become "orphaned". SysHub tracks these and surfaces them in the Tasks tab under the โ Deleted parts filter.
From the Version Diff panel, you can click a removed part name to jump directly to the Tasks tab filtered to show tasks for that deleted part. This makes it easy to review and clean up orphaned tasks.
Engineering Schematics & Versions
Each engineering schematic uploaded to a product is linked to a specific version. This means you can always tell which revision of the design a schematic corresponds to.
- When uploading a schematic from the Schematics tab, you select the linked version from a dropdown.
- When uploading a schematic alongside a new product, it is automatically linked to version 1.
- The schematic list in the Schematics tab shows the linked version label next to each schematic title.
See Chapter 13 โ Engineering Schematics for full details on uploading and annotating schematics.