Skip to main content

Overview

Introduction​

Working with a Project involves creating Artifacts. Artifacts include Models, Data, Dashboards, and arbitrary Files. Artifacts can be created by a Workflow or manually uploaded. Organizationally, Artifacts within a Project behave much like a file system in that:

  1. they are located within a Folder and
  2. have a unique name within their Folder.
info

Folders act as namespaces to separate Artifacts with the same name

Immutability​

Where Sedaro Artifacts differ from a traditional file system is that they are version controlled. Each version of an Artifact is immutable. In order to mutate an Artifact, a new version of that Artifact must be created. An Artifact may have one or more versions and the "latest" or "current" version is always the most recently published version. The "current" version may not be overwritten to a "previous" version.

Referencing Artifacts​

Artifact are fully-addressable across Projects and even Platform instances/hosts. In either case, given a Platform hostname, Artifacts may be referenced via either:

  1. their fully qualified "path" (i.e. Project ID, Branch Name, and /path/through/folders/name.extension) or
  2. their UUID.

In either case, an optional version identifier can be provided to reference a specific Artifact version.

Artifacts are also discoverable by querying for all Artifacts within a Folder, either explicitly within a given Folder or recursively within the Folder or its sub-Folder.

Artifact Deletion​

Deleting an Artifact permanently removes it and all of its versions from the database. A new Artifact can be created in the same folder and with the same name as a previously deleted Artifact, but it will be assigned a new UUID.

Individual Artifact versions may also be deleted:

  • A version cannot be deleted if it is the only version of its Artifact.
  • When the "latest" version is deleted, the next most recent version automatically becomes "current."
  • For Files, deleting a version also removes the associated file from cloud storage.
warning

Artifact deletion is permanent and cannot be undone.

Types of Artifacts​

Sedaro supports multiple types of Artifacts, each optimized for different use cases and data formats. All Artifact types share common characteristics and organizational principles while providing specialized functionality for their respective data types.

Shared Characteristics​

All Artifacts, regardless of type, include these fundamental properties:

  • Name: A descriptive identifier for the Artifact within its Folder namespace
  • Content Type: A user-defined categorization field for organizing and filtering Artifacts by purpose or domain
  • Discoverability: Controls whether the Artifact appears in standard listings (searchable) or is excluded by default (unlisted) while remaining accessible via direct reference
  • Current Version: A reference to the most recently created version of the Artifact, representing the active state
  • Versions: A complete history of all versions created for the Artifact, enabling full version control and rollback capabilities
info

The different Artifact types have specialized APIs and capabilities while maintaining consistent versioning and folder organization principles.

File Artifacts​

File Artifacts represent traditional file-based content such as documents, images, configuration files, and other binary or text data. Key characteristics include:

  • Content Storage: Files are stored with their original content and can be downloaded in their native format
  • MIME Type Detection: File types are automatically detected if not explicitly set and stored to help with proper content handling
  • Priority System: Files can be assigned priority levels (0-10) to indicate their relative importance within a project
  • Size Tracking: File sizes are tracked and reported for storage management
  • Format Flexibility: Supports any file format, from simple text files to complex binary formats

File Artifacts are ideal for storing documentation, configuration files, images, reports, and any other traditional file-based content that needs to be version controlled and shared across team members.

info

In Sedaro Cloud, File Artifacts are scanned and monitored via state-of-the-art malware detection systems as part of Sedaro's multi-layer defense-in-depth cybersecurity strategy.

Series Data Artifacts​

Series Data Artifacts are specialized containers for time-series data, particularly suited for modeling and simulation data. Key characteristics include:

  • Time Boundaries: Data is bounded by start and stop times using Modified Julian Date (MJD) format for precise temporal representation
  • Stream Organization: Data is organized into multiple streams, each representing different measurement channels or data sources
  • Streaming Access: Supports efficient streaming access to large datasets without requiring full downloads
  • Sample Rate Management: Handles multiple sample rates and provides automatic rate adjustment for data retrieval
  • Simulation Integration: Designed specifically for simulation output data with built-in analysis and description capabilities

Series Data Artifacts are optimized for handling large-scale simulation results, telemetry data, and other time-indexed datasets where efficient querying and streaming access are essential.

Additional documentation is also available, providing much more in-depth description of Series Data Artifacts, and information on how to work with Series Data.