Skip to main content

Systems, Configurations, and Snapshots

Systems enable teams to group related models and artifacts, track versions, capture point-in-time states, and share consistent file sets.

Why Systems Matter​

Version and Baseline Management​

  • Track which file revisions belong together by pinning specific versions or following the "latest" revision.
  • Capture validated states with snapshots—immutable records of a configuration at a point in time.
  • Use baselines to mark critical milestones (e.g., design reviews, releases).

Seamless Collaboration​

  • Share a system or snapshot to ensure everyone sees the same set of files and revisions.
  • Provide suppliers or partners with consistent baselines for alignment.

Auditability and Change Tracking​

  • Compare snapshots to identify changes (e.g., renames, updates, added/removed files).
  • Maintain a clear history of validated states for compliance or reviews.

Key Components​

System​

The top-level container for organizing related files.

  • Create a system, name it, and add one or more configurations.
  • Manage snapshots, tags, and sharing from the system overview.

Configuration​

A named collection of files (models and artifacts) within a system.

  • Files can be:
    • Tracked (system follows the latest revision).
    • Pinned (locked to a specific revision).
  • A system can include multiple configurations (e.g., "Propulsion System," "Avionics").

Snapshot​

An immutable record of the file revisions in a configuration at a specific moment.

  • Automatically created when you set up a system.
  • Capture new snapshots as files evolve.
  • Tag snapshots (e.g., "v1.0," "Design Review Baseline") for clarity.
  • Use View System Diff to compare snapshots and analyze changes.

Note: A baseline is a special snapshot tag used to mark reference states (e.g., "Design Review Baseline"). Every system requires a baseline tag on its first snapshot. For full definitions, see Terminology.

How It Works​

  1. Create a System: Define a container for related files (e.g., "Aircraft Landing Gear").
  2. Add Configurations: Group files logically (e.g., "Mechanical Components," "Electrical Systems").
  3. Pin or Track Files: Choose whether to follow the latest revision or lock to a specific version.
  4. Take Snapshots: Freeze the state of a configuration at key points (e.g., before a review).
  5. Tag and Share: Label snapshots (e.g., "Final Delivery Baseline") and share them with collaborators.

Key Details​

  • Data Sovereignty: File contents remain in your data plane (e.g., S3, Azure). Only metadata (file references, revisions) is stored in the control plane.
  • Permission Inheritance: Sharing a system does not override file-level permissions. Users need access to the underlying files to view content.
  • Snapshot Tags: Use tags (including the required baseline) to mark validated states and share specific snapshots with teams or partners.

How to work with systems​

User guide (UI):

  • Systems Guide — Create a system, add configurations, add files (tracked or pinned), take snapshots, manage snapshot tags, view diffs, and share the system.

Python client (SDK):

  • SDK setup — Install and configure the Istari Digital Python client.
  • SDK API Reference (Client) — Methods for systems, configurations, and snapshots (e.g. create_system, create_configuration, create_snapshot, get_system, get_system_baseline, create_tag).

Artifact, Baseline, Configuration, Model, Snapshot, System