Skip to main content

Model Libraries

The Model Libraries view in Data Refinery Studio provides a centralized interface for managing Construction Kit (CK) model libraries within a tenant. It shows all installed and available libraries, their versions, compatibility status, and provides tools for importing and updating libraries.

Accessing Model Libraries​

Navigate to Repository > Model Libraries in the sidebar menu.

Library Overview​

The main view displays all known CK model libraries in a list, combining information from:

  • Installed models in the current tenant (via GraphQL)
  • Available models from configured catalog sources (via REST API)

Each library entry shows:

  • Name — Click to open the Versions dialog
  • Version — Installed version and/or available catalog version
  • Dependencies — Dependencies of the installed version
  • State badge — Current status (see below)
  • Action button — Available action (see below)

State Badges​

BadgeMeaning
Available (green)Model is installed and up to date
Unavailable (red)Model has unresolved dependencies (ResolveFailed)
Importing (orange)Model import is currently in progress
Not Installed (gray)Model exists in catalog but is not installed
Service-Managed (violet)Model is managed by OctoMesh services (System, System.Identity, etc.)
Incompatible (gray, with tooltip)Model requires a different major version of a system model

Action Buttons​

Only one action button is shown per model:

  • Install — Model is not yet installed
  • Fix — Model is installed but has ResolveFailed status
  • Update — A newer compatible version is available in catalogs
  • No button for service-managed or incompatible models

Filtering & Search​

The filter bar at the top provides:

  • Category filters: All, Installed, Not Installed, Updates, New Versions — each showing the count of matching models
  • Text search: Filter by model name or version
  • Fix All button: Appears when models need action; opens the import dialog for all models at once

Versions Dialog​

Click on a model name to open the Available Versions dialog. It shows:

  • All versions available across catalogs, sorted newest first
  • The currently installed version highlighted with an "Installed" badge
  • An Install button per non-installed version
  • Click on a version to expand and see its full dependency tree (loaded on demand)

Import Dialog​

When clicking Install, Update, Fix, or Fix All, the Import Dialog opens:

  1. Dependency tree — Shows all transitive dependencies with their status:
    • install (blue) — needs to be imported
    • update (orange) — different version will be imported
    • none (green) — already installed or service-managed
    • incompatible (red) — requires incompatible system version
  2. Migration warning — If the import triggers a CK model migration, details are shown including breaking change indicators
  3. Import summary — Lists all models that will be imported as badges
  4. Incompatibility warning — If any transitive dependency is incompatible, the Import button is disabled with an explanation
  5. Import button — Shows the count of models to import; disabled if incompatible

After clicking Import, each model is imported sequentially via background jobs. A progress dialog tracks each job individually, showing the model name and progress counter (e.g., "Importing Industry.Basic-2.1.0 (1/2)").

Fix All​

The Fix All button in the filter bar:

  1. Resolves dependencies for all models needing action
  2. Opens the Import Dialog with the combined dependency tree
  3. Shows a summary of all models that will be imported
  4. After confirmation, imports all models in dependency order