๐Ÿ”„ Version History

Upload new STEP versions, compare changes between versions, view historical models, and download source files.

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:

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.

  1. Go to the Versions tab on the Product Detail page.
  2. Click Upload New Version (top of the versions list).
  3. The Update Step modal opens. Select a .step or .stp file from your computer.
  4. Optionally add a version title and description to document what changed.
  5. Click Upload. The file uploads and a new version entry appears with processing status.
  6. Once processing completes, the status changes to ready and the new version becomes the current version.
๐Ÿ’ก
You can also upload a new version from the Products tab on the Project Detail page โ€” click the upload icon on the product card.
โ„น๏ธ
Uploading a new version does not delete the previous version. All historical versions remain accessible.

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:

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.

  1. Expand the version row.
  2. Click the pencil icon (edit button) that appears next to the version row header.
  3. Edit the title and/or description in the inline fields that appear.
  4. 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.

  1. Expand the version row.
  2. 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.

โ„น๏ธ
The Open in Viewer button in the product header always opens the current (latest) version. Use the Versions tab to access older versions.

Downloading the STEP File

The original STEP file for each version can be downloaded at any time.

  1. Expand the version row.
  2. Click Download STEP. The file size is shown next to the button.
  3. 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

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.

๐Ÿ’ก
It is good practice to review deleted-part tasks after every version upload and either reassign, complete, or delete them.

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.

See Chapter 13 โ€” Engineering Schematics for full details on uploading and annotating schematics.