Skip to main content

File registration

Registration is the process of bringing a file into the platform so it has a unique, stable identity and can be shared, versioned, and used as input for functions (e.g. extraction). The platform stores metadata (identity, revisions, permissions) in the control plane; your actual file content stays in your data plane (your own storage) or in a third-party app.

Note: When a file is used as input for platform functions (e.g. extraction, simulation), we call it a model. This doc also uses the term artifact for files produced by a function or standalone files not further processed. See Terminology for full definitions.

Why does it matter?​

  • Traceability and auditability: Every registered file gets a unique, immutable UUID. You can track its lifecycle, revisions, and who accessed or changed it across teams and supply chains.
  • No data lock-in: File contents never leave your control—either in your object store (upload) or in the external app (connect). The platform orchestrates access and processing without holding your data.
  • Seamless collaboration: Once registered, files can be shared, referenced in systems, and used by agents for extraction or simulation while you keep a single source of truth.

Two ways to register: connect or upload​

  • Connect: Create a secure link to files stored in external systems (e.g., cloud storage like Google Drive or Microsoft 365, or PLM/ALM systems like Windchill or Teamwork Cloud). The platform stores only the reference and metadata—your file remains in its original location. When a job runs, authorized agents fetch the file directly from the source. This approach is ideal if your data already resides in these systems and you want to maintain a single source of truth.
  • Upload: Register a file by sending it to your own data plane (e.g. S3, Azure) via the platform. The platform never stores the bytes; it records metadata and the location in your storage. Best when you own the file locally or want it in your own bucket.

In both cases the file receives a UUID and can be used as a model for functions, included in systems, and shared with controlled access.

Key details​

  • The control plane holds metadata only; the data plane (or third-party app) holds the actual bytes.
  • Registered files can be grouped in systems, versioned, and used as inputs for functions (e.g. extraction) run by the Istari Digital Agent.

How to register files​

User guide (UI):

Python client (SDK):

  • SDK setup — Install and configure the Istari Digital Python client.
  • SDK API Reference (Client) — Methods for adding and updating models and files (e.g. add_model, add_file, create_revision, generate_upload_url), and for working with revisions and tokens.

Artifact, Control plane, Data plane, File, Link, Model, Storage, Third-party data source