DOCSEARCHbyAlgolia
Submit Docs

Istari Digital Internet of Physics Platform

website·Indexed 33 days ago

https://docs.istaridigital.com/

Documentation for the Istari Digital platform, featuring guides on managing engineering data through Resources, Systems, and Subsystems. Includes tutorials for the Python Client, Integration SDK, and web app basics, as well as details on version control, lineage, and AI-assisted building.

Tokens
218.9K
Snippets
728
Records
1.5K
Agent score
48%

What's inside Istari Digital

  1. Overview of Identity Service client keys

    Identity Service client keys are ECDSA P-384 keypairs used for private-key authentication as an alternative to Personal Access Tokens (PATs). Once a key is generated and registered, the CLI must be pointed to it using stari client init --identity-service.

    There are three primary workflows for obtaining a registered key:

    1. Exchange a PAT: Use stari key exchange to quickly swap a working PAT for a registered key.
    2. Generate and Register: Use stari key generate (offline) followed by stari key register (online).
    3. Provision New Agent: Use stari key generate --agent <env> followed by stari key create-agent for agents that do not yet exist.

  2. Overview of Istari Integration Modules

    Custom integrations in Istari are called modules. A module is a package containing one or more functions that are installed onto the Istari Agent to execute user jobs. Modules allow developers to connect Istari to external tools/APIs, perform custom data extraction, or run domain-specific workflows. They are designed to be language-agnostic and configuration-driven.

  3. Overview of Istari Digital Module Deployment

    A module is a package that delivers an integration (functions users run). Each Istari Digital Agent can host multiple modules. Note that a 'DE tool' is a separate vendor or open-source application required by the module; installing the module does not install the DE tool. The general deployment workflow is: unpack the package into the agent's istari_modules folder, confirm the agent loaded it, apply any required configuration, and publish the manifest using the CLI to grant user access.

  4. Overview of Istari Digital Platform notifications

    The Istari Digital Platform provides two ways to notify users about jobs and sharing activity:

    1. Notification Toasts: Brief on-screen alerts appearing in the bottom-right corner during an active browser session.
    2. Notifications Inbox: A persistent sidebar location for managing read/unread notifications and archives.

    Both features require backend eventing to be enabled by an IT administrator. While toasts can function without the inbox UI, the 'View inbox' action on summary toasts requires the inbox to be enabled.

  5. Overview of the Istari Digital Python Client

    The istari-digital-client (available on PyPI) allows developers to programmatically perform any action available in the Istari Digital web UI. It is used for scripting one-off operations, automating engineering work, and building applications on top of platform data. Key features include full feature parity with the UI, typed responses using Pydantic objects, and server-side enforcement of permissions and infosec levels.

  6. Overview of Istari Digital Connect

    Connect is the mechanism for integrating engineering tools and data sources into an existing Istari Digital Platform. It allows users to install modules for specific tools and register third-party applications (such as Teamwork Cloud, Windchill, Google Drive, and Microsoft 365). By registering a Resource, the platform centralizes its identity (UUID, revision history, permissions) while the actual content remains in the original source application or object store, enabling a digital thread without migrating all files to a new repository.

  7. Overview of Secure Connections for resource sharing

    Secure Connections allow you to share individual models or artifacts with partner organizations via a 'Sending Connection' configured by an administrator. Once shared, the Istari Digital Platform keeps the partner's copy in sync as new revisions are uploaded or new artifacts are produced.

    Key Constraints:

    • Scope: Only models and artifacts can be shared; entire systems cannot be shared.
    • File Size Limit: Individual files larger than ~2 GB are rejected and will not be transferred.
    • Revocation: Unsharing a resource sends a revocation signal that 'tombstones' the partner's copy (best-effort, eventually consistent). It cannot purge data already exported or downloaded by the partner.
    • Availability: Requires a Sending Connection configured by an organization administrator.

  8. Overview of Istari Digital Agents

    An Istari Digital Agent is a service that runs on a host machine (VM or physical workstation) where engineering tools are installed. The agent registers with the Istari Digital platform and executes jobs submitted via the web app or Python using the modules installed on that host. A single agent can host multiple modules; therefore, the host OS should be chosen based on the prerequisites of the specific tools/modules required.

  9. Overview of Istari Digital Platform User Roles

    The platform defines four primary roles with distinct responsibilities:

    • Infra team: Handles platform installation in network/cloud, deployment flags (infosec, Secure Connections), and Inbox/Outbox bucket registration.
    • IT administrator: Installs agents and integration modules, grants admin access, and troubleshoots cluster, registry, sync, and agent health.
    • Organization administrator: Manages user invitations, tool access, control tags, agent pools, app integrations, and Secure Connections (Sending/Receiving).
    • Engineer: Creates systems, manages models/artifacts, runs jobs/extractions on agents, writes automation scripts, and shares resources via Secure Connections.

  11. Overview of Secure Connections

    Secure Connections allow an organization to exchange resources with partner registries via authenticated and encrypted channels. There are two types of connections:

    • Sending Connection: Pushes data owned by your organization to a partner.
    • Receiving Connection: Pulls data that a partner pushes to your organization.

    Prerequisites: The Secure Connection Service (SCS) must be installed and configured at the infrastructure level (including Helm chart, S3 buckets, and Master Key) before these features are available.

    Access: The Secure Connections admin section is located at Admin hub > Secure Connections (or /admin/secure-connections) and is visible only to organization administrators.