📖 This is a static documentation page. Open the interactive version with live canvas demos →

Version Management

Every save creates a new version of a file. The version system maintains a complete history — you can browse, compare, restore, or delete any previous version.

Head and History

Each saved file has two levels:

The head is the latest version — the most recent save. When you open a file from the file list, you load the head version. The head carries:

  • Title — the file name
  • Kind — the file scope: template, action, step, process, or all
  • Comment — a note about the current state
  • Tags — classification labels
  • Groups — groups with access to this file
  • Owner — the user who created the file

History

The history is the ordered list of all previous versions. Each history entry has:

  • Label — auto-generated version label (e.g. "v3 · 2025-11-10 · 3 ver.")
  • Comment — optional note added at save time
  • Tags — tags applied to this specific version
  • Groups — groups with access to this version
  • Owner — who created this version

Browsing Versions

The File Upload Panel displays the file list with version information:

  • The panel header shows the file title and head metadata
  • Expanding a file reveals its full version history
  • Each version can be independently selected, viewed, or restored

Version Metadata

Comments

Each version can carry a free-text comment. Use comments to describe what changed in this version:

  • "Added quality gates to turning operation"
  • "Restructured assembly sequence"
  • "Fixed step types for grinding"

Comments are edited through the metadata update function.

Tags

Tags classify versions for filtering and search. A version can have multiple tags. Tags are shared across the application and available in all 13 supported languages.

Groups

Versions can be shared with groups — named collections of users. Assigning a group to a version grants all group members read access. Groups are managed separately and referenced by ID.


Restoring a Version

To restore a previous version:

  • Open the file in the File Upload Panel
  • Browse the version history
  • Select the target version
  • Load it via `getFileByID`

The canvas is cleared and the selected version is fully reconstructed — all elements, hierarchy, flow, and environment.

Restoring a version does not delete other versions. The history remains intact. If you save after restoring, you create a new version — effectively branching from the restored point.


Deleting Versions

Versions and files can be deleted or trimmed through the file management panel:

  • Delete a single version — removes that version from history
  • Trim — removes old versions beyond a threshold
  • Delete the entire file — removes all versions and the file entry

Deletion is permanent. The data and metadata are removed from the server.


Version Storage Architecture

On the server, versions are stored in two MongoDB collections:

  • meta — contains version metadata: label, comment, tags, groups, and a reference (`dataId`) to the actual data
  • data — contains the compressed file content (ZIP archive)

This separation keeps the meta collection lean for fast listing and search, while the data collection handles the larger payloads.