# Altium Common Data Model (CDM)

> The Altium Common Data Model (CDM) describes the entities of the Altium platform — projects, components, BOMs, tasks, users and many more — as a LinkML schema. For each class it records what the entity is, how it relates to other entities, how it is identified by a GRID (Global Resource ID) and, where one exists, its type in the API.

This file follows https://llmstxt.org/. Its links are absolute; the links in the files under `llms/` are relative to the file that contains them. `llms-ctx.txt` holds this file, the pages and the catalogues in one file, and `llms-full.txt` also the class and enumeration cards; their links are absolute.

The model has 176 classes: 154 concrete domain classes, listed in the catalogues below, and 22 core, abstract and mixin classes, including LinkML's `Any`. 172 of them belong to one of the 16 bounded contexts (LinkML subsets); 4 classes belong to none and are listed in [llms/core.md](https://altiumdeveloper.github.io/cdm/llms/core.md).

- Class names are `{prefix}_{ClassName}` (`lib_Component`). Each card gives the class IRI; it is usually `{prefix}:{ClassName}` (`lib:Component`) — `system_*` classes use `sys:`, and a few IRIs differ from the name (see [VIOLATIONS.md](https://github.com/AltiumDeveloper/cdm/blob/main/VIOLATIONS.md)).
- Slot names usually follow `{prefix}_{ClassName}_{fieldName}`; the JSON key is always the slot's `alias` (the Field column of a card).
- Every domain class other than a mixin specialises a base class of the `core` subset: Artifact or Activity (entities, identified by a GRID), Resource (a lightweight object, usually part of an entity, with no GRID) or Event (a record of something that happened, with no GRID).
- `llms/<bounded context>.md` lists the classes of a bounded context with their kind, API type and GRID template. `llms/classes/<class>.md` is a class card: name, IRI, bounded context, kind, parent and mixins; the description; product documentation and product terms (In the product); the Platform API or Nexar type (In the API); mappings to standards (In standards); the GRID template; the attributes with range, cardinality and the core relation each specialises; and the slots of other classes that refer to it. `llms/enums/<enumeration>.md` lists the permissible values of an enumeration.
- `hub.json` holds the product, API and standards data and the GRID template of every concrete domain class.
- API types are checked against a snapshot of the Platform API schema retrieved on 2026-09-29.

## Start here

- [About](https://altiumdeveloper.github.io/cdm/llms/pages/about.md): what the CDM is: bounded contexts, kinds of entities, the API behind the model and the hub data
- [GRIDs](https://altiumdeveloper.github.io/cdm/llms/pages/grid-format.md): the GRID format, the GRID template of every class that declares one, prefixes and IRIs
- [Domain Model](https://altiumdeveloper.github.io/cdm/llms/pages/domain-model.md): how the schema is organised: base classes, relations, identity, names; the bounded contexts
- [Entity Classification](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md): the base classes Entity, Artifact, Activity, Resource and Event, the mixins, and how a class is classified
- [Relation Types](https://altiumdeveloper.github.io/cdm/llms/pages/relation-types.md): the core relations, their inverses and mappings, and how domain relations specialise them
- [Glossary](https://altiumdeveloper.github.io/cdm/llms/pages/glossary.md): product terms and class names, with the class each one names

## Bounded contexts

- [core](https://altiumdeveloper.github.io/cdm/llms/core.md): Holds the abstract foundations shared by every bounded context: the base classes Entity (specialised as Artifact and Activity), Resource and Event; the mixins that add annotations such as GRID, maturity and API type; shared slots such as id and name; and the abstract relations (e.g. part of, input of, derived from) that domain relations specialise. (11 base classes and mixins)
- [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md): Models the platform-wide objects that other bounded contexts build on: organizations (Company Accounts) with their users and user groups, Workspaces with their members and groups, applications, event subscriptions, and Renesas 365 solutions with their releases. (14 classes; 2 base classes and mixins)
- [configuration](https://altiumdeveloper.github.io/cdm/llms/configuration.md): Models environment configurations, which restrict the Altium Designer working environment of the Workspace members they target to approved configuration data, together with schematic templates and their revisions stored as Workspace Items. (3 classes)
- [collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md): Models collaboration on Workspace content: comment threads attached to a point, object or area of a document, the individual comments in each thread, and tasks that assign work to users or teams. (3 classes)
- [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md): Models ways to customize and automate a Workspace: process workflows, and scripts with their versions, their executions and the event raised when an execution completes. (5 classes)
- [design](https://altiumdeveloper.github.io/cdm/llms/design.md): Models design projects stored in a Workspace, including multi-board and harness projects, with their parameters, variants and releases, the manufacturing packages shared from releases, project templates with their revisions, rule checks run against projects, and design reviews of projects. (12 classes)
- [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md): Models an embedded device (e.g. an MCU), which the CDM calls a digital twin: its processors; its address map with memories, registers, bit fields and their enumerated values; its peripherals with their instances, modes and configurations; and its pins and ports with the alternative functions of each port. (24 classes)
- [insights](https://altiumdeveloper.github.io/cdm/llms/insights.md): Models insights: findings, detected asynchronously, that give the user insight within one domain area and can be followed up by tasks. (2 classes; 1 base class or mixin)
- [library](https://altiumdeveloper.github.io/cdm/llms/library.md): Models the components stored in a Workspace and their revisions, the symbols, footprints, parameters, datasheets and part choices that make them up, and the component templates they can be created from. (22 classes)
- [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md): Models over-the-air (OTA) firmware and software updates: devices with the packages installed on them, fleets that group devices, packages with their version, size, checksums and target hardware, deployments that request packages to be rolled out to a device or fleet, and the deployment results that record the outcome on each targeted device. (7 classes)
- [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md): Models bills of materials: BOMs kept in a Workspace and worked on in the BOM Portal (managed and consolidated BOMs) with their releases, global BOMs, which are not tied to a Workspace, and BOM lines with their alternate and substitute parts and the issues found when a BOM is analysed. (8 classes; 3 base classes and mixins)
- [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md): Models the supply catalog: manufacturer parts with their aggregated sourcing data and distributor offers, the companies acting as their manufacturers or distributors, and the vendor-specific part family hierarchy, along with catalog content such as reference designs, evaluation kits, solution templates and software projects. (9 classes)
- [software](https://altiumdeveloper.github.io/cdm/llms/software.md): Models the embedded software of a Renesas 365 solution: software projects with their releases and build artifacts, device configurations (with revisions) and their pin assignments, and AI models. (8 classes)
- [system](https://altiumdeveloper.github.io/cdm/llms/system.md): Models the Electronic System Design (ESD) document of a Renesas 365 solution: a system-level block diagram of functional blocks with their key (hardware) and software components, ports and parameters, the connections between blocks, and entries for the hardware and software projects that implement the system. (12 classes; 1 base class or mixin)
- [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md): Models the System Data Model (SDM) of a Renesas 365 solution and its versions, each combining a functional model with device, hardware and software models, plus metadata recording who created a version and with which application, and client-specific metadata (e.g. for ESD, Altium Designer or e² studio). (17 classes)
- [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md): Models requirements and their revisions, the specifications that group them, baselines approved for execution, change requests, the requirements projects that scope this work, and verification cases that provide evidence against requirements; most of its classes are experimental. (8 classes)

## Machine-readable data

- [hub.json](https://altiumdeveloper.github.io/cdm/hub.json): product documentation links and terms, API type, standards mappings and GRID template of every concrete domain class
- [hub.schema.json](https://altiumdeveloper.github.io/cdm/hub.schema.json): JSON Schema of hub.json
- [llms-ctx.txt](https://altiumdeveloper.github.io/cdm/llms-ctx.txt): this file, the pages and the catalogues in one file
- [llms-full.txt](https://altiumdeveloper.github.io/cdm/llms-full.txt): this file, the pages, the catalogues and all class and enumeration cards in one file

## Optional

- [Documentation site](https://altiumdeveloper.github.io/cdm/): the HTML pages, including a page for every class, slot and enumeration
- [Platform API GraphQL documentation](https://altiumdeveloper.github.io/platform-api-docs/): the types, queries and mutations of the Platform API
- [Altium 365 API](https://www.altium.com/documentation/altium-developer-center/altium-365/api): the GraphQL API to Altium 365 Workspace data, its endpoints and authentication
- [Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api): the GraphQL API for supply chain data (Nexar types)
- [Schema repository](https://github.com/AltiumDeveloper/cdm): the LinkML source (`src/common_data_model/schema/`) and the generators of JSON Schema, OWL, SHACL, GraphQL, Python and other artifacts
- [MODEL-FINDINGS.md](https://github.com/AltiumDeveloper/cdm/blob/main/MODEL-FINDINGS.md): open questions where the model and the product documentation or standards disagree

---

# File: llms/pages/about.md

# Common Data Model

The Altium Common Data Model (CDM) describes the entities of the Altium platform — projects, components, BOMs,
tasks, users and many more — as a [LinkML](https://linkml.io/) schema. For each class it records what the entity
is, how it relates to other entities, how it is identified by a GRID (Global Resource ID) and, where one
exists, its type in the API. The Altium Developer Center page
[GRID](https://www.altium.com/documentation/altium-developer-center/altium-365/key-concepts/grid) names the CDM
as the authoritative reference for the GRIDs of platform entities.

## Bounded contexts

The classes are grouped into bounded contexts (LinkML subsets), such as design, library, procurement and
collaboration. Each context has its own page with its product documentation, where it has any, and its classes. The
[home page](https://altiumdeveloper.github.io/cdm/llms.txt) lists every context with its classes and their API types.

## Entities

- **Entity** — an identifiable, versioned object with a GRID. Every entity is one of two kinds:
    - **Artifact** — a persistent data object that is created, stored, versioned and consumed, such as a
      component revision or a BOM release;
    - **Activity** — a process or work object that uses inputs and produces outputs, such as a project or a task.
- **Resource** — a lightweight object that is not an entity and has no GRID, usually part of an entity, such
  as a BOM line.
- **Event** — a record of something that happened, with no GRID.

See [Entity Classification](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md).

## The API behind the model

- [Platform API GraphQL documentation](https://altiumdeveloper.github.io/platform-api-docs/) — the reference
  of the Platform API's types, queries and mutations. Class pages link their Platform API type here.
- [Altium 365 API](https://www.altium.com/documentation/altium-developer-center/altium-365/api) on the Altium
  Developer Center — the GraphQL API to Altium 365 Workspace data: how it is organised, its endpoints,
  authentication and tools for exploring the schema.
- [Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api) on the Altium
  Developer Center — the GraphQL API for supply chain data, with its endpoint on `api.nexar.com`. Supply
  classes such as [Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) name their Nexar type.

## How class pages link out

Under its title, each class page shows the class IRI, its GRID template and its API type (the Platform API or
Nexar type; an inherited one names the class that declares it). The hub panel below has **In the product** (links
to the product documentation and the product terms for the concept) and, where the class has mappings,
**In standards** (mappings to external standards and ontologies). The hub data of the domain classes is also
published for tools as [`hub.json`](https://altiumdeveloper.github.io/cdm/hub.json), described by the JSON Schema [`hub.schema.json`](https://altiumdeveloper.github.io/cdm/hub.schema.json).

The artifacts generated from the schema (JSON Schema, OWL, SHACL, GraphQL, Python and others) are not published
on this site; they are built from the [repository](https://github.com/AltiumDeveloper/cdm) with
`make gen-project`.

## For tools

AI assistants and other tools can start from [`llms.txt`](https://altiumdeveloper.github.io/cdm/llms.txt) ([llmstxt.org](https://llmstxt.org/)): it
links a plain-markdown version of the concept pages and the glossary, a catalogue of each bounded context and a
card for every class and enumeration. [`llms-ctx.txt`](https://altiumdeveloper.github.io/cdm/llms-ctx.txt) holds llms.txt, the pages and the
catalogues in one file, [`llms-full.txt`](https://altiumdeveloper.github.io/cdm/llms-full.txt) also every card, and [`hub.json`](https://altiumdeveloper.github.io/cdm/hub.json) the hub data
of the domain classes.

## Where to go next

- [Home page](https://altiumdeveloper.github.io/cdm/llms.txt) — every bounded context and its classes.
- Concepts — [Domain Model](https://altiumdeveloper.github.io/cdm/llms/pages/domain-model.md), [Entity Classification](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md) and
  [Relation Types](https://altiumdeveloper.github.io/cdm/llms/pages/relation-types.md).
- [GRIDs](https://altiumdeveloper.github.io/cdm/llms/pages/grid-format.md) — the GRID format and the GRID templates declared by the classes.
- [Glossary](https://altiumdeveloper.github.io/cdm/llms/pages/glossary.md) — product terms and class names.

---

# File: llms/pages/grid-format.md

# GRIDs

A **GRID** (Global Resource ID) is the platform-wide identifier of an entity on the Altium platform, such as a
project, a component, a BOM or a task. The format is defined by the platform and documented on the
Altium Developer Center page [GRID](https://www.altium.com/documentation/altium-developer-center/altium-365/key-concepts/grid);
that page is the authority for the format. This page explains how the CDM uses GRIDs and lists the GRID template
the schema declares for each class, grouped by bounded context.

## Format

```text
grid:area:[tenant-id]:context:resource-type/resource-id
```

In short (see the [official page](https://www.altium.com/documentation/altium-developer-center/altium-365/key-concepts/grid)
for the full definition):

- The **context path** `area:[tenant-id]:context` uses `:` as separator; the **resource path**
  `resource-type/resource-id` uses `/` and is defined by the bounded context. Sub-resources extend the resource
  path (`resource-type/id/sub-type/sub-id`).
- `area` is one of `global`, `workspace`, `supply`, `community`, `manufacture`.
- `tenant-id` identifies the owning tenant (the Workspace GUID for Workspace resources). It is left empty for
  resources that no tenant owns, which gives a double colon (`::`).
- `context` names the bounded context, `resource-type` the kind of entity, and `resource-id` is the entity's
  **local identifier** — a GUID in some contexts, a number in others; it is not always a UUID.
- GRIDs are **case-sensitive**.

### Design principles

- **Brand- and product-agnostic** — area names follow OAuth scope areas and contain no product names, so GRIDs
  stay valid when products are renamed.
- **Readable** — the resource type is a human-readable name from the domain vocabulary, so a GRID shows what kind
  of entity it identifies and which context owns it.

### Why GRIDs exist

Most platform entities have a local ID — a GUID or a number — that is unique only where it was issued: two
projects in different Workspaces may share a GUID, and the ID of a supply part is meaningful only to the supply
system. A local ID alone therefore cannot identify an entity when services, events or integrations exchange references.
Some Platform API entities still expose opaque, base64-encoded node IDs from the underlying GraphQL framework;
these are being replaced by GRIDs step by step.

A GRID therefore provides:

1. **Uniqueness** — one stable identifier that is unique across the whole platform.
2. **Context in the identifier** — the GRID carries the area, tenant, bounded context and resource type next to
   the local ID, so the platform can locate the entity from the GRID alone. The Platform API gateway uses this
   to route a `node(id: …)` query to the right subgraph.

## Catalogue

The GRID template of every class that declares one, per bounded context. Templates are informational
and are declared per class in the `grid` annotation.

### Platform

Bounded context page: [Platform](https://altiumdeveloper.github.io/cdm/llms/platform.md).

| Entity | GRID template |
| --- | --- |
| [Application](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Application.md) | `grid:global::platform:app/{id}` |
| [Event Subscription](https://altiumdeveloper.github.io/cdm/llms/classes/plt_EventSubscription.md) | `grid:global::events:subscription/{id}` |
| [Lifecycle Definition](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleDefinition.md) | `grid:workspace:{workspace-id}:platform:lifecycle-definition/{id}` |
| [Revision Naming Scheme](https://altiumdeveloper.github.io/cdm/llms/classes/plt_NamingScheme.md) | `grid:workspace:{workspace-id}:platform:revision-naming-scheme/{id}` |
| [Organization](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Organization.md) | `grid:global::platform:organization/{id}` |
| [Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | `grid:workspace:{workspace-id}:platform:solution/{id}` |
| [Solution Release](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionRelease.md) | `grid:workspace:{workspace-id}:platform:solution-release/{id}` |
| [User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md) | `grid:global::platform:user/{id}` |
| [User Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_UserGroup.md) | `grid:global::platform:group/{id}` |
| [Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md) | `grid:global::platform:workspace/{id}` |
| [Workspace Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceGroup.md) | `grid:workspace:{workspace-id}:team:group/{id}` |
| [Workspace User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) | `grid:workspace:{workspace-id}:team:user/{id}` |

### Design

Bounded context page: [Design](https://altiumdeveloper.github.io/cdm/llms/design.md).

| Entity | GRID template |
| --- | --- |
| [Design Review](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | `grid:workspace:{workspace-id}:design:design-review/{id}` |
| [Manufacturing Package](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md) | `grid:workspace:{workspace-id}:design:manufacturing-package/{id}` |
| [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | `grid:workspace:{workspace-id}:design:project/{id}` |
| [Hardware Project Release](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | `grid:workspace:{workspace-id}:design:project-release/{id}` |
| [Project Template](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md) | `grid:workspace:{workspace-id}:design:project-template/{id}` |
| [Project Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplateRevision.md) | `grid:workspace:{workspace-id}:design:project-template-revision/{id}` |
| [Rule Check](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheck.md) | `grid:workspace:{workspace-id}:design:rule-check/{id}` |
| [Rule Check Execution](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheckExecution.md) | `grid:workspace:{workspace-id}:design:rule-check-execution/{id}` |

### Insights

Bounded context page: [Insights](https://altiumdeveloper.github.io/cdm/llms/insights.md).

| Entity | GRID template |
| --- | --- |
| [Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md) | `grid:workspace:{workspace-id}:insights:insight/{id}` |

### Library Management

Bounded context page: [Library Management](https://altiumdeveloper.github.io/cdm/llms/library.md).

| Entity | GRID template |
| --- | --- |
| [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) | `grid:workspace:{workspace-id}:library:component/{id}` |
| [Component Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | `grid:workspace:{workspace-id}:library:component-revision/{id}` |
| [Component Template](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplate.md) | `grid:workspace:{workspace-id}:library:component-template/{id}` |
| [Component Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md) | `grid:workspace:{workspace-id}:library:component-template-revision/{id}` |
| [Datasheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Datasheet.md) | `grid:workspace:{workspace-id}:library:datasheet/{id}` |
| [Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) | `grid:workspace:{workspace-id}:library:footprint/{id}` |
| [Footprint Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md) | `grid:workspace:{workspace-id}:library:footprint-revision/{id}` |
| [Managed Sheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md) | `grid:workspace:{workspace-id}:library:managed-sheet/{id}` |
| [Managed Sheet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) | `grid:workspace:{workspace-id}:library:managed-sheet-revision/{id}` |
| [Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | `grid:workspace:{workspace-id}:library:part/{id}` |
| [Part Request](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartRequest.md) | `grid:workspace:{workspace-id}:library:part-request/{id}` |
| [Reuse Block](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlock.md) | `grid:workspace:{workspace-id}:library:reuse-block/{id}` |
| [Reuse Block Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) | `grid:workspace:{workspace-id}:library:reuse-block-revision/{id}` |
| [Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) | `grid:workspace:{workspace-id}:library:symbol/{id}` |
| [Symbol Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md) | `grid:workspace:{workspace-id}:library:symbol-revision/{id}` |

### Collaboration

Bounded context page: [Collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md).

| Entity | GRID template |
| --- | --- |
| [Comment Thread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md) | `grid:workspace:{workspace-id}:collaboration:comment-thread/{id}` |
| [Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) | `grid:workspace:{workspace-id}:collaboration:task/{id}` |

### Procurement

Bounded context page: [Procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md).

| Entity | GRID template |
| --- | --- |
| [BOM Release](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | `grid:workspace:{workspace-id}:procurement:bom-release/{id}` |
| [Consolidated BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ConsolidatedBOM.md) | `grid:workspace:{workspace-id}:procurement:consolidated-bom/{id}` |
| [Global BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_GlobalBOM.md) | `grid:global::procurement:bom/{id}` |
| [Managed BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ManagedBOM.md) | `grid:workspace:{workspace-id}:procurement:bom/{id}` |

### Supply

Bounded context page: [Supply](https://altiumdeveloper.github.io/cdm/llms/supply.md).

| Entity | GRID template |
| --- | --- |
| [Company](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Company.md) | `grid:supply::platform:company/{id}` |
| [Evaluation Kit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) | `grid:supply::platform:eval-kit/{id}` |
| [Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md) | `grid:supply::platform:part/{id}/offer/{offerID}` |
| [Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | `grid:supply::platform:part/{id}` |
| [Part Family](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md) | `grid:supply::platform:part-family/{id}` |
| [Part Group](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) | `grid:supply::platform:part-group/{id}` |
| [Reference Design](https://altiumdeveloper.github.io/cdm/llms/classes/sup_ReferenceDesign.md) | `grid:supply::platform:ref-design/{id}` |
| [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md) | `grid:supply::platform:software-project/{id}` |
| [Solution Template](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md) | `grid:supply::platform:solution-template/{id}` |

### Customization

Bounded context page: [Customization](https://altiumdeveloper.github.io/cdm/llms/customization.md).

| Entity | GRID template |
| --- | --- |
| [Script](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Script.md) | `grid:workspace:{workspace-id}:scripts:script/{id}` |
| [Script Execution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md) | `grid:workspace:{workspace-id}:scripts:execution/{id}` |
| [Script Version](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md) | `grid:workspace:{workspace-id}:scripts:script-version/{id}` |
| [Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) | `grid:workspace:{workspace-id}:customization:workflow/{id}` |

### System Design

Bounded context page: [System Design](https://altiumdeveloper.github.io/cdm/llms/system.md).

| Entity | GRID template |
| --- | --- |
| [ESD Document](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md) | `grid:workspace:{workspace-id}:system-design:esd/{id}` |
| [Global ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_GlobalESD.md) | `grid:global::system-design:esd/{id}` |

### System Design - System Data Model

Bounded context page: [System Design - System Data Model](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md).

| Entity | GRID template |
| --- | --- |
| [System Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) | `grid:workspace:{workspace-id}:system-design:sdm/{id}` |
| [System Model Version](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | `grid:workspace:{workspace-id}:system-design:sdm-version/{id}` |

### Requirements

Bounded context page: [Requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md).

| Entity | GRID template |
| --- | --- |
| [Requirements Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | `grid:workspace:{workspace-id}:requirements:project/{id}` |
| [Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | `grid:workspace:{workspace-id}:requirements:requirement/{id}` |
| [Requirement Baseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | `grid:workspace:{workspace-id}:requirements:baseline/{id}` |
| [Requirement Change Request](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | `grid:workspace:{workspace-id}:requirements:change-request/{id}` |
| [Requirement Revision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) | `grid:workspace:{workspace-id}:requirements:requirement-revision/{id}` |
| [Requirement Specification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | `grid:workspace:{workspace-id}:requirements:specification/{id}` |
| [Verification Case](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | `grid:workspace:{workspace-id}:requirements:verification-case/{id}` |

### Device Model

Bounded context page: [Device Model](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md).

| Entity | GRID template |
| --- | --- |
| [FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) | `grid:global::device-model:fullstack-dm/{id}` |

### Software

Bounded context page: [Software](https://altiumdeveloper.github.io/cdm/llms/software.md).

| Entity | GRID template |
| --- | --- |
| [AI Model](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md) | `grid:workspace:{workspace-id}:software:ai-model/{id}` |
| [Device Configuration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md) | `grid:workspace:{workspace-id}:software:device-configuration/{id}` |
| [Device Configuration Revision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md) | `grid:workspace:{workspace-id}:software:device-configuration-revision/{id}` |
| [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | `grid:workspace:{workspace-id}:software:software-project/{id}` |
| [Software Release](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) | `grid:workspace:{workspace-id}:software:software-release/{id}` |

### Over-the-Air Updates

Bounded context page: [Over-the-Air Updates](https://altiumdeveloper.github.io/cdm/llms/ota.md).

| Entity | GRID template |
| --- | --- |
| [Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) | `grid:workspace:{workspace-id}:ota:deployment/{id}` |
| [Deployment Result](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) | `grid:workspace:{workspace-id}:ota:deployment-result/{id}` |
| [Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | `grid:workspace:{workspace-id}:ota:device/{id}` |
| [Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md) | `grid:workspace:{workspace-id}:ota:fleet/{id}` |
| [Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) | `grid:workspace:{workspace-id}:ota:package/{id}` |

## The GRID context is not the CDM subset

The `context` segment is the platform's bounded-context name, which often but not always equals the CDM subset.
For example, the system classes use `system-design`, the full-stack device model uses `device-model`, supply
records use context `platform` in area `supply`, scripts use `scripts`, Workspace users and groups use `team`,
and event subscriptions use `events`. The catalogue above is grouped by bounded context; the GRID context of a
class is the `context` segment of its template.

## GRIDs in the schema

- `GRID` is a scalar type in `core.yaml` with base `str`. LinkML does not validate the content of a GRID string;
  the platform defines and enforces the format.
- Every class under `core_Entity` inherits the identifier slot `core_id` (alias `id`), whose range is `GRID`.
  Resources (`core_Resource`) have no GRID; some of them (27 of 63 concrete Resources) have `core_localId`,
  an identifier that is unique only within its context. See [Entity Classification](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md).
- A class documents the GRID of its instances with a `grid` annotation — a **template** with placeholders:
  `{workspace-id}` for the tenant, `{id}` for the local ID, and a named placeholder for a sub-resource ID
  (`{offerID}` in `sup_Offer`). The annotation is informational: it is shown in the documentation and consumed
  by tooling, and it does not affect LinkML validation. `cdm-lint` checks that it has the shape of a GRID
  (rule LINT-07).

```yaml
system_ESDDocument:
  is_a: core_Activity
  in_subset: system
  class_uri: sys:ESDDocument
  annotations:
    grid: grid:workspace:{workspace-id}:system-design:esd/{id}
    platformAPI: SysEsdDocument
```

Not every entity class has a template yet; the catalogue lists those that do.

## GRIDs and schema IRIs

A GRID identifies an **instance** on the platform. Classes, slots and enums of the schema are identified by
**IRIs**, declared with `class_uri`, `slot_uri` and `enum_uri`:

| Element | Pattern | Example |
| --- | --- | --- |
| Class | `prefix:ClassName` | `sys:ESDDocument` |
| Class-specific slot | `prefix:ClassName_fieldName` | `sys:ESDDocument_functionalBlocks` |
| Enum | `prefix:EnumName` | `sys:PortType` |

Each prefix expands to a namespace declared by the schema files:

Every prefix declared by the schema files, with the bounded context that owns the namespace where it has the form `https://w3id.org/altium/cdm/<subset>/`.

| Prefix | Namespace | Bounded context |
| --- | --- | --- |
| `cdm` | `https://w3id.org/altium/cdm/` |  |
| `col` | `https://w3id.org/altium/cdm/collaboration/` | [Collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md) |
| `con` | `https://w3id.org/altium/cdm/configuration/` | [Configuration Management](https://altiumdeveloper.github.io/cdm/llms/configuration.md) |
| `core` | `https://w3id.org/altium/cdm/core/` | [Core](https://altiumdeveloper.github.io/cdm/llms/core.md) |
| `cus` | `https://w3id.org/altium/cdm/customization/` | [Customization](https://altiumdeveloper.github.io/cdm/llms/customization.md) |
| `des` | `https://w3id.org/altium/cdm/design/` | [Design](https://altiumdeveloper.github.io/cdm/llms/design.md) |
| `dm` | `https://w3id.org/altium/cdm/deviceModel/` | [Device Model](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md) |
| `ins` | `https://w3id.org/altium/cdm/insights/` | [Insights](https://altiumdeveloper.github.io/cdm/llms/insights.md) |
| `lib` | `https://w3id.org/altium/cdm/library/` | [Library Management](https://altiumdeveloper.github.io/cdm/llms/library.md) |
| `linkml` | `https://w3id.org/linkml/` |  |
| `obo` | `http://purl.obolibrary.org/obo/` |  |
| `ota` | `https://w3id.org/altium/cdm/ota/` | [Over-the-Air Updates](https://altiumdeveloper.github.io/cdm/llms/ota.md) |
| `plt` | `https://w3id.org/altium/cdm/platform/` | [Platform](https://altiumdeveloper.github.io/cdm/llms/platform.md) |
| `pro` | `https://w3id.org/altium/cdm/procurement/` | [Procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md) |
| `prov` | `http://www.w3.org/ns/prov#` |  |
| `req` | `https://w3id.org/altium/cdm/requirement/` | [Requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md) |
| `schema` | `http://schema.org/` |  |
| `sft` | `https://w3id.org/altium/cdm/software/` | [Software](https://altiumdeveloper.github.io/cdm/llms/software.md) |
| `shex` | `http://www.w3.org/ns/shex#` |  |
| `sup` | `https://w3id.org/altium/cdm/supply/` | [Supply](https://altiumdeveloper.github.io/cdm/llms/supply.md) |
| `sys` | `https://w3id.org/altium/cdm/system/` | [System Design](https://altiumdeveloper.github.io/cdm/llms/system.md) |
| `xsd` | `http://www.w3.org/2001/XMLSchema#` |  |

A new subset prefix needs formal approval of the subset it belongs to (see `AGENTS.md` §6 in the repository). External vocabulary prefixes allow-listed for mappings (`prov:`, `obo:`) are exempt.

### Resolving IRIs through w3id.org

IRIs under `https://w3id.org/altium/cdm/` are redirected by the [w3id.org](https://w3id.org/) persistent
identifier service to this documentation site; the redirects are currently temporary (HTTP 302). Not every
class IRI resolves yet (MF-076): IRIs in the `system` namespace, such as
`https://w3id.org/altium/cdm/system/ESDDocument`, redirect to `classes/sys_<Class>/`, which does not exist (the
pages are `classes/system_<Class>/`), and IRIs in the `requirement` namespace (for example
`https://w3id.org/altium/cdm/requirement/Requirement`) get a 404 from w3id.org, which redirects only the
`requirements/` path. Rules for changing the redirects:

- Keep redirects temporary (`R=302`) until the target URL is confirmed correct and stable.
- Never deploy a permanent redirect (`R=301`) to an unverified target: browsers and ontology tools cache
  permanent redirects, and there is no easy way to roll them back.
- Switch to `R=301` only after the target has been confirmed, tested and merged in the w3id.org repository.

---

# File: llms/pages/domain-model.md

# Domain Model

The Altium Common Data Model (CDM) describes the data of the Altium platform as a
[LinkML](https://linkml.io/) schema. Its classes are grouped into **bounded contexts** (LinkML subsets), and each
schema file holds one context (`system.yaml` holds two); the root schema `common_data_model.yaml` imports them all. This
documentation and the generated artifacts (JSON Schema, OWL, SHACL, GraphQL, Python and others) are produced
from the root schema, and `cdm-lint` checks it against the naming and documentation conventions.

## Building blocks

- **Base classes.** Every domain class other than a mixin specialises an abstract base class from the `core` subset:
  `core_Artifact` or `core_Activity` (both entities with a GRID), `core_Resource` (a lightweight part of an
  entity) or `core_Event`. Mixins add annotations and slots. See [Entity Classification](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md).
- **Relations.** Relations between domain classes should specialise abstract relations defined in `core`, such
  as *has part*, *has input* or *derived from*; 28 entity-valued slots do not yet. See
  [Relation Types](https://altiumdeveloper.github.io/cdm/llms/pages/relation-types.md).
- **Identity.** Entities are identified on the platform by a GRID (Global Resource ID); each class can declare
  the GRID template of its instances. See [GRIDs](https://altiumdeveloper.github.io/cdm/llms/pages/grid-format.md).
- **Names.** Class names carry a short context prefix and a PascalCase name (`lib_Component`, `des_Project`,
  `system_ESDDocument`); each class also has an IRI in its context's namespace (`lib:Component`). Class-specific
  slots add a camelCase field name (`req_Project_specifications`). The prefixes are listed on the
  [GRIDs](https://altiumdeveloper.github.io/cdm/llms/pages/grid-format.md#grids-and-schema-iris) page.

## Bounded contexts

Each page below describes the context, links its product documentation where it has any, and lists its classes.

- [core](https://altiumdeveloper.github.io/cdm/llms/core.md) — `core.yaml`
- [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md) — `platform.yaml`
- [configuration](https://altiumdeveloper.github.io/cdm/llms/configuration.md) — `configuration.yaml`
- [collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md) — `collaboration.yaml`
- [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md) — `customization.yaml`
- [design](https://altiumdeveloper.github.io/cdm/llms/design.md) — `design.yaml`
- [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md) — `device_model.yaml`
- [insights](https://altiumdeveloper.github.io/cdm/llms/insights.md) — `insights.yaml`
- [library](https://altiumdeveloper.github.io/cdm/llms/library.md) — `library.yaml`
- [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md) — `ota.yaml`
- [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md) — `procurement.yaml`
- [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md) — `supply.yaml`
- [software](https://altiumdeveloper.github.io/cdm/llms/software.md) — `software.yaml`
- [system](https://altiumdeveloper.github.io/cdm/llms/system.md) and [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md) — both in `system.yaml`
- [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md) — `requirement.yaml`

## Finding your way

- [Glossary](https://altiumdeveloper.github.io/cdm/llms/pages/glossary.md) — product terms and class names, including terms that mean different things in
  different contexts.
- [MODEL-FINDINGS.md](https://github.com/AltiumDeveloper/cdm/blob/main/MODEL-FINDINGS.md) — open questions where
  the model and the product documentation or standards disagree.

---

# File: llms/pages/entity-classification.md

# Entity Classification

Every domain class of the CDM specialises one of a few abstract base classes defined in the `core` subset. The
choice decides whether instances have a platform-wide identity (a [GRID](https://altiumdeveloper.github.io/cdm/llms/pages/grid-format.md)), which core
[relations](https://altiumdeveloper.github.io/cdm/llms/pages/relation-types.md) the class can take part in — their domains and ranges are stated in terms of
these base classes — and how the class relates to external ontologies. The base set is deliberately minimal;
bounded contexts refine it with their own classes and mixins.

## Base classes

Base classes and mixins of the core schema. Core mixins are attached with `instantiates`; domain mixins use `mixins:`. Neither uses `is_a`.

```text
Any
core_Entity  [instantiates: core_WithGRID, core_WithMaturity, core_WithPlatformAPI]
  core_Activity
  core_Artifact
core_Event
core_Meta
  core_WithGRID
  core_WithMaturity
  core_WithPlatformAPI
  core_WithVault
  core_WithVaultLink
core_Resource  [instantiates: core_WithPlatformAPI]
```

### Entity

[`core_Entity`](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) is the abstract root of identifiable, versioned, platform-accessible
domain objects. It is never used directly: every entity is either an Artifact or an Activity. It has the
identifier slot `core_id`, whose range is `GRID`, and it instantiates three core mixins, which allow these
class-level annotations:

- `grid` — the GRID template of the class (`core_WithGRID`);
- `maturity` — `EXPERIMENTAL`, `PRODUCTION` or `OBSOLETE` (`core_WithMaturity`); `cdm-lint` treats a class
  without the annotation as `PRODUCTION`;
- `platformAPI` / `nexarAPI` — the Altium 365 Platform API or Nexar GraphQL type of the class
  (`core_WithPlatformAPI`).

### Artifact

[`core_Artifact`](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md): a persistent data object that is created, stored, versioned and
consumed. Artifacts are the things other work refers to or uses. Typical Artifacts in the schema:

- library items and their revisions — [lib_Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md),
  [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md), [lib_Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md);
- templates — [des_ProjectTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md),
  [con_SchematicTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplate.md);
- snapshots and releases — [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md),
  [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md), [sft_SoftwareRelease](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md),
  [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md);
- produced outputs — [des_ManufacturingPackage](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md),
  [sft_BuildArtifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md);
- platform and catalogue records — [plt_Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md), [plt_User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md),
  [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md), [sup_Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md).

### Activity

[`core_Activity`](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md): a process or work object — something that happens, uses inputs and
produces outputs. Typical Activities in the schema:

- projects and documents that organise ongoing work — [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md),
  [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md), [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md),
  [system_ESDDocument](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md), [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md),
  [system_SdmSystemModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md);
- the editable working state of a BOM — [pro_ManagedBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ManagedBOM.md) and
  [pro_ConsolidatedBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ConsolidatedBOM.md) (both through `pro_BomWIP`);
- work items and requests — [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md), [col_CommentThread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md),
  [lib_PartRequest](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartRequest.md),
  [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md);
- process runs — [des_RuleCheckExecution](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheckExecution.md).

### Resource

[`core_Resource`](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md) is **not** an Entity. A Resource is a lightweight object that
typically exists as part of an Entity: it has no GRID and no versioning lifecycle of its own, but it can have a
Platform API type (`core_Resource` instantiates `core_WithPlatformAPI`). Examples: BOM lines
([pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md)), parameters and variants
([des_ProjectParameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md), [des_ProjectVariant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md)),
lifecycle stages and states ([plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md)), comments
([col_Comment](https://altiumdeveloper.github.io/cdm/llms/classes/col_Comment.md)), the contents of a device model
([dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md), [dm_PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md)), and the
models inside a system model version ([system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md)).

About half of the Resources have no identifier slot. 27 of the 63 concrete Resources have `core_localId`, an identifier that
is unique only within its context — for example `dm_Peripheral`, `dm_PortConfiguration` and
`system_SdmFunctionalModel`; five device-model Resources use a natural key instead, such as the name of a pin
(`dm_Pin`) or a start address (`dm_Register`).

### Event

[`core_Event`](https://altiumdeveloper.github.io/cdm/llms/classes/core_Event.md) is the abstract base for domain events: things that happened, with no GRID
and no versioning lifecycle. The schema currently has one event class,
[cus_ScriptExecutionCompleted](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecutionCompleted.md).

### Mixins

Mixins extend `core_Meta` and are never used as a parent with `is_a`.

- The **core mixins** are attached with `instantiates`: `core_WithGRID`, `core_WithMaturity` and
  `core_WithPlatformAPI` on `core_Entity`, `core_WithPlatformAPI` on `core_Resource`. `core_WithVaultLink` is
  attached to one slot (`lib_ComponentRevision_template`); `core_WithVault` is defined but not attached anywhere
  yet.
- **Domain mixins** add slots and are attached with `mixins`, for example `plt_HasLifecycle` (a lifecycle state,
  on revision and release classes), `plt_SolutionItem` (membership in a solution, on `des_Project`,
  `sft_SoftwareProject`, `system_ESDDocument` and `sft_AIModel`) and `pro_Bom` (on the BOM classes).

## How to classify a class

The current classification follows these criteria, in this order:

| Question | If yes | Examples |
| --- | --- | --- |
| Is it a lightweight object held within another object, with no GRID of its own? | `core_Resource` | `pro_BomItem`, `dm_PortConfiguration` |
| Is it a record that something happened rather than a persistent object? | `core_Event` | `cus_ScriptExecutionCompleted` |
| Is it a project or document that organises ongoing work, or the editable working state of something? | `core_Activity` | `des_Project`, `system_ESDDocument`, `pro_ManagedBOM` |
| Is it a unit of work, a request or the run of a process? | `core_Activity` | `col_Task`, `lib_PartRequest`, `des_RuleCheckExecution` |
| Is it a stored item, revision, snapshot, release or produced output that other work uses? | `core_Artifact` | `lib_ComponentRevision`, `system_SdmSystemModelVersion`, `pro_BomRelease` |
| Is it a platform or catalogue record (user, Workspace, supply part)? | `core_Artifact` | `plt_User`, `plt_Workspace`, `sup_Part` |

A recurring pattern is a working Activity paired with Artifact snapshots of it:

- `system_SdmSystemModel` → `system_SdmSystemModelVersion`, linked by the slots `system_SdmSystemModel_versions`
  and `system_SdmSystemModel_latestVersion` (which specialise no core relation); the version is described as the
  state of the system model at a point in time.
- `des_Project` → `des_ProjectRelease`, `pro_BomWIP` (and so `pro_ManagedBOM`, `pro_ConsolidatedBOM`) →
  `pro_BomRelease`, `plt_Solution` → `plt_SolutionRelease` and `sft_SoftwareProject` → `sft_SoftwareRelease`,
  linked by `core_releases`. The project release, the BOM release and the solution release are described as
  snapshots of the project, the BOM and the solution; the software release has no description yet, so for it the
  pairing rests only on the name and the `core_releases` slot.

It is a pattern, not a rule that splits design work from released data. Exceptions and open questions, tracked
in [MODEL-FINDINGS.md](https://github.com/AltiumDeveloper/cdm/blob/main/MODEL-FINDINGS.md):

- The run of a script ([cus_ScriptExecution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md)) is an Artifact, while the run of a
  rule check is an Activity (MF-073).
- [cus_Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) is an Activity, but its Platform API type is a workflow definition
  (MF-026).
- [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) is an Activity without a description, so none of the criteria
  explains the choice, and its relations do not fit the domains and ranges of the core relations (MF-075).
- The description of `core_Artifact` in `core.yaml` names system models as examples, although
  `system_SdmSystemModel` is an Activity (its versions are Artifacts) (MF-077).

## Ontological basis

The Artifact/Activity split is aligned with the entity/activity distinction of the W3C provenance ontology
[PROV-O](https://www.w3.org/TR/prov-o/) and the continuant/occurrent distinction of the Basic Formal Ontology
([BFO](https://bfo-ontology.github.io/)). The mappings are declared in `core.yaml` and exported to OWL as
`skos:closeMatch` and `skos:relatedMatch`:

- `core_Artifact` — close match [prov:Entity](https://www.w3.org/TR/prov-o/#Entity); related match
  [BFO_0000031](http://purl.obolibrary.org/obo/BFO_0000031) (generically dependent continuant).
- `core_Activity` — close match [prov:Activity](https://www.w3.org/TR/prov-o/#Activity); related match
  [BFO_0000015](http://purl.obolibrary.org/obo/BFO_0000015) (process).

None of them is an exact match:

- The CDM classes are narrower than the PROV-O classes: they are records on the platform. `prov:Entity` is also
  broader in another way — in PROV terms a persisted project, which the CDM models as an Activity, is an entity
  too.
- Artifacts are documents, models and data — information that can be copied from one carrier to another. That is
  closer to BFO's *generically dependent continuant* than to BFO *object* (a material entity), but the CDM does
  not commit to BFO categories, so the mapping is only a related match.
- BFO *process* is an occurrent that unfolds in time, and the BFO/RO parthood relations do not let an
  occurrent have continuants as parts.
  CDM Activities are persistent, versioned records with Artifact parts (for example `req_Project_specifications`
  links a requirements project to its specifications), so this is a related match as well.

`core_Entity`, `core_Resource` and `core_Event` have no mappings. The mappings of the core relations are listed
on [Relation Types](https://altiumdeveloper.github.io/cdm/llms/pages/relation-types.md).

---

# File: llms/pages/relation-types.md

# Relation Types

The `core` subset defines a small set of **abstract relation slots** — derivation, composition, input, output,
information flow and scope. Domain classes do not use the abstract slots directly. A relation between domain
classes should be a slot that specialises one of them with `is_a`, narrowing the domain and range to concrete
classes, so that relations mean the same thing in every bounded context. The schema does not yet follow this
everywhere: 28 domain slots whose range is an entity class specialise no core relation (for example
`req_Project_changeRequests`, `ota_Device_fleets`, `cus_ScriptVersion_executions`, `lib_PartChoice_part`).

## Core relations

The table is generated from `core.yaml` and is the reference for names, domains, ranges, inverses,
transitivity and mappings. It lists the abstract slots and the specialisations that `core.yaml` itself provides:
`core_implements` / `core_implementedBy` (under `core_informedBy` / `core_informs`), `core_revisionOf` /
`core_revisions` (under `core_derivedFrom` / `core_derivesInto`) and `core_releaseOf` / `core_releases` (under
`core_outputOf` / `core_hasOutput`). Unlike the abstract slots, these specialisations are attached to domain
classes directly, with `slot_usage` narrowing the range (for example `core_releases` on `pro_BomWIP` with range
`pro_BomRelease`, and `core_revisions` on the library item classes).

Abstract relation slots defined in the core schema and their specialisations there. Domain relations specialise one of these through `is_a`; an inverse is shown when either side declares it.

| Slot | Alias | Domain → Range | Inverse | Transitive | Is a | Mappings |
| --- | --- | --- | --- | --- | --- | --- |
| [core_derivedFrom](https://altiumdeveloper.github.io/cdm/slots/core_derivedFrom/) | derivedFrom | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) | [core_derivesInto](https://altiumdeveloper.github.io/cdm/slots/core_derivesInto/) |  |  | close: [prov:wasDerivedFrom](http://www.w3.org/ns/prov#wasDerivedFrom); related: [obo:RO_0001000](http://purl.obolibrary.org/obo/RO_0001000) |
| [core_derivesInto](https://altiumdeveloper.github.io/cdm/slots/core_derivesInto/) | derivesInto | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) | [core_derivedFrom](https://altiumdeveloper.github.io/cdm/slots/core_derivedFrom/) |  |  | related: [obo:RO_0001001](http://purl.obolibrary.org/obo/RO_0001001) |
| [core_hasInput](https://altiumdeveloper.github.io/cdm/slots/core_hasInput/) | hasInput | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) | [core_inputOf](https://altiumdeveloper.github.io/cdm/slots/core_inputOf/) |  |  | close: [prov:used](http://www.w3.org/ns/prov#used); related: [obo:RO_0002233](http://purl.obolibrary.org/obo/RO_0002233) |
| [core_hasOutput](https://altiumdeveloper.github.io/cdm/slots/core_hasOutput/) | hasOutput | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) | [core_outputOf](https://altiumdeveloper.github.io/cdm/slots/core_outputOf/) |  |  | close: [prov:generated](http://www.w3.org/ns/prov#generated); close: [obo:RO_0002234](http://purl.obolibrary.org/obo/RO_0002234) |
| [core_hasPart](https://altiumdeveloper.github.io/cdm/slots/core_hasPart/) | hasPart | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) → [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) | [core_partOf](https://altiumdeveloper.github.io/cdm/slots/core_partOf/) | yes |  | related: [obo:BFO_0000051](http://purl.obolibrary.org/obo/BFO_0000051) |
| [core_implementedBy](https://altiumdeveloper.github.io/cdm/slots/core_implementedBy/) | implementedBy | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_implements](https://altiumdeveloper.github.io/cdm/slots/core_implements/) |  | [core_informs](https://altiumdeveloper.github.io/cdm/slots/core_informs/) |  |
| [core_implements](https://altiumdeveloper.github.io/cdm/slots/core_implements/) | implements | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_implementedBy](https://altiumdeveloper.github.io/cdm/slots/core_implementedBy/) |  | [core_informedBy](https://altiumdeveloper.github.io/cdm/slots/core_informedBy/) |  |
| [core_informedBy](https://altiumdeveloper.github.io/cdm/slots/core_informedBy/) | informedBy | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_informs](https://altiumdeveloper.github.io/cdm/slots/core_informs/) |  |  | close: [prov:wasInformedBy](http://www.w3.org/ns/prov#wasInformedBy) |
| [core_informs](https://altiumdeveloper.github.io/cdm/slots/core_informs/) | informs | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_informedBy](https://altiumdeveloper.github.io/cdm/slots/core_informedBy/) |  |  |  |
| [core_inputOf](https://altiumdeveloper.github.io/cdm/slots/core_inputOf/) | inputOf | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_hasInput](https://altiumdeveloper.github.io/cdm/slots/core_hasInput/) |  |  | related: [obo:RO_0002352](http://purl.obolibrary.org/obo/RO_0002352) |
| [core_occursIn](https://altiumdeveloper.github.io/cdm/slots/core_occursIn/) | occursIn | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) |  |  |  | related: [obo:BFO_0000066](http://purl.obolibrary.org/obo/BFO_0000066) |
| [core_outputOf](https://altiumdeveloper.github.io/cdm/slots/core_outputOf/) | outputOf | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | [core_hasOutput](https://altiumdeveloper.github.io/cdm/slots/core_hasOutput/) |  |  | close: [prov:wasGeneratedBy](http://www.w3.org/ns/prov#wasGeneratedBy); close: [obo:RO_0002353](http://purl.obolibrary.org/obo/RO_0002353) |
| [core_partOf](https://altiumdeveloper.github.io/cdm/slots/core_partOf/) | partOf | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) → [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) | [core_hasPart](https://altiumdeveloper.github.io/cdm/slots/core_hasPart/) | yes |  | related: [obo:BFO_0000050](http://purl.obolibrary.org/obo/BFO_0000050) |
| [core_releaseOf](https://altiumdeveloper.github.io/cdm/slots/core_releaseOf/) | releaseOf | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* → [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) *(inherited)* | [core_releases](https://altiumdeveloper.github.io/cdm/slots/core_releases/) |  | [core_outputOf](https://altiumdeveloper.github.io/cdm/slots/core_outputOf/) |  |
| [core_releases](https://altiumdeveloper.github.io/cdm/slots/core_releases/) | releases | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) *(inherited)* → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* | [core_releaseOf](https://altiumdeveloper.github.io/cdm/slots/core_releaseOf/) |  | [core_hasOutput](https://altiumdeveloper.github.io/cdm/slots/core_hasOutput/) |  |
| [core_revisionOf](https://altiumdeveloper.github.io/cdm/slots/core_revisionOf/) | revisionOf | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* | [core_revisions](https://altiumdeveloper.github.io/cdm/slots/core_revisions/) |  | [core_derivedFrom](https://altiumdeveloper.github.io/cdm/slots/core_derivedFrom/) |  |
| [core_revisions](https://altiumdeveloper.github.io/cdm/slots/core_revisions/) | revisions | [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* → [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) *(inherited)* | [core_revisionOf](https://altiumdeveloper.github.io/cdm/slots/core_revisionOf/) |  | [core_derivesInto](https://altiumdeveloper.github.io/cdm/slots/core_derivesInto/) |  |

Notes:

- Domains and ranges are stated in terms of the [base classes](https://altiumdeveloper.github.io/cdm/llms/pages/entity-classification.md): derivation links
  Artifacts, input and output link an Activity and an Artifact, information flow links Activities, and
  composition links any Entities.
- Inverse pairs are declared once, on one side; the table shows the inverse on both. `core_occursIn` has no
  inverse.
- Only `core_partOf` and `core_hasPart` are transitive (`transitive: true`; `owl:TransitiveProperty` in the OWL
  export).

## Choosing the parent relation

1. **One Artifact is produced from, or superseded by, another** → `core_derivedFrom` / `core_derivesInto`;
   for versions of the same thing, `core_revisionOf` / `core_revisions`.
2. **Whole and part** → `core_hasPart` (whole to part) or `core_partOf` (part to whole).
3. **An Activity consumes an Artifact** → `core_hasInput` (from the Activity) or `core_inputOf` (from the
   Artifact).
4. **An Activity produces an Artifact** → `core_hasOutput` or `core_outputOf`; for releases,
   `core_releases` / `core_releaseOf`.
5. **One Activity uses knowledge from another** → `core_informedBy` / `core_informs`; when one implements a
   requirement or specification, `core_implements` / `core_implementedBy`.
6. **An Activity takes place within the context of an Artifact** → `core_occursIn`.

The domain and range of the domain slot should stay within those of its parent — for example, a specialisation
of `core_hasInput` goes from an Activity to an Artifact. Current exceptions, recorded in
[MODEL-FINDINGS.md](https://github.com/AltiumDeveloper/cdm/blob/main/MODEL-FINDINGS.md):

- `ins_PartInsight_part` specialises `core_informs` (Activity to Activity) but its range `lib_Part` is an
  Artifact; `ins_PartInsight_informedBy` and `ins_PartInsight_occursIn` have range `Any` (MF-075).

## Declaring a domain relation

A relation that belongs to one class is defined under that class's `attributes:` with the three-part name
`{prefix}_{ClassName}_{fieldName}`, its own `slot_uri`, `alias`, `title`, `description`, `range`,
`multivalued` and `required` (see `AGENTS.md` §4 in the repository). An example from the requirements schema:

```yaml
# excerpt from requirement.yaml
req_Project:
  is_a: core_Activity
  attributes:
    req_Project_specifications:
      is_a: core_hasPart
      slot_uri: req:Project_specifications
      alias: specifications
      title: specifications
      description: Specifications authored or curated within this requirements project.
      range: req_RequirementSpecification
      multivalued: true
      required: true
```

Here a requirements project (an Activity) has its specifications (Artifacts) as parts. Another example is
`sft_SoftwareProject_aiModels`, which specialises `core_hasInput`: a software project uses AI models as inputs.

Never attach an abstract core slot to a class:

```yaml
# Invalid: abstract core slot used directly
req_Project:
  slots:
    - core_hasPart
```

A domain slot may declare its inverse with `inverse:`; no domain relation in the current schema does, so the
inverse direction of a domain relation is not modelled. Do not add `transitive: true` to specialisations of
non-transitive relations.

In the OWL export, only the two core composition properties are declared transitive (and in OWL a sub-property
of a transitive property is not transitive itself). `gen-owl` also keeps the `is_a` of a relation as
`rdfs:subPropertyOf` only for slots defined in the top-level `slots:` section — today 11 triples: the six core
specialisations plus `lib_uses_components`, `lib_uses_parts`, `lib_consists_of_components`,
`lib_consists_of_parts` and `sup_eval_kits`. Relations defined under `attributes:`, such as
`req_Project_specifications`, lose their parent relation in OWL (MF-074).

## Ontological basis

The relations are aligned with the W3C provenance ontology [PROV-O](https://www.w3.org/TR/prov-o/) and with the
OBO [Relation Ontology](https://obofoundry.org/ontology/ro.html) (RO), which also defines the relations
*part of*, *has part* and *occurs in* (their identifiers use the `BFO_` prefix). The **Mappings** column above
lists them; they are declared in `core.yaml` and exported to OWL as `skos:closeMatch` and `skos:relatedMatch`. None is exact, because the CDM domains and
ranges are narrower than the upper-ontology terms:

- **PROV-O** terms are close matches: `prov:wasDerivedFrom`, `prov:used`, `prov:generated`,
  `prov:wasGeneratedBy` and `prov:wasInformedBy` relate PROV entities and activities in the same directions as the
  CDM relations. PROV-O itself defines only two inverse properties, `prov:generated` and `prov:invalidated`;
  its Appendix B merely recommends names for the other inverses (such as `prov:wasUsedBy`, `prov:hadDerivation`
  and `prov:informed`), which are declared in the separate `prov-o-inverses` module. They are not mapped, so
  `core_derivesInto`, `core_inputOf` and `core_informs` have no PROV-O mapping.
- **RO has output / output of** are close matches: they only require the output to take part in the process and
  to be present at its end in a new state, which fits an Artifact produced by an Activity.
- **RO derives from / derives into** are related matches: RO defines them for material entities, where the new
  entity takes over the matter of the old one and the old one ceases to exist; CDM sources persist.
- **RO has input / input of** are related matches: RO requires a material input whose state changes during the
  process; CDM inputs are information that usually stays unchanged.
- **BFO part of / has part** are related matches: RO parthood requires compatible categories (an occurrent cannot
  have continuants as parts), while CDM composition also links Activities and Artifacts, as in
  `req_Project_specifications` above.
- **BFO occurs in** is a related match: its range is a material or immaterial entity that spatially contains the
  process, while the range of `core_occursIn` is an Artifact that gives the Activity its context.

---

# File: llms/pages/glossary.md

# Glossary

Product terms and class names of the model. A term used by several classes is listed with each meaning.

## A

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| AddressBlock | [AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) (`dm_AddressBlock`) | deviceModel | title |  |
| AddressMap | [AddressMap](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressMap.md) (`dm_AddressMap`) | deviceModel | title |  |
| AddressSegment | [AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md) (`dm_AddressSegment`) | deviceModel | title |  |
| AI Model | [AI Model](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md) (`sft_AIModel`) | software | title |  |
| Alternate | [BOM Item Alternate](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemAlternate.md) (`pro_BomItemAlternate`) | procurement | exact | [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#add_alternate) |
| Altium 365 Workspace | [Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md) (`plt_Workspace`) | platform | exact | [Altium 365 Workspace](https://www.altium.com/documentation/altium-365/workspace) |
| Altium Account | [User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md) (`plt_User`) | platform | related | [Managing Users](https://www.altium.com/documentation/altium-dashboard/managing-users) |
| Application | [Application](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Application.md) (`plt_Application`) | platform | title |  |
| Authoring Application | [Authoring Application](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmAuthoringApplication.md) (`system_SdmAuthoringApplication`) | system-sdm | title |  |

## B

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| BOM Issue | [BOM Issue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) (`pro_BomIssue`) | procurement | title | [BOM Error Detection and Correction](https://www.altium.com/documentation/altium-365/bom-portal/error-detection-correction) |
| BOM Item | [BOM Item](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) (`pro_BomItem`) | procurement | title | [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#bom-structure-features) |
| BOM Item Alternate | [BOM Item Alternate](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemAlternate.md) (`pro_BomItemAlternate`) | procurement | title | [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#add_alternate) |
| BOM Item Substitute | [BOM Item Substitute](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemSubstitute.md) (`pro_BomItemSubstitute`) | procurement | title |  |
| BOM line | [BOM Item](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) (`pro_BomItem`) | procurement | exact | [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#bom-structure-features) |
| BOM Release | [BOM Release](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) (`pro_BomRelease`) | procurement | title | [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal#release_naming) |
| Build Artifact | [Build Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md) (`sft_BuildArtifact`) | software | title |  |
| Build Package | [Manufacturing Package](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md) (`des_ManufacturingPackage`) | design | related | [Viewing Manufacturing Packages](https://www.altium.com/documentation/altium-365/viewers/manufacturing-package-viewer) |

## C

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Comment | [Comment](https://altiumdeveloper.github.io/cdm/llms/classes/col_Comment.md) (`col_Comment`) | collaboration | title | [Web Viewer](https://www.altium.com/documentation/altium-365/viewers/web-viewer#comment_placement) |
| Comment Thread | [Comment Thread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md) (`col_CommentThread`) | collaboration | title | [Web Viewer](https://www.altium.com/documentation/altium-365/viewers/web-viewer#commenting) |
| Company | [Company](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Company.md) (`sup_Company`) | supply | title |  |
| Company Account | [Organization](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Organization.md) (`plt_Organization`) | platform | exact | [Company Dashboard](https://www.altium.com/documentation/altium-dashboard) |
| Component | [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) (`lib_Component`) | library | title | [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) |
| Component Parameter | [Component Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentParameter.md) (`lib_ComponentParameter`) | library | title | [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates#UACPDT) |
| Component Revision | [Component Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) (`lib_ComponentRevision`) | library | title | [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) |
| Component Template | [Component Template](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplate.md) (`lib_ComponentTemplate`) | library | title | [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates) |
| Component Template Revision | [Component Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md) (`lib_ComponentTemplateRevision`) | library | title | [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates) |
| ConfiguredDeviceModel | [ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) (`dm_ConfiguredDeviceModel`) | deviceModel | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) |
| Consolidated BOM | [Consolidated BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ConsolidatedBOM.md) (`pro_ConsolidatedBOM`) | procurement | title | [Consolidated BOM](https://www.altium.com/documentation/altium-365/bom-portal/consolidated-bom) |

**Connection — 2 meanings**

- [Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) (`system_Connection`) — system. A connection line in an ESD document representing an interconnection between functional blocks (e.g. signals passed between the interfaces of two devices), drawn directly between blocks or between their ports.
- [Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md) (`system_SdmConnection`) — system-sdm. Represents a connection between functional blocks.

## D

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Datasheet | [Datasheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Datasheet.md) (`lib_Datasheet`) | library | title | [Adding Datasheets to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-datasheets-component) |
| Deployment | [Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) (`ota_Deployment`) | ota | title |  |
| Deployment Assignment | [Deployment Assignment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentAssignment.md) (`ota_DeploymentAssignment`) | ota | title |  |
| Deployment Result | [Deployment Result](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) (`ota_DeploymentResult`) | ota | title |  |
| Design Insight | [Design Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_DesignInsight.md) (`ins_DesignInsight`) | insights | title |  |
| design project | [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) (`des_Project`) | design | related | [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects) |
| design project release | [Hardware Project Release](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) (`des_ProjectRelease`) | design | related | [Design Project Release](https://www.altium.com/documentation/altium-designer/preparing-for-manufacture/design-release) |
| Design Review | [Design Review](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) (`des_DesignReview`) | design | title | [Design Reviews](https://www.altium.com/documentation/altium-365/project-design-reviews) |
| design variant | [Hardware Project Variant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) (`des_ProjectVariant`) | design | exact | [Design Variants](https://www.altium.com/documentation/altium-designer/design-variants) |
| Device | [Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) (`ota_Device`) | ota | title |  |
| Device Configuration | [Device Configuration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md) (`sft_DeviceConfiguration`) | software | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) |
| Device Configuration Revision | [Device Configuration Revision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md) (`sft_DeviceConfigurationRevision`) | software | title |  |
| Device Model | [Device Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md) (`system_SdmDeviceModel`) | system-sdm | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) |
| Domain Metadata | [Domain Metadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmClientMetadata.md) (`system_SdmClientMetadata`) | system-sdm | title |  |

## E

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Environment Configuration | [Environment Configuration](https://altiumdeveloper.github.io/cdm/llms/classes/con_EnvironmentConfiguration.md) (`con_EnvironmentConfiguration`) | configuration | title | [Environment Configuration Management](https://www.altium.com/documentation/altium-365/environment-configuration-management) |
| ESD Document | [ESD Document](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md) (`system_ESDDocument`) | system | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd) |
| Eval Kit | [Evaluation Kit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) (`sup_EvalKit`) | supply | exact | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#linking_an_evaluation_kit) |
| Evaluation Kit | [Evaluation Kit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) (`sup_EvalKit`) | supply | title | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#linking_an_evaluation_kit) |
| Event Subscription | [Event Subscription](https://altiumdeveloper.github.io/cdm/llms/classes/plt_EventSubscription.md) (`plt_EventSubscription`) | platform | title |  |

**Endpoint — 2 meanings**

- [Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md) (`system_Endpoint`) — system. One end of a connection in an ESD document, identified by the functional block and the port where the connection line starts or ends.
- [Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md) (`system_SdmEndpoint`) — system-sdm. Represents an endpoint of a connection.

## F

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| FieldEnum | [FieldEnum](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FieldEnum.md) (`dm_FieldEnum`) | deviceModel | title |  |
| Fleet | [Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md) (`ota_Fleet`) | ota | title |  |
| Footprint | [Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) (`lib_Footprint`) | library | title | [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) |
| Footprint Revision | [Footprint Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md) (`lib_FootprintRevision`) | library | title | [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) |
| FullStackDeviceModel | [FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) (`dm_FullStackDeviceModel`) | deviceModel | title |  |
| Functional Model | [Functional Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) (`system_SdmFunctionalModel`) | system-sdm | title |  |

**Functional Block — 2 meanings**

- [Functional Block](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) (`system_FunctionalBlock`) — system. Represents a logical block within an ESD document (e.g., MCU subsystem, LED driver block) that stands for a function, operation or device of the system, including parameters, key components, software components, ports, and associations.
- [Functional Block](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) (`system_SdmFunctionalBlock`) — system-sdm. Represents a logical block within a system functional model.

## G

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Global BOM | [Global BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_GlobalBOM.md) (`pro_GlobalBOM`) | procurement | title |  |
| Global ESD | [Global ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_GlobalESD.md) (`system_GlobalESD`) | system | title |  |

## H

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Hardware Model | [Hardware Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) (`system_SdmHardwareModel`) | system-sdm | title |  |
| Hardware Project Release | [Hardware Project Release](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) (`des_ProjectRelease`) | design | title | [Design Project Release](https://www.altium.com/documentation/altium-designer/preparing-for-manufacture/design-release) |
| Hardware Project Variant | [Hardware Project Variant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) (`des_ProjectVariant`) | design | title | [Design Variants](https://www.altium.com/documentation/altium-designer/design-variants) |
| Harness Project | [Harness Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_HarnessProject.md) (`des_HarnessProject`) | design | title | [Harness Design](https://www.altium.com/documentation/altium-designer/harness-design) |

**Hardware Component — 2 meanings**

- [Key Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) (`system_KeyComponent`) — system. A key component of a functional block in an ESD document, shown in the editor as a hardware component (e.g. a Renesas RA MCU chosen with the RA Explorer).
- [Hardware Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) (`system_SdmHardwareComponent`) — system-sdm. Represents a hardware component / part.

**Hardware Project — 2 meanings**

- [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) (`des_Project`) — design. A design project stored in a Workspace, normally under its built-in version control, such as a PCB project.
- [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) (`system_HardwareProject`) — system. An entry of an ESD document for a PCB design project (des_Project) that implements part of the system, listing the functional blocks that project covers.

## K

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Key Component | [Key Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) (`system_KeyComponent`) | system | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#hardware_component) |

## L

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| library component | [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) (`lib_Component`) | library | exact | [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) |
| Lifecycle Definition | [Lifecycle Definition](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleDefinition.md) (`plt_LifecycleDefinition`) | platform | title | [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions) |
| Lifecycle Stage | [Lifecycle Stage](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleStage.md) (`plt_LifecycleStage`) | platform | title | [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions) |
| Lifecycle State | [Lifecycle State](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) (`plt_LifecycleState`) | platform | title | [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions#options_and_controls_of_the_state_properties_dialog) |

## M

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Managed BOM | [Managed BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ManagedBOM.md) (`pro_ManagedBOM`) | procurement | title | [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal) |
| managed component | [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) (`lib_Component`) | library | exact | [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) |
| managed schematic sheet | [Managed Sheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md) (`lib_ManagedSheet`) | library | exact | [Working with Managed Schematic Sheets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/workspace-managed-schematic-sheets#just_what_is_a_managed_schematic_sheet) |
| Managed Sheet | [Managed Sheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md) (`lib_ManagedSheet`) | library | title | [Working with Managed Schematic Sheets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/workspace-managed-schematic-sheets#just_what_is_a_managed_schematic_sheet) |
| Managed Sheet Revision | [Managed Sheet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) (`lib_ManagedSheetRevision`) | library | title | [Working with Managed Schematic Sheets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/workspace-managed-schematic-sheets#just_what_is_a_managed_schematic_sheet) |
| Manufacturing Package | [Manufacturing Package](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md) (`des_ManufacturingPackage`) | design | title | [Viewing Manufacturing Packages](https://www.altium.com/documentation/altium-365/viewers/manufacturing-package-viewer) |
| Memory | [Memory](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Memory.md) (`dm_Memory`) | deviceModel | title |  |
| Multiboard Project | [Multiboard Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_MultiboardProject.md) (`des_MultiboardProject`) | design | title | [Designing with Multiple PCBs](https://www.altium.com/documentation/altium-designer/multi-board-design#structure_multi_board_design_project) |

**Manufacturer Part — 2 meanings**

- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) (`lib_Part`) — library. A manufacturer part, identified by manufacturer and part number, as held in the Workspace's Part Catalog together with the supplier parts through which it is sold.
- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) (`sup_Part`) — supply. Supply Part represents a market-available instance of a manufactured Part, providing aggregated sourcing data such as pricing, stock levels, and supplier offers.

## O

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Offer | [Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md) (`sup_Offer`) | supply | title | [Sourced Manufacturer and Supplier Data](https://www.altium.com/documentation/altium-365/bom-portal/sourced-manufacturer-supplier-data#order_list) |
| Organization | [Organization](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Organization.md) (`plt_Organization`) | platform | title | [Company Dashboard](https://www.altium.com/documentation/altium-dashboard) |

## P

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Package | [Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) (`ota_Package`) | ota | title |  |
| Package Hash | [Package Hash](https://altiumdeveloper.github.io/cdm/llms/classes/ota_PackageHash.md) (`ota_PackageHash`) | ota | title |  |
| Parameter | [Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) (`system_Parameter`) | system | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#accessing_object_properties) |
| Part Choice | [Part Choice](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoice.md) (`lib_PartChoice`) | library | title | [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component#anatomy_of_a_part_choice) |
| Part Choice List | [Part Choice List](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoiceList.md) (`lib_PartChoiceList`) | library | title | [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component#part_choices) |
| Part Family | [Part Family](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md) (`sup_PartFamily`) | supply | title |  |
| Part Group | [Part Group](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) (`sup_PartGroup`) | supply | title |  |
| Part Insight | [Part Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) (`ins_PartInsight`) | insights | title |  |
| Part Request | [Part Request](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartRequest.md) (`lib_PartRequest`) | library | title | [Part Requests](https://www.altium.com/documentation/altium-365/workflow-part-requests) |
| PCB footprint | [Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) (`lib_Footprint`) | library | related | [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) |
| PCB Snippet | [PCB Snippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippet.md) (`lib_PcbSnippet`) | library | title | [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) |
| PCB Snippet Revision | [PCB Snippet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippetRevision.md) (`lib_PcbSnippetRevision`) | library | title | [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) |
| Peripheral | [Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) (`dm_Peripheral`) | deviceModel | title |  |
| PeripheralConfiguration | [PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) (`dm_PeripheralConfiguration`) | deviceModel | title |  |
| PeripheralInstance | [PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) (`dm_PeripheralInstance`) | deviceModel | title |  |
| PeripheralMode | [PeripheralMode](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralMode.md) (`dm_PeripheralMode`) | deviceModel | title |  |
| PeripheralParameter | [PeripheralParameter](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralParameter.md) (`dm_PeripheralParameter`) | deviceModel | title |  |
| PeripheralPinConfig | [PeripheralPinConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinConfig.md) (`dm_PeripheralPinConfig`) | deviceModel | title |  |
| PeripheralPinDependencyConfig | [PeripheralPinDependencyConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinDependencyConfig.md) (`dm_PeripheralPinDependencyConfig`) | deviceModel | title |  |
| Pin | [Pin](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Pin.md) (`dm_Pin`) | deviceModel | title |  |
| Pin Assignment | [Pin Assignment](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignment.md) (`sft_PinAssignment`) | software | title | [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project) |
| Pin Assignment Model | [Pin Assignment Model](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignmentModel.md) (`sft_PinAssignmentModel`) | software | title | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) |
| Port Association | [Port Association](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) (`system_PortAssociation`) | system | title |  |
| PortConfiguration | [PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md) (`dm_PortConfiguration`) | deviceModel | title |  |
| PortConfigurationDependency | [PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md) (`dm_PortConfigurationDependency`) | deviceModel | title |  |
| PortConfigurationEnumValue | [PortConfigurationEnumValue](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationEnumValue.md) (`dm_PortConfigurationEnumValue`) | deviceModel | title |  |
| PortConnection | [PortConnection](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConnection.md) (`dm_PortConnection`) | deviceModel | title |  |
| PortFunction | [PortFunction](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortFunction.md) (`dm_PortFunction`) | deviceModel | title | [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project) |
| Process Definition | [Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) (`cus_Workflow`) | customization | related | [Processes & Workflows](https://www.altium.com/documentation/altium-365/processes-workflows) |
| Process Workflow | [Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) (`cus_Workflow`) | customization | exact | [Processes & Workflows](https://www.altium.com/documentation/altium-365/processes-workflows) |
| Processor | [Processor](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Processor.md) (`dm_Processor`) | deviceModel | title |  |
| Project Parameter | [Project Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md) (`des_ProjectParameter`) | design | title | [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects#project_parameters) |
| Project Template | [Project Template](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md) (`des_ProjectTemplate`) | design | title | [Creating a Project Template](https://www.altium.com/documentation/altium-designer/creating-project-template) |
| Project Template Revision | [Project Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplateRevision.md) (`des_ProjectTemplateRevision`) | design | title |  |

**Part — 2 meanings**

- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) (`lib_Part`) — library. A manufacturer part, identified by manufacturer and part number, as held in the Workspace's Part Catalog together with the supplier parts through which it is sold.
- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) (`sup_Part`) — supply. Supply Part represents a market-available instance of a manufactured Part, providing aggregated sourcing data such as pricing, stock levels, and supplier offers.

**Port — 3 meanings**

- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) (`dm_Port`) — deviceModel. A physical port on the device, with its functions, configurations, and connections.
- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) (`system_Port`) — system. An interface of a functional block in an ESD document (e.g. the I2C interface of an MPU), placed inside the block's boundaries; connection lines between blocks can start and end at ports.
- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) (`system_SdmPort`) — system-sdm. Represents a port within a system design.

## R

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Reference Design | [Reference Design](https://altiumdeveloper.github.io/cdm/llms/classes/sup_ReferenceDesign.md) (`sup_ReferenceDesign`) | supply | title | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#import_project) |
| Register | [Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md) (`dm_Register`) | deviceModel | title |  |
| RegisterField | [RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md) (`dm_RegisterField`) | deviceModel | title |  |
| Release Specification | [Requirement Baseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) (`req_RequirementBaseline`) | requirements | related | [Requirement Versioning and Releasing](https://www.altium.com/documentation/altium-365/requirements-systems-portal/requirements-module/requirement-versioning-and-releasing) |
| Renesas 365 solution | [Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) (`plt_Solution`) | platform | exact | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365) |
| Requirement | [Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) (`req_Requirement`) | requirements | title | [Requirement Fields](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/requirement-fields) |
| Requirement Artifact | [Requirement Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) (`req_Artifact`) | requirements | title |  |
| Requirement Baseline | [Requirement Baseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) (`req_RequirementBaseline`) | requirements | title | [Requirement Versioning and Releasing](https://www.altium.com/documentation/altium-365/requirements-systems-portal/requirements-module/requirement-versioning-and-releasing) |
| Requirement Change Request | [Requirement Change Request](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) (`req_RequirementChangeRequest`) | requirements | title |  |
| Requirement Revision | [Requirement Revision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) (`req_RequirementRevision`) | requirements | title | [Requirement Versioning and Releasing](https://www.altium.com/documentation/altium-365/requirements-systems-portal/requirements-module/requirement-versioning-and-releasing) |
| Requirement Specification | [Requirement Specification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) (`req_RequirementSpecification`) | requirements | title | [Create Specifications](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/create-specifications) |
| Requirements Project | [Requirements Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) (`req_Project`) | requirements | title | [Project Module](https://www.altium.com/documentation/altium-365/requirements-portal/project-module#creating_a_new_requirements_project) |
| Reuse Block | [Reuse Block](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlock.md) (`lib_ReuseBlock`) | library | title | [Working with Reuse Blocks](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/reuse-blocks) |
| Reuse Block Revision | [Reuse Block Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) (`lib_ReuseBlockRevision`) | library | title | [Working with Reuse Blocks](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/reuse-blocks) |
| Revision Naming Scheme | [Revision Naming Scheme](https://altiumdeveloper.github.io/cdm/llms/classes/plt_NamingScheme.md) (`plt_NamingScheme`) | platform | title | [Defining Revision Naming Schemes for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-naming-schemes) |
| Rule Check | [Rule Check](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheck.md) (`des_RuleCheck`) | design | title |  |
| Rule Check Execution | [Rule Check Execution](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheckExecution.md) (`des_RuleCheckExecution`) | design | title |  |

## S

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| SCH Snippet | [SCH Snippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippet.md) (`lib_SchSnippet`) | library | title | [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) |
| SCH Snippet Revision | [SCH Snippet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippetRevision.md) (`lib_SchSnippetRevision`) | library | title | [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) |
| schematic snippet | [SCH Snippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippet.md) (`lib_SchSnippet`) | library | exact | [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) |
| schematic symbol | [Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) (`lib_Symbol`) | library | related | [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) |
| Schematic Template | [Schematic Template](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplate.md) (`con_SchematicTemplate`) | configuration | title | [Creating a Schematic Template](https://www.altium.com/documentation/altium-designer/schematic/creating-templates) |
| Schematic Template Revision | [Schematic Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md) (`con_SchematicTemplateRevision`) | configuration | title | [Creating a Schematic Template](https://www.altium.com/documentation/altium-designer/schematic/creating-templates#creating_workspace_schematic_template) |
| Script | [Script](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Script.md) (`cus_Script`) | customization | title |  |
| Script Execution | [Script Execution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md) (`cus_ScriptExecution`) | customization | title |  |
| Script Execution Completed | [Script Execution Completed](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecutionCompleted.md) (`cus_ScriptExecutionCompleted`) | customization | title |  |
| Script Version | [Script Version](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md) (`cus_ScriptVersion`) | customization | title |  |
| SDM | [System Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) (`system_SdmSystemModel`) | system-sdm | exact | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#system_data_model) |
| Software Model | [Software Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) (`system_SdmSoftwareModel`) | system-sdm | title |  |
| Software Release | [Software Release](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) (`sft_SoftwareRelease`) | software | title |  |
| Software Specification | [Software Specification](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareSpecification.md) (`system_SdmSoftwareSpecification`) | system-sdm | title |  |
| Software Stack Instance | [Software Stack Instance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) (`system_SdmSoftwareStackInstance`) | system-sdm | title |  |
| Solution | [Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) (`plt_Solution`) | platform | title | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365) |
| Solution Release | [Solution Release](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionRelease.md) (`plt_SolutionRelease`) | platform | title |  |
| Solution Template | [Solution Template](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md) (`sup_SolutionTemplate`) | supply | title |  |
| Specification | [Requirement Specification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) (`req_RequirementSpecification`) | requirements | exact | [Create Specifications](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/create-specifications) |
| Supplier Part | [Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md) (`sup_Offer`) | supply | related | [Sourced Manufacturer and Supplier Data](https://www.altium.com/documentation/altium-365/bom-portal/sourced-manufacturer-supplier-data#order_list) |
| Symbol | [Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) (`lib_Symbol`) | library | title | [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) |
| Symbol Revision | [Symbol Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md) (`lib_SymbolRevision`) | library | title | [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) |
| System Data Model | [System Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) (`system_SdmSystemModel`) | system-sdm | exact | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#system_data_model) |
| System Design | [ESD Document](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md) (`system_ESDDocument`) | system | related | [Electronic System Design](https://www.altium.com/documentation/altium-365/esd) |
| System Model | [System Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) (`system_SdmSystemModel`) | system-sdm | title | [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#system_data_model) |
| System Model Version | [System Model Version](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) (`system_SdmSystemModelVersion`) | system-sdm | title |  |
| System Model Version Metadata | [System Model Version Metadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md) (`system_SdmSystemModelVersionMetadata`) | system-sdm | title |  |

**Software Component — 2 meanings**

- [Software Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) (`system_SdmSoftwareComponent`) — system-sdm. Represents a software component instance and its dependencies.
- [Software Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) (`system_SoftwareComponent`) — system. Functional in nature, abstracted from but connected to logical implementation.

**Software Project — 3 meanings**

- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) (`sft_SoftwareProject`) — software. The software part of a Renesas 365 solution, developed in the built-in Web IDE (based on the Theia framework) or in e² studio; it can also be created with an external repository type.
- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md) (`sup_SoftwareProject`) — supply. A software project published in the supply catalog, together with the evaluation kits it is compatible with.
- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) (`system_SoftwareProject`) — system. An entry of an ESD document for a software project (sft_SoftwareProject) that implements part of the system, listing the software components that project covers.

## T

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Task | [Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) (`col_Task`) | collaboration | title | [Working with Tasks](https://www.altium.com/documentation/altium-365/tasks) |

## U

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| User | [User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md) (`plt_User`) | platform | title | [Managing Users](https://www.altium.com/documentation/altium-dashboard/managing-users) |
| User Group | [User Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_UserGroup.md) (`plt_UserGroup`) | platform | title | [Managing Groups](https://www.altium.com/documentation/altium-dashboard/managing-groups) |

## V

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| V&V Activity | [Verification Case](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) (`req_VerificationCase`) | requirements | related | [Verification & Validation Module](https://www.altium.com/documentation/altium-365/requirements-portal/verification-validation-module) |
| Verification Case | [Verification Case](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) (`req_VerificationCase`) | requirements | title | [Verification & Validation Module](https://www.altium.com/documentation/altium-365/requirements-portal/verification-validation-module) |

## W

| Term | Class | Bounded context | Kind | Product documentation |
| --- | --- | --- | --- | --- |
| Workflow | [Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) (`cus_Workflow`) | customization | title | [Processes & Workflows](https://www.altium.com/documentation/altium-365/processes-workflows) |
| Workspace | [Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md) (`plt_Workspace`) | platform | title | [Altium 365 Workspace](https://www.altium.com/documentation/altium-365/workspace) |
| Workspace component | [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) (`lib_Component`) | library | exact | [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) |
| Workspace Footprint | [Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) (`lib_Footprint`) | library | exact | [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) |
| Workspace Group | [Workspace Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceGroup.md) (`plt_WorkspaceGroup`) | platform | title | [Managing Workspace Membership](https://www.altium.com/documentation/altium-365/managing-workspace-membership#admin_groups) |
| Workspace member | [Workspace User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) (`plt_WorkspaceUser`) | platform | exact | [Managing Workspace Membership](https://www.altium.com/documentation/altium-365/managing-workspace-membership#workspace_members) |
| Workspace project | [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) (`des_Project`) | design | exact | [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects) |
| Workspace Symbol | [Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) (`lib_Symbol`) | library | exact | [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) |
| Workspace User | [Workspace User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) (`plt_WorkspaceUser`) | platform | title | [Managing Workspace Membership](https://www.altium.com/documentation/altium-365/managing-workspace-membership#workspace_members) |

---

# File: llms/core.md

# Bounded context: Core

Holds the abstract foundations shared by every bounded context: the base classes Entity (specialised as Artifact and Activity), Resource and Event; the mixins that add annotations such as GRID, maturity and API type; shared slots such as id and name; and the abstract relations (e.g. part of, input of, derived from) that domain relations specialise. It is not a product area and has no product documentation of its own.

HTML page: [subsets/core/](https://altiumdeveloper.github.io/cdm/subsets/core/)

## In the product

No public product documentation exists for this bounded context.

## Base classes and mixins

- [Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) (`core_Activity`): Abstract base for process and work objects — things that happen, use inputs, and produce outputs. · Activity, abstract
- [Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md) (`core_Artifact`): Abstract base for persistent data objects that are created, stored, versioned, and consumed. · Artifact, abstract
- [Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) (`core_Entity`): Abstract base for all identifiable, versioned, platform-accessible domain objects. · Entity, abstract
- [Event](https://altiumdeveloper.github.io/cdm/llms/classes/core_Event.md) (`core_Event`): Abstract base for domain events. · Event, abstract
- [Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md) (`core_Meta`): Abstract base for all CDM mixin classes. · abstract
- [Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md) (`core_Resource`): Abstract base for lightweight platform-accessible objects that have API access but are not Entities; they carry no GRID and no versioning lifecycle. · Resource, abstract
- [With GRID](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithGRID.md) (`core_WithGRID`): Mixin that adds a GRID annotation slot to a class. · mixin
- [With Maturity](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithMaturity.md) (`core_WithMaturity`): Mixin that adds a maturity annotation slot indicating the lifecycle readiness level. · mixin
- [With Platform API](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithPlatformAPI.md) (`core_WithPlatformAPI`): Mixin that adds API type annotations: platformAPI names the Altium 365 Platform API GraphQL type; nexarAPI names the Nexar (Octopart) GraphQL type for supply-chain entities served by Nexar rather than the Platform API. · mixin
- [With Vault](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithVault.md) (`core_WithVault`): Mixin that adds a vault content type annotation to a class, indicating how its content is stored in the platform vault. · mixin
- [With Vault Link](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithVaultLink.md) (`core_WithVaultLink`): Mixin that adds vault link parent, child, and type annotation slots for tracking hierarchical vault relationships. · mixin

## Classes without a bounded context

- [Any](https://altiumdeveloper.github.io/cdm/llms/classes/Any.md)
- [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md): A mixin for entities that occupy a specific span of the memory map. · abstract, mixin
- [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md): A mixin for entities within the System Data Model (SDM) that are identifiable by reference designators · abstract, mixin
- [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md): A mixin for entities within the System Data Model (SDM) that are mappable to domain-specific concepts · abstract, mixin

---

# File: llms/platform.md

# Bounded context: Platform

Models the platform-wide objects that other bounded contexts build on: organizations (Company Accounts) with their users and user groups, Workspaces with their members and groups, applications, event subscriptions, and Renesas 365 solutions with their releases. It also holds the lifecycle definitions (with their stages and states) and revision naming schemes that govern Workspace Items. Organization-level data is managed in the Company Dashboard; Workspace-level configuration, including these definitions and schemes, is managed from Altium Designer or the Workspace browser interface.

HTML page: [subsets/platform/](https://altiumdeveloper.github.io/cdm/subsets/platform/)

## In the product

- [Company Dashboard](https://www.altium.com/documentation/altium-dashboard) (primary)
- [Configuring and Administrating Your Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace)
- [Altium 365 API](https://www.altium.com/documentation/altium-developer-center/altium-365/api#how_the_api_is_organized)

## Classes

- [Application](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Application.md) (`plt_Application`): Artifact · API GloApp · GRID `grid:global::platform:app/{id}`
- [Event Subscription](https://altiumdeveloper.github.io/cdm/llms/classes/plt_EventSubscription.md) (`plt_EventSubscription`): Artifact · API GloEvtSubscription · GRID `grid:global::events:subscription/{id}`
- [Lifecycle Definition](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleDefinition.md) (`plt_LifecycleDefinition`): Defines the set of states that an entity can transition through in its lifecycle. · Artifact · API DesLifeCycleDefinition · GRID `grid:workspace:{workspace-id}:platform:lifecycle-definition/{id}`
- [Lifecycle Stage](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleStage.md) (`plt_LifecycleStage`): A named stage that groups lifecycle states in a lifecycle definition using the Advanced management style (e.g. Design, Prototype, Production), indicating how far a revision has progressed in its development. · Resource · API DesLifeCycleStage
- [Lifecycle State](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) (`plt_LifecycleState`): A named point in an Item Revision's lifecycle (e.g. Planned, New From Design, In Production, Obsolete) that shows its status from a business perspective. · Resource · API DesLifeCycleState
- [Organization](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Organization.md) (`plt_Organization`): An Altium customer organization, represented by its Company Account. · Artifact · API GloOrganization · GRID `grid:global::platform:organization/{id}`
- [Revision Naming Scheme](https://altiumdeveloper.github.io/cdm/llms/classes/plt_NamingScheme.md) (`plt_NamingScheme`): Defines the format of Revision IDs for the Items that use it: one to three levels (e.g. Model, Prototype and Revision), each with its own format, separator and minimum width. · Artifact · API DesRevisionNamingScheme · GRID `grid:workspace:{workspace-id}:platform:revision-naming-scheme/{id}`
- [Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) (`plt_Solution`): A Renesas 365 solution: the main, top-level object of a Renesas 365 Workspace, which brings together the system design (an ESD document), PCB projects and software projects of one system. · Activity · API SolSolution · GRID `grid:workspace:{workspace-id}:platform:solution/{id}`
- [Solution Release](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionRelease.md) (`plt_SolutionRelease`): Release of the Solution. · Artifact · GRID `grid:workspace:{workspace-id}:platform:solution-release/{id}`
- [User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md) (`plt_User`): A person identified by a global Altium Account, the identity used for signing in to Altium services. · Artifact · API GloUser · GRID `grid:global::platform:user/{id}`
- [User Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_UserGroup.md) (`plt_UserGroup`): A named group of users within an organization's Company Account, managed in the Company Dashboard. · Artifact · API GloUserGroup · GRID `grid:global::platform:group/{id}`
- [Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md) (`plt_Workspace`): The top-level entity that plays a role of a closed environment for other entities (members, projects, components, etc.). · Artifact · API DesWorkspace · GRID `grid:global::platform:workspace/{id}`
- [Workspace Group](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceGroup.md) (`plt_WorkspaceGroup`): Workspace Group represents a logical collection of users within a workspace, used to manage access control, permissions, and collaboration roles across projects and data assets. · Artifact · API DesWorkspaceGroup · GRID `grid:workspace:{workspace-id}:team:group/{id}`
- [Workspace User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) (`plt_WorkspaceUser`): A person's membership in a particular Workspace, connecting their Altium Account to that Workspace and to the Workspace groups they are assigned to. · Artifact · API DesWorkspaceUser · GRID `grid:workspace:{workspace-id}:team:user/{id}`

## Base classes and mixins

- [Has Lifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) (`plt_HasLifecycle`): Mixin that adds a lifecycle state reference to an entity. · abstract, mixin
- [Solution Item](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) (`plt_SolutionItem`): Mixin that marks an entity as an item belonging to a platform Solution. · abstract, mixin

---

# File: llms/configuration.md

# Bounded context: Configuration Management

Models environment configurations, which restrict the Altium Designer working environment of the Workspace members they target to approved configuration data, together with schematic templates and their revisions stored as Workspace Items. In Altium 365 this corresponds to environment configuration management through the Team Configuration Center.

HTML page: [subsets/configuration/](https://altiumdeveloper.github.io/cdm/subsets/configuration/)

## In the product

- [Environment Configuration Management](https://www.altium.com/documentation/altium-365/environment-configuration-management) (primary)

## Classes

- [Environment Configuration](https://altiumdeveloper.github.io/cdm/llms/classes/con_EnvironmentConfiguration.md) (`con_EnvironmentConfiguration`): A named set of configuration data items that the Workspace members it targets are allowed to use in Altium Designer. · Artifact
- [Schematic Template](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplate.md) (`con_SchematicTemplate`): A schematic template stored as a Workspace Item. · Artifact
- [Schematic Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md) (`con_SchematicTemplateRevision`): One revision of a Workspace schematic template Item, holding the template as saved at that point, e.g. from Altium Designer with Save to Server or uploaded from a *.SchDot file. · Artifact

---

# File: llms/collaboration.md

# Bounded context: Collaboration

Models collaboration on Workspace content: comment threads attached to a point, object or area of a document, the individual comments in each thread, and tasks that assign work to users or teams. In the product, comments are placed on documents of Workspace projects (e.g. through the Comments and Tasks panel in Altium Designer), and tasks are tracked on the Tasks page of a Workspace.

HTML page: [subsets/collaboration/](https://altiumdeveloper.github.io/cdm/subsets/collaboration/)

## In the product

- [Document Commenting](https://www.altium.com/documentation/altium-designer/document-commenting) (primary)
- [Working with Tasks](https://www.altium.com/documentation/altium-365/tasks)
- [Altium 365 API](https://www.altium.com/documentation/altium-developer-center/altium-365/api#how_the_api_is_organized)

## Classes

- [Comment](https://altiumdeveloper.github.io/cdm/llms/classes/col_Comment.md) (`col_Comment`): A single entry in a comment thread: either the initial comment, pinned to a point, an object or an area of a design document (or to a BOM line), or a reply to it. · Resource · API DesComment
- [Comment Thread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md) (`col_CommentThread`): Comment Thread represents a structured discussion linked to a specific design object, document, or workspace item, capturing feedback, decisions, and context directly within the collaborative design environment. · Activity · API DesCommentThread · GRID `grid:workspace:{workspace-id}:collaboration:comment-thread/{id}`
- [Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) (`col_Task`): Task represents a discrete unit of work assigned to a user or team within the design workflow, used to track progress, responsibility, and completion status for design, review, or management activities. · Activity · API DesTask · GRID `grid:workspace:{workspace-id}:collaboration:task/{id}`

---

# File: llms/customization.md

# Bounded context: Customization

Models ways to customize and automate a Workspace: process workflows, and scripts with their versions, their executions and the event raised when an execution completes. In the product, each workflow belongs to a process definition that a Workspace administrator creates and manages in the Workspace browser interface.

HTML page: [subsets/customization/](https://altiumdeveloper.github.io/cdm/subsets/customization/)

## In the product

- [Processes & Workflows](https://www.altium.com/documentation/altium-365/processes-workflows) (primary)
- [Altium 365 API](https://www.altium.com/documentation/altium-developer-center/altium-365/api#how_the_api_is_organized)

## Classes

- [Script](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Script.md) (`cus_Script`): Artifact · API GloScrScript · GRID `grid:workspace:{workspace-id}:scripts:script/{id}`
- [Script Execution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md) (`cus_ScriptExecution`): Artifact · API GloScrScriptExecution · GRID `grid:workspace:{workspace-id}:scripts:execution/{id}`
- [Script Execution Completed](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecutionCompleted.md) (`cus_ScriptExecutionCompleted`): Event
- [Script Version](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md) (`cus_ScriptVersion`): Artifact · API GloScrScriptVersion · GRID `grid:workspace:{workspace-id}:scripts:script-version/{id}`
- [Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) (`cus_Workflow`): A process workflow of an Altium 365 Workspace: the workflow that belongs to a process definition and steps designers through an everyday design process (e.g. requesting a new part, a design review or creating a new project). · Activity · API DesWorkflowDefinition · GRID `grid:workspace:{workspace-id}:customization:workflow/{id}`

---

# File: llms/design.md

# Bounded context: Design

Models design projects stored in a Workspace, including multi-board and harness projects, with their parameters, variants and releases, the manufacturing packages shared from releases, project templates with their revisions, rule checks run against projects, and design reviews of projects. It corresponds to Workspace projects in Altium 365 and Altium Designer, from project creation through to design release.

HTML page: [subsets/design/](https://altiumdeveloper.github.io/cdm/subsets/design/)

## In the product

- [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects) (primary)
- [Management of a Specific Project](https://www.altium.com/documentation/altium-365/management-specific-project)
- [Design Project Release](https://www.altium.com/documentation/altium-designer/preparing-for-manufacture/design-release)

## Classes

- [Design Review](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) (`des_DesignReview`): A structured assessment of a design project, carried out by assigned Reviewers on a fixed snapshot of its design and concluded by the Initiator's decision, which leaves a traceable record of the review. · Activity · GRID `grid:workspace:{workspace-id}:design:design-review/{id}`
- [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) (`des_Project`): A design project stored in a Workspace, normally under its built-in version control, such as a PCB project. · Activity · API DesProject · GRID `grid:workspace:{workspace-id}:design:project/{id}`
- [Hardware Project Release](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) (`des_ProjectRelease`): Project Release captures an immutable snapshot of a PCB design project at a specific point in its lifecycle, packaging all design data, outputs, and metadata required for manufacturing, assembly, and downstream processes. · Artifact · API DesRelease · GRID `grid:workspace:{workspace-id}:design:project-release/{id}`
- [Hardware Project Variant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) (`des_ProjectVariant`): A design variant of a project: a named variation of the same base design that is assembled with a different set of components. · Resource · API DesWipVariant
- [Harness Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_HarnessProject.md) (`des_HarnessProject`): Harness Project defines the design of a cable and wiring harness as a standalone yet integrable artifact, capturing connectors, wires, splices, and pin-to-pin mappings required to implement electrical interconnects between boards and system elements. · Activity · API DesProject
- [Manufacturing Package](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md) (`des_ManufacturingPackage`): A read-only package that contains a subset of Project Release artifacts that is typically shared with an external party for the purposes of manufacturing the board (e.g. Manufacturing Package may contain fabrication/assembly files required by the factories, but not the sources of the project) · Artifact · GRID `grid:workspace:{workspace-id}:design:manufacturing-package/{id}`
- [Multiboard Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_MultiboardProject.md) (`des_MultiboardProject`): Multiboard Project represents the coordinated design of multiple interconnected PCB projects assembled into a single system, capturing both their logical interconnects and physical arrangements. · Activity · API DesProject
- [Project Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md) (`des_ProjectParameter`): A name/value parameter defined at the level of a design project. · Resource · API DesProjectParameter
- [Project Template](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md) (`des_ProjectTemplate`): A reusable starting point for new design projects that bundles the documents, files and project settings a team wants to apply again and again. · Artifact · API DesProjectTemplate · GRID `grid:workspace:{workspace-id}:design:project-template/{id}`
- [Project Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplateRevision.md) (`des_ProjectTemplateRevision`): An immutable revision of a project template. · Artifact · API DesProjectTemplateRevision · GRID `grid:workspace:{workspace-id}:design:project-template-revision/{id}`
- [Rule Check](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheck.md) (`des_RuleCheck`): Rule check definitions that can be executed against a project to validate design integrity and compliance with specified constraints. · Artifact · API RuleCheck · GRID `grid:workspace:{workspace-id}:design:rule-check/{id}`
- [Rule Check Execution](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheckExecution.md) (`des_RuleCheckExecution`): Execution of a rule check against a project to validate design integrity and compliance with specified constraints. · Activity · API RuleCheckExecution · GRID `grid:workspace:{workspace-id}:design:rule-check-execution/{id}`

---

# File: llms/deviceModel.md

# Bounded context: Device Model

Models an embedded device (e.g. an MCU), which the CDM calls a digital twin: its processors; its address map with memories, registers, bit fields and their enumerated values; its peripherals with their instances, modes and configurations; and its pins and ports with the alternative functions of each port. A configured device model filters the full model to one device configuration, which in the product is edited on a hardware component in an ESD document.

HTML page: [subsets/deviceModel/](https://altiumdeveloper.github.io/cdm/subsets/deviceModel/)

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) (primary)

## Classes

- [AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) (`dm_AddressBlock`): Address block with start, size, and optional registers and peripherals. · Resource · API DmAddressBlock
- [AddressMap](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressMap.md) (`dm_AddressMap`): Address map for the device including memory and peripheral regions. · Resource · API DmAddressMapModel
- [AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md) (`dm_AddressSegment`): A contiguous region of the device's memory map. · Resource · API DmAddressSegment
- [ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) (`dm_ConfiguredDeviceModel`): A digital twin of an embedded hardware device as configured for a specific use-case. · Resource · API DmDeviceModelAsConfigured
- [FieldEnum](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FieldEnum.md) (`dm_FieldEnum`): An enumerated value for a register field. · Resource · API DmAmFieldEnum
- [FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) (`dm_FullStackDeviceModel`): A digital twin of an embedded hardware device. · Artifact · API DmFullStackDeviceModel · GRID `grid:global::device-model:fullstack-dm/{id}`
- [Memory](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Memory.md) (`dm_Memory`): A memory entry within an address block. · Resource · API DmAmMemory
- [Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) (`dm_Peripheral`): A single peripheral definition, including its instances and properties. · Resource · API DmPeripheral
- [PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) (`dm_PeripheralConfiguration`): A concrete configuration for a peripheral role, containing pin multiplexing details. · Resource
- [PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) (`dm_PeripheralInstance`): A concrete instance of a peripheral (e.g., SCI0), including available modes. · Resource · API DmPeripheralInstance
- [PeripheralMode](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralMode.md) (`dm_PeripheralMode`): A specific mode that a peripheral instance can fulfill, · Resource · API DmPeripheralMode
- [PeripheralParameter](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralParameter.md) (`dm_PeripheralParameter`): A parameter associated with peripheral instance configuration. · Resource
- [PeripheralPinConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinConfig.md) (`dm_PeripheralPinConfig`): A specific pin multiplexing configuration within peripheral configuration. · Resource
- [PeripheralPinDependencyConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinDependencyConfig.md) (`dm_PeripheralPinDependencyConfig`): A pin dependency to port mapping entry within peripheral configuration. · Resource
- [Pin](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Pin.md) (`dm_Pin`): A physical pin on the device. · Resource · API DmPin
- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) (`dm_Port`): A physical port on the device, with its functions, configurations, and connections. · Resource · API DmPort
- [PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md) (`dm_PortConfiguration`): A specific configuration for a port. · Resource · API DmPortConfiguration
- [PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md) (`dm_PortConfigurationDependency`): A dependency describing how a configuration value maps to GPIO or alternate function usage. · Resource · API DmConfigDependency
- [PortConfigurationEnumValue](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationEnumValue.md) (`dm_PortConfigurationEnumValue`): An enumerated value for a port configuration. · Resource · API DmConfigEnumValue
- [PortConnection](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConnection.md) (`dm_PortConnection`): A connection from this port to another component or signal. · Resource · API DmPortConnection
- [PortFunction](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortFunction.md) (`dm_PortFunction`): A specific function that a port can perform. · Resource · API DmPortFunction
- [Processor](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Processor.md) (`dm_Processor`): Represents a physical processing core. · Resource
- [Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md) (`dm_Register`): A hardware register within an address block. · Resource · API DmAmRegister
- [RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md) (`dm_RegisterField`): A bit field within a register. · Resource · API DmAmRegisterField

---

# File: llms/insights.md

# Bounded context: Insights

Models insights: findings, detected asynchronously, that give the user insight within one domain area and can be followed up by tasks. There are two concrete kinds. A part insight concerns one Workspace part, may be informed by BOMs or design projects, and occurs in BOM releases, project releases or component revisions. A design insight concerns a design and is part of a design review.

HTML page: [subsets/insights/](https://altiumdeveloper.github.io/cdm/subsets/insights/)

## In the product

No public product documentation exists for this bounded context.

## Classes

- [Design Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_DesignInsight.md) (`ins_DesignInsight`): An insight within the design domain: a finding, detected asynchronously, about the design under review in a design review. · Activity · API DesWorkspaceInsInsight
- [Part Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) (`ins_PartInsight`): Activity · API DesWorkspaceInsInsight

## Base classes and mixins

- [Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md) (`ins_Insight`): A finding, detected asynchronously, that gives the user insight within one domain area: the library (part insights) or design (design insights). · Activity, abstract

---

# File: llms/library.md

# Bounded context: Library Management

Models the components stored in a Workspace and their revisions, the symbols, footprints, parameters, datasheets and part choices that make them up, and the component templates they can be created from. It also covers manufacturer parts in the Workspace part catalog, part requests, and reusable design content such as reuse blocks, managed sheets, and schematic and PCB snippets. It corresponds to Workspace components and design reuse in Altium Designer and Altium 365.

HTML page: [subsets/library/](https://altiumdeveloper.github.io/cdm/subsets/library/)

## In the product

- [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries) (primary)
- [Workspace Components](https://www.altium.com/documentation/altium-365/workspace-components)
- [Design Reuse](https://www.altium.com/documentation/altium-designer/schematic/design-reuse)

## Classes

- [Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) (`lib_Component`): Component represents a uniquely identifiable electronic part, defined by both its abstract design intent and its concrete realizations in manufacturing and supply. · Artifact · GRID `grid:workspace:{workspace-id}:library:component/{id}`
- [Component Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentParameter.md) (`lib_ComponentParameter`): A named parameter of a Workspace component, holding a value and, optionally, a data type. · Resource · API DesComponentParameter
- [Component Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) (`lib_ComponentRevision`): Revision of a Component. · Artifact · API DesComponent · GRID `grid:workspace:{workspace-id}:library:component-revision/{id}`
- [Component Template](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplate.md) (`lib_ComponentTemplate`): Component Template defines a reusable blueprint for creating and managing electronic components with consistent parameters, metadata, and lifecycle policies. · Artifact · API DesComponentTemplate · GRID `grid:workspace:{workspace-id}:library:component-template/{id}`
- [Component Template Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md) (`lib_ComponentTemplateRevision`): A revision of a Component Template: the template definition, stored as a *.CMPT document, saved into the Workspace at one point in time. · Artifact · API DesComponentTemplateRevision · GRID `grid:workspace:{workspace-id}:library:component-template-revision/{id}`
- [Datasheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Datasheet.md) (`lib_Datasheet`): Datasheet represents a technical document associated with a Component or Part, providing authoritative specifications, electrical characteristics, and manufacturer information. · Artifact · API DesDatasheet · GRID `grid:workspace:{workspace-id}:library:datasheet/{id}`
- [Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) (`lib_Footprint`): Footprint represents the physical layout definition of a Component on a PCB, specifying pad geometry, land patterns, and mechanical clearances required for assembly and manufacturing. · Artifact · GRID `grid:workspace:{workspace-id}:library:footprint/{id}`
- [Footprint Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md) (`lib_FootprintRevision`): A revision of a Footprint: the PCB footprint as saved into the Workspace at one point in time, with its own lifecycle state. · Artifact · API DesFootprint · GRID `grid:workspace:{workspace-id}:library:footprint-revision/{id}`
- [Managed Sheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md) (`lib_ManagedSheet`): A schematic sheet, with its components and wiring, stored in a Workspace so that it can be reused in other designs. · Artifact · GRID `grid:workspace:{workspace-id}:library:managed-sheet/{id}`
- [Managed Sheet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) (`lib_ManagedSheetRevision`): A revision of a Managed Sheet: the schematic sheet as saved into the Workspace at one point in time. · Artifact · GRID `grid:workspace:{workspace-id}:library:managed-sheet-revision/{id}`
- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) (`lib_Part`): A manufacturer part, identified by manufacturer and part number, as held in the Workspace's Part Catalog together with the supplier parts through which it is sold. · Artifact · API DesPart · GRID `grid:workspace:{workspace-id}:library:part/{id}`
- [Part Choice](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoice.md) (`lib_PartChoice`): One entry in a component's Part Choice list: a manufacturer part, rather than a specific supplier, that may be used to implement the component, bringing with it the offers of the suppliers that sell it. · Resource
- [Part Choice List](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoiceList.md) (`lib_PartChoiceList`): The list of Part Choices for a component: the manufacturer parts that may be used to implement it on the assembled board. · Resource
- [Part Request](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartRequest.md) (`lib_PartRequest`): Part Request represents a formal demand from a designer to introduce a new Component or Part into the managed library, typically triggered when an item is not yet available in the workspace. · Activity · GRID `grid:workspace:{workspace-id}:library:part-request/{id}`
- [PCB Snippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippet.md) (`lib_PcbSnippet`): A selection of circuitry from a PCB design, including its components and routing, saved so that it can be placed in other PCB documents. · Artifact
- [PCB Snippet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippetRevision.md) (`lib_PcbSnippetRevision`): A revision of a PCB snippet as saved into the Workspace at one point in time. · Artifact
- [Reuse Block](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlock.md) (`lib_ReuseBlock`): A reusable section of a design stored in a Workspace, typically combining schematic circuitry with its PCB representation; a block can also be schematic-only or PCB-only. · Artifact · API DesReuseBlock · GRID `grid:workspace:{workspace-id}:library:reuse-block/{id}`
- [Reuse Block Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) (`lib_ReuseBlockRevision`): A revision of a Reuse Block: its schematic and/or PCB content as saved into the Workspace at one point in time, with its own lifecycle state. · Artifact · API DesReuseBlockRevision · GRID `grid:workspace:{workspace-id}:library:reuse-block-revision/{id}`
- [SCH Snippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippet.md) (`lib_SchSnippet`): A selection of circuitry from a single schematic sheet, including its components, saved so that it can be placed in other designs. · Artifact
- [SCH Snippet Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippetRevision.md) (`lib_SchSnippetRevision`): A revision of a schematic snippet as saved into the Workspace at one point in time. · Artifact
- [Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) (`lib_Symbol`): Symbol represents the logical schematic view of a Component, defining its electrical interface, pins, and attributes used to express circuit intent in design schematics. · Artifact · GRID `grid:workspace:{workspace-id}:library:symbol/{id}`
- [Symbol Revision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md) (`lib_SymbolRevision`): A revision of a Symbol: the schematic symbol as saved into the Workspace at one point in time, with its own lifecycle state. · Artifact · API DesSymbol · GRID `grid:workspace:{workspace-id}:library:symbol-revision/{id}`

---

# File: llms/ota.md

# Bounded context: Over-the-Air Updates

Models over-the-air (OTA) firmware and software updates: devices with the packages installed on them, fleets that group devices, packages with their version, size, checksums and target hardware, deployments that request packages to be rolled out to a device or fleet, and the deployment results that record the outcome on each targeted device. All classes are experimental.

HTML page: [subsets/ota/](https://altiumdeveloper.github.io/cdm/subsets/ota/)

## In the product

No public product documentation exists for this bounded context.

## Classes

- [Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) (`ota_Deployment`): Deployment represents the request for an OTA update that assigns packages to the ECUs of its target, either a single device or all devices of a single fleet. · Activity · GRID `grid:workspace:{workspace-id}:ota:deployment/{id}`
- [Deployment Assignment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentAssignment.md) (`ota_DeploymentAssignment`): Deployment Assignment assigns a package to the ECUs with a given hardware identifier. · Resource
- [Deployment Result](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) (`ota_DeploymentResult`): Deployment Result is the outcome of a deployment on one target device, from the time the device is addressed by the deployment, before its update is created. · Artifact · GRID `grid:workspace:{workspace-id}:ota:deployment-result/{id}`
- [Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) (`ota_Device`): Device represents a physical unit registered for OTA updates. · Artifact · GRID `grid:workspace:{workspace-id}:ota:device/{id}`
- [Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md) (`ota_Fleet`): Fleet represents a named group of devices managed and updated together. · Artifact · GRID `grid:workspace:{workspace-id}:ota:fleet/{id}`
- [Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) (`ota_Package`): Package represents one version of a software package registered for OTA deployment. · Artifact · GRID `grid:workspace:{workspace-id}:ota:package/{id}`
- [Package Hash](https://altiumdeveloper.github.io/cdm/llms/classes/ota_PackageHash.md) (`ota_PackageHash`): Package Hash is a checksum of a package binary, used for Uptane target metadata. · Resource

---

# File: llms/procurement.md

# Bounded context: Procurement

Models bills of materials: BOMs kept in a Workspace and worked on in the BOM Portal (managed and consolidated BOMs) with their releases, global BOMs, which are not tied to a Workspace, and BOM lines with their alternate and substitute parts and the issues found when a BOM is analysed. It corresponds to the Altium 365 BOM Portal.

HTML page: [subsets/procurement/](https://altiumdeveloper.github.io/cdm/subsets/procurement/)

## In the product

- [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal) (primary)

## Classes

- [BOM Issue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) (`pro_BomIssue`): A problem found when a BOM is analysed, usually against a particular BOM line: for example an unknown part number, a duplicated designator, or a part that is deprecated, low in stock or not compliant with a standard such as REACH. · Resource · API BomIssue
- [BOM Item](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) (`pro_BomItem`): One line of a BOM: its designators and quantity, the primary manufacturer part used for it (identified by manufacturer and manufacturer part number), and any alternate parts recorded for that line. · Resource · API BomItem
- [BOM Item Alternate](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemAlternate.md) (`pro_BomItemAlternate`): An alternate part recorded for one BOM line: another manufacturer part that could be used instead of the line's primary part. · Resource · API BomItemAlternate
- [BOM Item Substitute](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemSubstitute.md) (`pro_BomItemSubstitute`): Substitute is a replacement of a part by another within an individual BOM. · Resource · API BomItemSubstitute
- [BOM Release](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) (`pro_BomRelease`): A static snapshot of a Managed BOM's data, saved under a release name with an incremented revision number and optional notes. · Artifact · API BomRelease · GRID `grid:workspace:{workspace-id}:procurement:bom-release/{id}`
- [Consolidated BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ConsolidatedBOM.md) (`pro_ConsolidatedBOM`): Consolidated BOM represents the aggregated bill of materials across one or more Projects or variants, combining all required Parts into a single, unified view for procurement and manufacturing. · Activity · API BomWip · GRID `grid:workspace:{workspace-id}:procurement:consolidated-bom/{id}`
- [Global BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_GlobalBOM.md) (`pro_GlobalBOM`): Global BOM represents a bill of materials that resides outside of any workspace, on Octopart, where users can create, edit, collaborate on and share it with others. · Activity · GRID `grid:global::procurement:bom/{id}`
- [Managed BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ManagedBOM.md) (`pro_ManagedBOM`): A bill of materials kept in a Workspace and worked on in the BOM Portal, where its lines are enriched with manufacturer and supplier data for review and procurement. · Activity · API BomWip · GRID `grid:workspace:{workspace-id}:procurement:bom/{id}`

## Base classes and mixins

- [BOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) (`pro_Bom`): Bill of Materials · abstract, mixin
- [BOM Item Element](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) (`pro_BomItemElement`): An element (part) that might be used for a particular BOM item. · Resource, abstract
- [BOM WIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) (`pro_BomWIP`): The current, editable working state of a Workspace BOM, as opposed to a BOM release, which is a static snapshot of its data. · Activity, abstract

---

# File: llms/supply.md

# Bounded context: Supply

Models the supply catalog: manufacturer parts with their aggregated sourcing data and distributor offers, the companies acting as their manufacturers or distributors, and the vendor-specific part family hierarchy, along with catalog content such as reference designs, evaluation kits, solution templates and software projects. Part, offer and company data correspond to the supply chain data that Octopart aggregates and serves through the Octopart API.

HTML page: [subsets/supply/](https://altiumdeveloper.github.io/cdm/subsets/supply/)

## In the product

- [Octopart](https://www.altium.com/documentation/altium-developer-center/octopart) (primary)
- [Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api)
- [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component)

## Classes

- [Company](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Company.md) (`sup_Company`): Supply Company represents an organization in the electronics supply chain. · Artifact · Nexar SupCompany · GRID `grid:supply::platform:company/{id}`
- [Evaluation Kit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) (`sup_EvalKit`): A vendor evaluation kit in the supply catalog, described by its associated devices, its reference designs (including a main one) and the software projects compatible with it. · Artifact · API SupEvalKit · GRID `grid:supply::platform:eval-kit/{id}`
- [Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md) (`sup_Offer`): Supply Offer represents a specific commercial listing of a Part from a supplier, detailing price breaks, stock availability, lead times, and ordering conditions at a given point in time. · Artifact · Nexar SupOffer · GRID `grid:supply::platform:part/{id}/offer/{offerID}`
- [Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) (`sup_Part`): Supply Part represents a market-available instance of a manufactured Part, providing aggregated sourcing data such as pricing, stock levels, and supplier offers. · Artifact · Nexar SupPart · GRID `grid:supply::platform:part/{id}`
- [Part Family](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md) (`sup_PartFamily`): A manufacturer's grouping of parts in the supply data, where the kind of family is vendor-specific (e.g. Series or Family). · Artifact · API SupPartFamily · GRID `grid:supply::platform:part-family/{id}`
- [Part Group](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) (`sup_PartGroup`): A leaf of the part family hierarchy in the supply data, holding the parts that belong to it together with group-level information such as its manufacturer, overview, key features and documents. · Artifact · API SupPartGroup · GRID `grid:supply::platform:part-group/{id}`
- [Reference Design](https://altiumdeveloper.github.io/cdm/llms/classes/sup_ReferenceDesign.md) (`sup_ReferenceDesign`): An example design published in the supply catalog, bringing together its design files (e.g. schematics and layouts), documentation and the parts it uses. · Artifact · API SupRefDesign · GRID `grid:supply::platform:ref-design/{id}`
- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md) (`sup_SoftwareProject`): A software project published in the supply catalog, together with the evaluation kits it is compatible with. · Artifact · API SupSoftwareProject · GRID `grid:supply::platform:software-project/{id}`
- [Solution Template](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md) (`sup_SolutionTemplate`): A publisher's template for a solution, held in the supply catalog. · Artifact · API SupSolutionTemplate · GRID `grid:supply::platform:solution-template/{id}`

---

# File: llms/software.md

# Bounded context: Software

Models the embedded software of a Renesas 365 solution: software projects with their releases and build artifacts, device configurations (with revisions) and their pin assignments, and AI models. In Renesas 365 the software project is the software part of a solution, edited in the built-in Web IDE or in e² studio; a device configuration there also covers the ports, package information and peripherals of a hardware component.

HTML page: [subsets/software/](https://altiumdeveloper.github.io/cdm/subsets/software/)

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration)

## Classes

- [AI Model](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md) (`sft_AIModel`): AI model artifact in context of a workspace · Artifact · GRID `grid:workspace:{workspace-id}:software:ai-model/{id}`
- [Build Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md) (`sft_BuildArtifact`): Artifact
- [Device Configuration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md) (`sft_DeviceConfiguration`): The configuration of a device (e.g. an MCU placed as a hardware component in an ESD document), covering its ports, package information, peripherals and pin assignments. · Artifact · API SftDevCfgDeviceConfiguration · GRID `grid:workspace:{workspace-id}:software:device-configuration/{id}`
- [Device Configuration Revision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md) (`sft_DeviceConfigurationRevision`): Artifact · API SftDevCfgDeviceConfigurationRevision · GRID `grid:workspace:{workspace-id}:software:device-configuration-revision/{id}`
- [Pin Assignment](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignment.md) (`sft_PinAssignment`): The assignment of a function to one pin of a device, identified by pin number and name. · Resource
- [Pin Assignment Model](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignmentModel.md) (`sft_PinAssignmentModel`): The set of pin assignments of a device, one part of its device configuration alongside ports, package information and peripherals. · Resource
- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) (`sft_SoftwareProject`): The software part of a Renesas 365 solution, developed in the built-in Web IDE (based on the Theia framework) or in e² studio; it can also be created with an external repository type. · Activity · API SftSoftwareProject · GRID `grid:workspace:{workspace-id}:software:software-project/{id}`
- [Software Release](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) (`sft_SoftwareRelease`): Artifact · GRID `grid:workspace:{workspace-id}:software:software-release/{id}`

---

# File: llms/system.md

# Bounded context: System Design

Models the Electronic System Design (ESD) document of a Renesas 365 solution: a system-level block diagram of functional blocks with their key (hardware) and software components, ports and parameters, the connections between blocks, and entries for the hardware and software projects that implement the system. It corresponds to Electronic System Design in a Renesas 365 Workspace; a Global ESD has the same content outside of any Workspace.

HTML page: [subsets/system/](https://altiumdeveloper.github.io/cdm/subsets/system/)

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd) (primary)
- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365)

## Classes

- [Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) (`system_Connection`): A connection line in an ESD document representing an interconnection between functional blocks (e.g. signals passed between the interfaces of two devices), drawn directly between blocks or between their ports. · Resource
- [Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md) (`system_Endpoint`): One end of a connection in an ESD document, identified by the functional block and the port where the connection line starts or ends. · Resource
- [ESD Document](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md) (`system_ESDDocument`): A system-level block diagram document used in a Renesas 365 solution (listed there as a System Design project) to describe the architecture of the system at a functional level. · Activity · API SysEsdDocument · GRID `grid:workspace:{workspace-id}:system-design:esd/{id}`
- [Functional Block](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) (`system_FunctionalBlock`): Represents a logical block within an ESD document (e.g., MCU subsystem, LED driver block) that stands for a function, operation or device of the system, including parameters, key components, software components, ports, and associations. · Resource
- [Global ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_GlobalESD.md) (`system_GlobalESD`): An Electronic System Design that resides outside of any Workspace. · Activity · GRID `grid:global::system-design:esd/{id}`
- [Hardware Project](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) (`system_HardwareProject`): An entry of an ESD document for a PCB design project (des_Project) that implements part of the system, listing the functional blocks that project covers. · Resource
- [Key Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) (`system_KeyComponent`): A key component of a functional block in an ESD document, shown in the editor as a hardware component (e.g. a Renesas RA MCU chosen with the RA Explorer). · Resource
- [Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) (`system_Parameter`): Name–value parameter associated with functional blocks, ports, or other system design resources. · Resource
- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) (`system_Port`): An interface of a functional block in an ESD document (e.g. the I2C interface of an MPU), placed inside the block's boundaries; connection lines between blocks can start and end at ports. · Resource
- [Port Association](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) (`system_PortAssociation`): Resource
- [Software Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) (`system_SoftwareComponent`): Functional in nature, abstracted from but connected to logical implementation. · Resource
- [Software Project](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) (`system_SoftwareProject`): An entry of an ESD document for a software project (sft_SoftwareProject) that implements part of the system, listing the software components that project covers. · Resource

## Base classes and mixins

- [ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) (`system_ESD`): Electronic System Design: a system-level block diagram of functional blocks and the connections between them, together with the hardware and software projects that implement the system. · abstract, mixin

---

# File: llms/system-sdm.md

# Bounded context: System Design - System Data Model

Models the System Data Model (SDM) of a Renesas 365 solution and its versions, each combining a functional model with device, hardware and software models, plus metadata recording who created a version and with which application, and client-specific metadata (e.g. for ESD, Altium Designer or e² studio). The ESD document and e² studio push changes to and pull changes from the SDM, and Altium Designer pulls it into hardware projects.

HTML page: [subsets/system-sdm/](https://altiumdeveloper.github.io/cdm/subsets/system-sdm/)

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#system_data_model) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#pushing_pulling_sdm)
- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project)

## Classes

- [Authoring Application](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmAuthoringApplication.md) (`system_SdmAuthoringApplication`): Identifies the application used to create a system model version. · Resource
- [Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md) (`system_SdmConnection`): Represents a connection between functional blocks. · Resource · API SysSdmConnection
- [Device Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md) (`system_SdmDeviceModel`): Represents a device model within the system design. · Resource · API SysSdmDeviceModel
- [Domain Metadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmClientMetadata.md) (`system_SdmClientMetadata`): Captures metadata specific to a particular client (e.g., ESD, AD, E2Studio). · Resource
- [Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md) (`system_SdmEndpoint`): Represents an endpoint of a connection. · Resource · API SysSdmEndpoint
- [Functional Block](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) (`system_SdmFunctionalBlock`): Represents a logical block within a system functional model. · Resource · API SysSdmFunctionalBlock
- [Functional Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) (`system_SdmFunctionalModel`): Captures the functional aspects of the system design, focusing on the behavior and interactions of functional blocks. · Resource · API SysSdmFunctionalModel
- [Hardware Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) (`system_SdmHardwareComponent`): Represents a hardware component / part. · Resource · API SysSdmHardwareComponent
- [Hardware Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) (`system_SdmHardwareModel`): Captures the hardware components and their interactions within the system design. · Resource · API SysSdmHardwareModel
- [Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) (`system_SdmPort`): Represents a port within a system design. · Resource · API SysSdmPort
- [Software Component](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) (`system_SdmSoftwareComponent`): Represents a software component instance and its dependencies. · Resource · API SysSdmSoftwareComponent
- [Software Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) (`system_SdmSoftwareModel`): Captures the software components and their interactions within the system design. · Resource · API SysSdmSoftwareModel
- [Software Specification](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareSpecification.md) (`system_SdmSoftwareSpecification`): The "blueprint" for a software component. · Resource · API SysSdmSoftwareSpecification
- [Software Stack Instance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) (`system_SdmSoftwareStackInstance`): Represents a software stack instance and its dependencies. · Resource · API SysSdmSoftwareStackInstance
- [System Model](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) (`system_SdmSystemModel`): A high-level system model that captures the overall system architecture, crossing boundary between functional and logical domains (e.g., hardware and software). · Activity · API SysSdmSystemModel · GRID `grid:workspace:{workspace-id}:system-design:sdm/{id}`
- [System Model Version](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) (`system_SdmSystemModelVersion`): A specific version of a system model, capturing the state of the system design at a particular point in time. · Artifact · API SysSdmSystemModelVersion · GRID `grid:workspace:{workspace-id}:system-design:sdm-version/{id}`
- [System Model Version Metadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md) (`system_SdmSystemModelVersionMetadata`): Metadata associated with a specific version of a system model, capturing provenance information. · Resource

---

# File: llms/requirements.md

# Bounded context: Requirements

Models requirements and their revisions, the specifications that group them, baselines approved for execution, change requests, the requirements projects that scope this work, and verification cases that provide evidence against requirements; most of its classes are experimental. It corresponds to requirements management and verification & validation in the Altium 365 Requirements Portal.

HTML page: [subsets/requirements/](https://altiumdeveloper.github.io/cdm/subsets/requirements/)

## In the product

- [Requirements Portal](https://www.altium.com/documentation/altium-365/requirements-portal) (primary)
- [Features Explained](https://www.altium.com/documentation/altium-365/requirements-portal/features-explained)
- [Working with Requirements](https://www.altium.com/documentation/altium-365/requirements-integration)

## Classes

- [Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) (`req_Requirement`): A single, testable statement of intent or constraint that governs a solution or process outcome. · Artifact · GRID `grid:workspace:{workspace-id}:requirements:requirement/{id}`
- [Requirement Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) (`req_Artifact`): Resource
- [Requirement Baseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) (`req_RequirementBaseline`): A version-managed release of a specification or subset of requirements approved for execution. · Artifact · GRID `grid:workspace:{workspace-id}:requirements:baseline/{id}`
- [Requirement Change Request](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) (`req_RequirementChangeRequest`): Structured workflow item proposing additions, updates, or removals of requirements. · Activity · GRID `grid:workspace:{workspace-id}:requirements:change-request/{id}`
- [Requirement Revision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) (`req_RequirementRevision`): An immutable snapshot of a requirement statement at a specific revision. · Artifact · GRID `grid:workspace:{workspace-id}:requirements:requirement-revision/{id}`
- [Requirement Specification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) (`req_RequirementSpecification`): A curated collection of requirements scoped to a program, domain, or release horizon. · Artifact · GRID `grid:workspace:{workspace-id}:requirements:specification/{id}`
- [Requirements Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) (`req_Project`): The orchestration space for capturing, evolving, and validating requirements scoped to a product, program increment, or regulatory engagement. · Activity · GRID `grid:workspace:{workspace-id}:requirements:project/{id}`
- [Verification Case](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) (`req_VerificationCase`): A planned verification procedure or test that produces objective evidence against requirements. · Activity · GRID `grid:workspace:{workspace-id}:requirements:verification-case/{id}`

---

# File: llms/classes/Any.md

# Any

- Name: `Any`
- IRI: `linkml:Any` (https://w3id.org/linkml/Any)
- Bounded context: none
- HTML page: [classes/Any/](https://altiumdeveloper.github.io/cdm/classes/Any/)

---

# File: llms/classes/col_Comment.md

# Comment (col_Comment)

- Name: `col_Comment`
- IRI: `col:Comment` (https://w3id.org/altium/cdm/collaboration/Comment)
- Bounded context: [collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/col_Comment/](https://altiumdeveloper.github.io/cdm/classes/col_Comment/)

A single entry in a comment thread: either the initial comment, pinned to a point, an object or an area of a design document (or to a BOM line), or a reply to it. A comment can mention people or groups using @, and it can be assigned to a Workspace member as a task, either when it is posted or later by converting it. Only the author can edit or delete a comment, and deleting the initial comment also deletes its replies.

## In the product

- [Web Viewer](https://www.altium.com/documentation/altium-365/viewers/web-viewer#comment_placement) (primary)

## In the API

- Platform API type: [`DesComment`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesComment/) (object)

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [col_CommentThread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md) | comments | 1..* |  |

---

# File: llms/classes/col_CommentThread.md

# Comment Thread (col_CommentThread)

- Name: `col_CommentThread`
- IRI: `col:CommentThread` (https://w3id.org/altium/cdm/collaboration/CommentThread)
- Bounded context: [collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/col_CommentThread/](https://altiumdeveloper.github.io/cdm/classes/col_CommentThread/)

Comment Thread represents a structured discussion linked to a specific design object, document, or workspace item, capturing feedback, decisions, and context directly within the collaborative design environment.

## Comments

- Each Comment Thread has its own identity and lifecycle, grouping related comments and replies into a coherent conversation.
- It serves as a persistent communication artifact that promotes design review transparency, traceability, and cross-team collaboration within Altium 365 and connected design tools.

## In the product

- [Web Viewer](https://www.altium.com/documentation/altium-365/viewers/web-viewer#commenting) (primary)
- [Document Commenting](https://www.altium.com/documentation/altium-designer/document-commenting)

## In the API

- Platform API type: [`DesCommentThread`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesCommentThread/) (object)

## GRID

`grid:workspace:{workspace-id}:collaboration:comment-thread/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| comments | [col_Comment](https://altiumdeveloper.github.io/cdm/llms/classes/col_Comment.md) | 1..* |  |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | commentThreads | * | core_hasPart |

---

# File: llms/classes/col_Task.md

# Task (col_Task)

- Name: `col_Task`
- IRI: `col:Task` (https://w3id.org/altium/cdm/collaboration/Task)
- Bounded context: [collaboration](https://altiumdeveloper.github.io/cdm/llms/collaboration.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/col_Task/](https://altiumdeveloper.github.io/cdm/classes/col_Task/)

Task represents a discrete unit of work assigned to a user or team within the design workflow, used to track progress, responsibility, and completion status for design, review, or management activities.

## Comments

- Each Task has its own identity, state, and assignees, and may be linked to specific design objects, projects, or comments.
- It provides structure and accountability in collaborative design processes, supporting review cycles, issue resolution, and workflow coordination across teams within Altium 365.

## In the product

- [Working with Tasks](https://www.altium.com/documentation/altium-365/tasks) (primary)

## In the API

- Platform API type: [`DesTask`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesTask/) (object)

## GRID

`grid:workspace:{workspace-id}:collaboration:task/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | tasks | * | core_informs |
| [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md) | tasks | * | core_informs |

---

# File: llms/classes/con_EnvironmentConfiguration.md

# Environment Configuration (con_EnvironmentConfiguration)

- Name: `con_EnvironmentConfiguration`
- IRI: `con:EnvironmentConfiguration` (https://w3id.org/altium/cdm/configuration/EnvironmentConfiguration)
- Bounded context: [configuration](https://altiumdeveloper.github.io/cdm/llms/configuration.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/con_EnvironmentConfiguration/](https://altiumdeveloper.github.io/cdm/classes/con_EnvironmentConfiguration/)

A named set of configuration data items that the Workspace members it targets are allowed to use in Altium Designer. The items are revisions of Workspace Items of supported content types (e.g. schematic, BOM, project and Draftsman templates, output job files and layer stacks, plus at most one Altium Designer Preferences revision), and the same item can be used by several configurations. Administrators define configurations in the Workspace's Team Configuration Center (TC2) and assign them to Workspace groups, called roles there; when a group member signs in to the Workspace from Altium Designer, each controlled area of the design environment is restricted to the chosen configuration's items.

## Comments

- TBD

## In the product

- [Environment Configuration Management](https://www.altium.com/documentation/altium-365/environment-configuration-management) (primary)
- [Managing Environment Configurations](https://www.altium.com/documentation/altium-365/managing-environment-configurations)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| schematicTemplates | [con_SchematicTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md) | * |  | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md) | environmentConfigurations | * | core_hasPart |

---

# File: llms/classes/con_SchematicTemplate.md

# Schematic Template (con_SchematicTemplate)

- Name: `con_SchematicTemplate`
- IRI: `con:SchematicTemplate` (https://w3id.org/altium/cdm/configuration/SchematicTemplate)
- Bounded context: [configuration](https://altiumdeveloper.github.io/cdm/llms/configuration.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/con_SchematicTemplate/](https://altiumdeveloper.github.io/cdm/classes/con_SchematicTemplate/)

A schematic template stored as a Workspace Item. When applied to a schematic sheet, the template sets the sheet's size, its graphics such as a title block, and its sheet-level parameters, so that a team's schematics look consistent. The template content is kept in successive revisions of the Item, and environment configurations can reference those revisions to control which templates designers may use.

## Comments

- TBD

## In the product

- [Creating a Schematic Template](https://www.altium.com/documentation/altium-designer/schematic/creating-templates) (primary)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [con_SchematicTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/con_SchematicTemplateRevision.md

# Schematic Template Revision (con_SchematicTemplateRevision)

- Name: `con_SchematicTemplateRevision`
- IRI: `con:SchematicTemplateRevision` (https://w3id.org/altium/cdm/configuration/SchematicTemplateRevision)
- Bounded context: [configuration](https://altiumdeveloper.github.io/cdm/llms/configuration.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/con_SchematicTemplateRevision/](https://altiumdeveloper.github.io/cdm/classes/con_SchematicTemplateRevision/)

One revision of a Workspace schematic template Item, holding the template as saved at that point, e.g. from Altium Designer with Save to Server or uploaded from a *.SchDot file. Editing the template saves the result into the next revision, and environment configurations list template revisions, rather than the Item itself, as their configuration data.

## Comments

- TBD

## In the product

- [Creating a Schematic Template](https://www.altium.com/documentation/altium-designer/schematic/creating-templates#creating_workspace_schematic_template) (primary)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [con_EnvironmentConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/con_EnvironmentConfiguration.md) | schematicTemplates | * | core_hasPart |
| [con_SchematicTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplate.md) | revisions | * | core_revisions |
| [lib_ManagedSheetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) | template | 0..1 | core_derivedFrom |

---

# File: llms/classes/core_Activity.md

# Activity (core_Activity)

- Name: `core_Activity`
- IRI: `core:Activity` (https://w3id.org/altium/cdm/core/Activity)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: Activity, abstract
- Is a: [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md)
- Subclasses: [col_CommentThread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md), [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md), [cus_Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md), [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md), [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md), [des_RuleCheckExecution](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheckExecution.md), [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md), [lib_PartRequest](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartRequest.md), [ota_Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md), [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md), [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md), [pro_GlobalBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_GlobalBOM.md), [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md), [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md), [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md), [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md), [system_ESDDocument](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md), [system_GlobalESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_GlobalESD.md), [system_SdmSystemModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md)
- HTML page: [classes/core_Activity/](https://altiumdeveloper.github.io/cdm/classes/core_Activity/)

Abstract base for process and work objects — things that happen, use inputs, and produce outputs. Examples: projects, design reviews, design workflows.

## In standards

- close: [prov:Activity](http://www.w3.org/ns/prov#Activity)
- related: [obo:BFO_0000015](http://purl.obolibrary.org/obo/BFO_0000015)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | verifiedByActivities | * |  |

---

# File: llms/classes/core_Artifact.md

# Artifact (core_Artifact)

- Name: `core_Artifact`
- IRI: `core:Artifact` (https://w3id.org/altium/cdm/core/Artifact)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: Artifact, abstract
- Is a: [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md)
- Subclasses: [con_EnvironmentConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/con_EnvironmentConfiguration.md), [con_SchematicTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplate.md), [con_SchematicTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md), [cus_Script](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Script.md), [cus_ScriptExecution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md), [cus_ScriptVersion](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md), [des_ManufacturingPackage](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md), [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md), [des_ProjectTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md), [des_ProjectTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplateRevision.md), [des_RuleCheck](https://altiumdeveloper.github.io/cdm/llms/classes/des_RuleCheck.md), [dm_FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md), [lib_Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md), [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md), [lib_ComponentTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplate.md), [lib_ComponentTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md), [lib_Datasheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Datasheet.md), [lib_Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md), [lib_FootprintRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md), [lib_ManagedSheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md), [lib_ManagedSheetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md), [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md), [lib_PcbSnippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippet.md), [lib_PcbSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippetRevision.md), [lib_ReuseBlock](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlock.md), [lib_ReuseBlockRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md), [lib_SchSnippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippet.md), [lib_SchSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippetRevision.md), [lib_Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md), [lib_SymbolRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md), [ota_DeploymentResult](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md), [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md), [ota_Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md), [ota_Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md), [plt_Application](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Application.md), [plt_EventSubscription](https://altiumdeveloper.github.io/cdm/llms/classes/plt_EventSubscription.md), [plt_LifecycleDefinition](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleDefinition.md), [plt_NamingScheme](https://altiumdeveloper.github.io/cdm/llms/classes/plt_NamingScheme.md), [plt_Organization](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Organization.md), [plt_SolutionRelease](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionRelease.md), [plt_User](https://altiumdeveloper.github.io/cdm/llms/classes/plt_User.md), [plt_UserGroup](https://altiumdeveloper.github.io/cdm/llms/classes/plt_UserGroup.md), [plt_Workspace](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Workspace.md), [plt_WorkspaceGroup](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceGroup.md), [plt_WorkspaceUser](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md), [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md), [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md), [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md), [req_RequirementRevision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md), [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md), [sft_AIModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md), [sft_BuildArtifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md), [sft_DeviceConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md), [sft_DeviceConfigurationRevision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md), [sft_SoftwareRelease](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md), [sup_Company](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Company.md), [sup_EvalKit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md), [sup_Offer](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Offer.md), [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md), [sup_PartFamily](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md), [sup_PartGroup](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md), [sup_ReferenceDesign](https://altiumdeveloper.github.io/cdm/llms/classes/sup_ReferenceDesign.md), [sup_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md), [sup_SolutionTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md), [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md)
- HTML page: [classes/core_Artifact/](https://altiumdeveloper.github.io/cdm/classes/core_Artifact/)

Abstract base for persistent data objects that are created, stored, versioned, and consumed. Examples: components, documents, system models.

## In standards

- close: [prov:Entity](http://www.w3.org/ns/prov#Entity)
- related: [obo:BFO_0000031](http://purl.obolibrary.org/obo/BFO_0000031)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/core_Entity.md

# Entity (core_Entity)

- Name: `core_Entity`
- IRI: `core:Entity` (https://w3id.org/altium/cdm/core/Entity)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: Entity, abstract
- Subclasses: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md), [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins (instantiates): [core_WithGRID](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithGRID.md), [core_WithMaturity](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithMaturity.md), [core_WithPlatformAPI](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithPlatformAPI.md)
- HTML page: [classes/core_Entity/](https://altiumdeveloper.github.io/cdm/classes/core_Entity/)

Abstract base for all identifiable, versioned, platform-accessible domain objects. Carries a GRID, maturity level, and platform API reference.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  |  |

---

# File: llms/classes/core_Event.md

# Event (core_Event)

- Name: `core_Event`
- IRI: `core:Event` (https://w3id.org/altium/cdm/core/Event)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: Event, abstract
- Subclasses: [cus_ScriptExecutionCompleted](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecutionCompleted.md)
- HTML page: [classes/core_Event/](https://altiumdeveloper.github.io/cdm/classes/core_Event/)

Abstract base for domain events. Events carry no GRID and no versioning lifecycle; they represent things that happened rather than persistent domain objects.

---

# File: llms/classes/core_Meta.md

# Meta (core_Meta)

- Name: `core_Meta`
- IRI: `core:Meta` (https://w3id.org/altium/cdm/core/Meta)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: abstract
- Subclasses: [core_WithGRID](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithGRID.md), [core_WithMaturity](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithMaturity.md), [core_WithPlatformAPI](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithPlatformAPI.md), [core_WithVault](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithVault.md), [core_WithVaultLink](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithVaultLink.md), [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md), [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md), [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md), [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md), [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md), [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md)
- HTML page: [classes/core_Meta/](https://altiumdeveloper.github.io/cdm/classes/core_Meta/)

Abstract base for all CDM mixin classes. Provides a common root for mixins without participating in the main Entity hierarchy.

---

# File: llms/classes/core_Resource.md

# Resource (core_Resource)

- Name: `core_Resource`
- IRI: `core:Resource` (https://w3id.org/altium/cdm/core/Resource)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: Resource, abstract
- Subclasses: [col_Comment](https://altiumdeveloper.github.io/cdm/llms/classes/col_Comment.md), [des_ProjectParameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md), [des_ProjectVariant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md), [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md), [dm_AddressMap](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressMap.md), [dm_AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md), [dm_ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md), [dm_FieldEnum](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FieldEnum.md), [dm_Memory](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Memory.md), [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md), [dm_PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md), [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md), [dm_PeripheralMode](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralMode.md), [dm_PeripheralParameter](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralParameter.md), [dm_PeripheralPinConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinConfig.md), [dm_PeripheralPinDependencyConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinDependencyConfig.md), [dm_Pin](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Pin.md), [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md), [dm_PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md), [dm_PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md), [dm_PortConfigurationEnumValue](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationEnumValue.md), [dm_PortConnection](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConnection.md), [dm_PortFunction](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortFunction.md), [dm_Processor](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Processor.md), [dm_Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md), [dm_RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md), [lib_ComponentParameter](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentParameter.md), [lib_PartChoice](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoice.md), [lib_PartChoiceList](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoiceList.md), [ota_DeploymentAssignment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentAssignment.md), [ota_PackageHash](https://altiumdeveloper.github.io/cdm/llms/classes/ota_PackageHash.md), [plt_LifecycleStage](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleStage.md), [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md), [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md), [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md), [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md), [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md), [sft_PinAssignment](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignment.md), [sft_PinAssignmentModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignmentModel.md), [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md), [system_Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md), [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md), [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md), [system_KeyComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md), [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md), [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md), [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md), [system_SdmAuthoringApplication](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmAuthoringApplication.md), [system_SdmClientMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmClientMetadata.md), [system_SdmConnection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md), [system_SdmDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md), [system_SdmEndpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md), [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md), [system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md), [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md), [system_SdmHardwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md), [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md), [system_SdmSoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md), [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md), [system_SdmSoftwareSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareSpecification.md), [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md), [system_SdmSystemModelVersionMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md), [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md), [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md)
- Mixins (instantiates): [core_WithPlatformAPI](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithPlatformAPI.md)
- HTML page: [classes/core_Resource/](https://altiumdeveloper.github.io/cdm/classes/core_Resource/)

Abstract base for lightweight platform-accessible objects that have API access but are not Entities; they carry no GRID and no versioning lifecycle.

---

# File: llms/classes/core_WithGRID.md

# With GRID (core_WithGRID)

- Name: `core_WithGRID`
- IRI: `core:WithGRID` (https://w3id.org/altium/cdm/core/WithGRID)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/core_WithGRID/](https://altiumdeveloper.github.io/cdm/classes/core_WithGRID/)

Mixin that adds a GRID annotation slot to a class.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| grid | GRID | 0..1 | GRID template |  |  |

---

# File: llms/classes/core_WithMaturity.md

# With Maturity (core_WithMaturity)

- Name: `core_WithMaturity`
- IRI: `core:WithMaturity` (https://w3id.org/altium/cdm/core/WithMaturity)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/core_WithMaturity/](https://altiumdeveloper.github.io/cdm/classes/core_WithMaturity/)

Mixin that adds a maturity annotation slot indicating the lifecycle readiness level.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| maturity | [Maturity](https://altiumdeveloper.github.io/cdm/llms/enums/Maturity.md) | 0..1 | Maturity level. |  |  |

---

# File: llms/classes/core_WithPlatformAPI.md

# With Platform API (core_WithPlatformAPI)

- Name: `core_WithPlatformAPI`
- IRI: `core:WithPlatformAPI` (https://w3id.org/altium/cdm/core/WithPlatformAPI)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/core_WithPlatformAPI/](https://altiumdeveloper.github.io/cdm/classes/core_WithPlatformAPI/)

Mixin that adds API type annotations: platformAPI names the Altium 365 Platform API GraphQL type; nexarAPI names the Nexar (Octopart) GraphQL type for supply-chain entities served by Nexar rather than the Platform API.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| platformAPI | string | 0..1 | Altium 365 Platform API type name. |  |  |
| nexarAPI | string | 0..1 | Nexar (Octopart) API type name. |  |  |

---

# File: llms/classes/core_WithVault.md

# With Vault (core_WithVault)

- Name: `core_WithVault`
- IRI: `core:WithVault` (https://w3id.org/altium/cdm/core/WithVault)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/core_WithVault/](https://altiumdeveloper.github.io/cdm/classes/core_WithVault/)

Mixin that adds a vault content type annotation to a class, indicating how its content is stored in the platform vault.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| contentType | [VaultContentType](https://altiumdeveloper.github.io/cdm/llms/enums/VaultContentType.md) | 0..1 | Vault Content Type |  |  |

---

# File: llms/classes/core_WithVaultLink.md

# With Vault Link (core_WithVaultLink)

- Name: `core_WithVaultLink`
- IRI: `core:WithVaultLink` (https://w3id.org/altium/cdm/core/WithVaultLink)
- Bounded context: [core](https://altiumdeveloper.github.io/cdm/llms/core.md)
- Kind: mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/core_WithVaultLink/](https://altiumdeveloper.github.io/cdm/classes/core_WithVaultLink/)

Mixin that adds vault link parent, child, and type annotation slots for tracking hierarchical vault relationships.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| vaultLinkParent | uriorcurie | 0..1 | Vault Link Parent |  |  |
| vaultLinkChild | uriorcurie | 0..1 | Vault Link Parent |  |  |
| vaultLinkType | string | 0..1 | Vault Link Parent |  |  |

---

# File: llms/classes/cus_Script.md

# Script (cus_Script)

- Name: `cus_Script`
- IRI: `cus:Script` (https://w3id.org/altium/cdm/customization/Script)
- Bounded context: [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/cus_Script/](https://altiumdeveloper.github.io/cdm/classes/cus_Script/)

## In the API

- Platform API type: [`GloScrScript`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloScrScript/) (object)

## GRID

`grid:workspace:{workspace-id}:scripts:script/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [cus_ScriptVersion](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/cus_ScriptExecution.md

# Script Execution (cus_ScriptExecution)

- Name: `cus_ScriptExecution`
- IRI: `cus:ScriptExecution` (https://w3id.org/altium/cdm/customization/ScriptExecution)
- Bounded context: [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/cus_ScriptExecution/](https://altiumdeveloper.github.io/cdm/classes/cus_ScriptExecution/)

## In the API

- Platform API type: [`GloScrScriptExecution`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloScrScriptExecution/) (object)

## GRID

`grid:workspace:{workspace-id}:scripts:execution/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| emits | [cus_ScriptExecutionCompleted](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecutionCompleted.md) | 0..1 |  |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [cus_ScriptVersion](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptVersion.md) | executions | * |  |

---

# File: llms/classes/cus_ScriptExecutionCompleted.md

# Script Execution Completed (cus_ScriptExecutionCompleted)

- Name: `cus_ScriptExecutionCompleted`
- IRI: `cus:ScriptExecutionCompleted` (https://w3id.org/altium/cdm/customization/ScriptExecutionCompleted)
- Bounded context: [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md)
- Kind: Event
- Is a: [core_Event](https://altiumdeveloper.github.io/cdm/llms/classes/core_Event.md)
- HTML page: [classes/cus_ScriptExecutionCompleted/](https://altiumdeveloper.github.io/cdm/classes/cus_ScriptExecutionCompleted/)

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [cus_ScriptExecution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md) | emits | 0..1 |  |

---

# File: llms/classes/cus_ScriptVersion.md

# Script Version (cus_ScriptVersion)

- Name: `cus_ScriptVersion`
- IRI: `cus:ScriptVersion` (https://w3id.org/altium/cdm/customization/ScriptVersion)
- Bounded context: [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/cus_ScriptVersion/](https://altiumdeveloper.github.io/cdm/classes/cus_ScriptVersion/)

## In the API

- Platform API type: [`GloScrScriptVersion`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloScrScriptVersion/) (object)

## GRID

`grid:workspace:{workspace-id}:scripts:script-version/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| executions | [cus_ScriptExecution](https://altiumdeveloper.github.io/cdm/llms/classes/cus_ScriptExecution.md) | * | Script executions produced by this script version. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [cus_Script](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Script.md) | revisions | * | core_revisions |

---

# File: llms/classes/cus_Workflow.md

# Workflow (cus_Workflow)

- Name: `cus_Workflow`
- IRI: `cus:Workflow` (https://w3id.org/altium/cdm/customization/Workflow)
- Bounded context: [customization](https://altiumdeveloper.github.io/cdm/llms/customization.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/cus_Workflow/](https://altiumdeveloper.github.io/cdm/classes/cus_Workflow/)

A process workflow of an Altium 365 Workspace: the workflow that belongs to a process definition and steps designers through an everyday design process (e.g. requesting a new part, a design review or creating a new project). Workspace administrators build process definitions in the Process Workflow Editor, grouped by process theme (Part Requests, Project Activities, Project Creations), and activate them; each started instance of a process follows the workflow and creates tasks for the users whose action is needed to move it on.

## In the product

- [Processes & Workflows](https://www.altium.com/documentation/altium-365/processes-workflows) (primary)
- [Create & Manage Electronics Design Processes](https://www.altium.com/documentation/altium-365/creating-managing-processes)
- [Defining a Process Workflow](https://www.altium.com/documentation/altium-365/defining-process-workflow)
- Term: **Process Workflow** (exact; altium-365)
- Term: **Process Definition** (related; altium-365)

## In the API

- Platform API type: [`DesWorkflowDefinition`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkflowDefinition/) (object)

## GRID

`grid:workspace:{workspace-id}:customization:workflow/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | workflow | 0..1 | core_informedBy |

---

# File: llms/classes/des_DesignReview.md

# Design Review (des_DesignReview)

- Name: `des_DesignReview`
- IRI: `des:DesignReview` (https://w3id.org/altium/cdm/design/DesignReview)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/des_DesignReview/](https://altiumdeveloper.github.io/cdm/classes/des_DesignReview/)

A structured assessment of a design project, carried out by assigned Reviewers on a fixed snapshot of its design and concluded by the Initiator's decision, which leaves a traceable record of the review.

## In the product

- [Design Reviews](https://www.altium.com/documentation/altium-365/project-design-reviews) (primary)

## GRID

`grid:workspace:{workspace-id}:design:design-review/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| project | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | 1 | The design project under review. | core_partOf |  |
| reviewContext | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | 0..1 | The project release under review, when the review context is a release. | core_occursIn |  |
| initiator | [plt_WorkspaceUser](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) | 1 | The Workspace member who created the review. |  |  |
| reviewers | [plt_WorkspaceUser](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) | * | The Workspace members asked to review the design. |  |  |
| workflow | [cus_Workflow](https://altiumdeveloper.github.io/cdm/llms/classes/cus_Workflow.md) | 0..1 | The process workflow that the review follows: the built-in Design Review process or a custom design review process. | core_informedBy |  |
| tasks | [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) | * | Tasks of the review: the process tasks created for the Initiator and the Reviewers, and tasks raised from comments placed on the design snapshot. | core_informs |  |
| commentThreads | [col_CommentThread](https://altiumdeveloper.github.io/cdm/llms/classes/col_CommentThread.md) | * | Comment threads placed on the design snapshot of the review, including those about checklist items. | core_hasPart |  |
| status | [des_DesignReviewStatus](https://altiumdeveloper.github.io/cdm/llms/enums/des_DesignReviewStatus.md) | 1 | The state of the review, from In Progress to its closed state. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ins_DesignInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_DesignInsight.md) | designReview | 1 | core_partOf |

---

# File: llms/classes/des_HarnessProject.md

# Harness Project (des_HarnessProject)

- Name: `des_HarnessProject`
- IRI: `des:HarnessProject` (https://w3id.org/altium/cdm/design/HarnessProject)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Activity
- Is a: [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md)
- HTML page: [classes/des_HarnessProject/](https://altiumdeveloper.github.io/cdm/classes/des_HarnessProject/)

Harness Project defines the design of a cable and wiring harness as a standalone yet integrable artifact, capturing connectors, wires, splices, and pin-to-pin mappings required to implement electrical interconnects between boards and system elements.

## Comments

- Harness Project provides a structured representation of connectivity at the physical wiring level, complementing schematic and PCB projects while maintaining its own lifecycle and identity. It enables engineers to design, document, and validate interconnects in a way that is traceable, manufacturable, and tightly integrated with Multiboard and MCAD workflows within the Altium ecosystem.

## In the product

- [Harness Design](https://www.altium.com/documentation/altium-designer/harness-design) (primary)

## In the API

- Platform API type: [`DesProject`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProject/) (object)
- Inherited from [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md).

## GRID

None declared (nearest ancestor `des_Project`: `grid:workspace:{workspace-id}:design:project/{id}`).

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | * | The release artifacts produced by this activity. | core_releases | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| parameters | [des_ProjectParameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md) | * |  |  | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| variants | [des_ProjectVariant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) | * |  |  | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/des_ManufacturingPackage.md

# Manufacturing Package (des_ManufacturingPackage)

- Name: `des_ManufacturingPackage`
- IRI: `des:ManufacturingPackage` (https://w3id.org/altium/cdm/design/ManufacturingPackage)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/des_ManufacturingPackage/](https://altiumdeveloper.github.io/cdm/classes/des_ManufacturingPackage/)

A read-only package that contains a subset of Project Release artifacts that is typically shared with an external party for the purposes of manufacturing the board (e.g. Manufacturing Package may contain fabrication/assembly files required by the factories, but not the sources of the project)

## In the product

- [Viewing Manufacturing Packages](https://www.altium.com/documentation/altium-365/viewers/manufacturing-package-viewer) (primary)
- [Management of a Specific Project](https://www.altium.com/documentation/altium-365/management-specific-project#SAMPYM)
- Term: **Build Package** (related; altium-365)

## GRID

`grid:workspace:{workspace-id}:design:manufacturing-package/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| projectRelease | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | 1 | Manufacturing Packages are created based on a specific Project Release. | core_derivedFrom |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/des_MultiboardProject.md

# Multiboard Project (des_MultiboardProject)

- Name: `des_MultiboardProject`
- IRI: `des:MultiboardProject` (https://w3id.org/altium/cdm/design/MultiboardProject)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Activity
- Is a: [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md)
- HTML page: [classes/des_MultiboardProject/](https://altiumdeveloper.github.io/cdm/classes/des_MultiboardProject/)

Multiboard Project represents the coordinated design of multiple interconnected PCB projects assembled into a single system, capturing both their logical interconnects and physical arrangements.

## Comments

- Multiboard Project serves as an aggregate that composes individual board Projects into a higher-level system entity, maintaining identity and traceability across design boundaries. It enables engineers to define harnesses, connectors, and mechanical fit at the system level, while preserving the autonomy of each board design, thus supporting codesign, simulation, and integration workflows across ECAD and MCAD domains.

## In the product

- [Designing with Multiple PCBs](https://www.altium.com/documentation/altium-designer/multi-board-design#structure_multi_board_design_project) (primary)

## In the API

- Platform API type: [`DesProject`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProject/) (object)
- Inherited from [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md).

## GRID

None declared (nearest ancestor `des_Project`: `grid:workspace:{workspace-id}:design:project/{id}`).

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| projects | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | * | The individual PCB projects that make up this Multiboard Project. | core_hasPart |  |
| releases | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | * | The release artifacts produced by this activity. | core_releases | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| parameters | [des_ProjectParameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md) | * |  |  | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| variants | [des_ProjectVariant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) | * |  |  | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/des_Project.md

# Hardware Project (des_Project)

- Name: `des_Project`
- IRI: `des:Project` (https://w3id.org/altium/cdm/design/Project)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Subclasses: [des_HarnessProject](https://altiumdeveloper.github.io/cdm/llms/classes/des_HarnessProject.md), [des_MultiboardProject](https://altiumdeveloper.github.io/cdm/llms/classes/des_MultiboardProject.md)
- Mixins: [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md)
- HTML page: [classes/des_Project/](https://altiumdeveloper.github.io/cdm/classes/des_Project/)

A design project stored in a Workspace, normally under its built-in version control, such as a PCB project. It groups the design documents that together define one implementation of a product, along with its project parameters and variants; it is the source from which releases are made and from which Managed BOMs can be created.

## In the product

- [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects) (primary)
- [Creating Projects and Documents](https://www.altium.com/documentation/altium-designer/creating-projects-documents)
- Term: **Workspace project** (exact; altium-365, altium-designer)
- Term: **design project** (related; altium-designer, altium-365)

## In the API

- Platform API type: [`DesProject`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProject/) (object)

## GRID

`grid:workspace:{workspace-id}:design:project/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | * | The release artifacts produced by this activity. | core_releases |  |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput |  |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput |  |
| parameters | [des_ProjectParameter](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectParameter.md) | * |  |  |  |
| variants | [des_ProjectVariant](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectVariant.md) | * |  |  |  |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | project | 1 | core_partOf |
| [des_MultiboardProject](https://altiumdeveloper.github.io/cdm/llms/classes/des_MultiboardProject.md) | projects | * | core_hasPart |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | informedBy | * | core_informedBy |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | usedByProjectVariant | * | core_inputOf |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | implementedBy | 0..1 | core_implementedBy |
| [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) | implementedBy | 0..1 | core_implementedBy |
| [system_SdmHardwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) | implementedBy | 0..1 | core_implementedBy |

---

# File: llms/classes/des_ProjectParameter.md

# Project Parameter (des_ProjectParameter)

- Name: `des_ProjectParameter`
- IRI: `des:ProjectParameter` (https://w3id.org/altium/cdm/design/ProjectParameter)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/des_ProjectParameter/](https://altiumdeveloper.github.io/cdm/classes/des_ProjectParameter/)

A name/value parameter defined at the level of a design project. It is either a Workspace-side (server-side) parameter, kept with the project in the Workspace and editable only there, or a design-side parameter, kept in the project file (e.g. *.PrjPcb) and editable in Altium Designer. Both kinds appear in the project options and can be used as special strings in design documents.

## In the product

- [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects#project_parameters) (primary)
- [Accessing, Defining & Managing Project Options](https://www.altium.com/documentation/altium-designer/accessing-defining-managing-project-options#parameters)

## In the API

- Platform API type: [`DesProjectParameter`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProjectParameter/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 |  |  |  |
| value | string | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | parameters | * |  |

---

# File: llms/classes/des_ProjectRelease.md

# Hardware Project Release (des_ProjectRelease)

- Name: `des_ProjectRelease`
- IRI: `des:ProjectRelease` (https://w3id.org/altium/cdm/design/ProjectRelease)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/des_ProjectRelease/](https://altiumdeveloper.github.io/cdm/classes/des_ProjectRelease/)

Project Release captures an immutable snapshot of a PCB design project at a specific point in its lifecycle, packaging all design data, outputs, and metadata required for manufacturing, assembly, and downstream processes.

## Comments

- Project Release serves as the authoritative artifact that bridges design and production, ensuring repeatability, traceability, and regulatory compliance. Its identity is tied to the originating Project but remains stable as a versioned deliverable, enabling teams to collaborate confidently, audit changes, and integrate with supply chain and PLM systems through Altium 365 and related workflows.

## In the product

- [Design Project Release](https://www.altium.com/documentation/altium-designer/preparing-for-manufacture/design-release) (primary)
- [Releasing to a Workspace](https://www.altium.com/documentation/altium-designer/preparing-for-manufacture/design-release/workspace)
- Term: **design project release** (related; altium-designer)

## In the API

- Platform API type: [`DesRelease`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesRelease/) (object)

## GRID

`grid:workspace:{workspace-id}:design:project-release/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| consistsOfComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Artifact | core_hasPart |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | reviewContext | 0..1 | core_occursIn |
| [des_ManufacturingPackage](https://altiumdeveloper.github.io/cdm/llms/classes/des_ManufacturingPackage.md) | projectRelease | 1 | core_derivedFrom |
| [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | releases | * | core_releases |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | occursIn | * | core_occursIn |
| [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | targetsProjectReleases | * |  |

---

# File: llms/classes/des_ProjectTemplate.md

# Project Template (des_ProjectTemplate)

- Name: `des_ProjectTemplate`
- IRI: `des:ProjectTemplate` (https://w3id.org/altium/cdm/design/ProjectTemplate)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/des_ProjectTemplate/](https://altiumdeveloper.github.io/cdm/classes/des_ProjectTemplate/)

A reusable starting point for new design projects that bundles the documents, files and project settings a team wants to apply again and again. A project created from a template receives the template's documents and its project options.

## Comments

- Besides the usual project documents, a template may carry reference documentation, configuration files and Output Jobs, together with agreed project and document settings such as design rules, parameters, title blocks and release options.
- Templates are available for PCB, multi-board and harness projects. A Workspace project template is kept as a series of revisions; saving an edited template creates its next revision, and new projects are based on the latest revisions shared with the user.

## In the product

- [Creating a Project Template](https://www.altium.com/documentation/altium-designer/creating-project-template) (primary)

## In the API

- Platform API type: [`DesProjectTemplate`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProjectTemplate/) (object)

## GRID

`grid:workspace:{workspace-id}:design:project-template/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [des_ProjectTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplateRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/des_ProjectTemplateRevision.md

# Project Template Revision (des_ProjectTemplateRevision)

- Name: `des_ProjectTemplateRevision`
- IRI: `des:ProjectTemplateRevision` (https://w3id.org/altium/cdm/design/ProjectTemplateRevision)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/des_ProjectTemplateRevision/](https://altiumdeveloper.github.io/cdm/classes/des_ProjectTemplateRevision/)

An immutable revision of a project template.

## In the API

- Platform API type: [`DesProjectTemplateRevision`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesProjectTemplateRevision/) (object)

## GRID

`grid:workspace:{workspace-id}:design:project-template-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_ProjectTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectTemplate.md) | revisions | * | core_revisions |

---

# File: llms/classes/des_ProjectVariant.md

# Hardware Project Variant (des_ProjectVariant)

- Name: `des_ProjectVariant`
- IRI: `des:ProjectVariant` (https://w3id.org/altium/cdm/design/ProjectVariant)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/des_ProjectVariant/](https://altiumdeveloper.github.io/cdm/classes/des_ProjectVariant/)

A design variant of a project: a named variation of the same base design that is assembled with a different set of components. Within a variant, each component can be fitted, not fitted, fitted with varied parameters, or replaced by an alternate part, and the variant can define its own variant-level parameters. Assembly variants share one bare board, whereas fabrication variants also change overlay information and so need a different board.

## In the product

- [Design Variants](https://www.altium.com/documentation/altium-designer/design-variants) (primary)
- [Working with the Variant Manager](https://www.altium.com/documentation/altium-designer/variant-manager)
- Term: **design variant** (exact; altium-designer)

## In the API

- Platform API type: [`DesWipVariant`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWipVariant/) (object)

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | variants | * |  |

---

# File: llms/classes/des_RuleCheck.md

# Rule Check (des_RuleCheck)

- Name: `des_RuleCheck`
- IRI: `des:RuleCheck` (https://w3id.org/altium/cdm/design/RuleCheck)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/des_RuleCheck/](https://altiumdeveloper.github.io/cdm/classes/des_RuleCheck/)

Rule check definitions that can be executed against a project to validate design integrity and compliance with specified constraints.

## In the API

- Platform API type: [`RuleCheck`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/RuleCheck/) (object)

## GRID

`grid:workspace:{workspace-id}:design:rule-check/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/des_RuleCheckExecution.md

# Rule Check Execution (des_RuleCheckExecution)

- Name: `des_RuleCheckExecution`
- IRI: `des:RuleCheckExecution` (https://w3id.org/altium/cdm/design/RuleCheckExecution)
- Bounded context: [design](https://altiumdeveloper.github.io/cdm/llms/design.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/des_RuleCheckExecution/](https://altiumdeveloper.github.io/cdm/classes/des_RuleCheckExecution/)

Execution of a rule check against a project to validate design integrity and compliance with specified constraints.

## In the API

- Platform API type: [`RuleCheckExecution`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/RuleCheckExecution/) (object)

## GRID

`grid:workspace:{workspace-id}:design:rule-check-execution/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/dm_AddressBlock.md

# AddressBlock (dm_AddressBlock)

- Name: `dm_AddressBlock`
- IRI: `dm:AddressBlock` (https://w3id.org/altium/cdm/deviceModel/AddressBlock)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md)
- HTML page: [classes/dm_AddressBlock/](https://altiumdeveloper.github.io/cdm/classes/dm_AddressBlock/)

Address block with start, size, and optional registers and peripherals.

## In the API

- Platform API type: [`DmAddressBlock`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAddressBlock/) (object)

## In standards

- related: [CMSIS-SVD addressBlock element](https://open-cmsis-pack.github.io/svd-spec/main/elem_peripherals.html#elem_addressBlock)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the address block. |  |  |
| type | [dm_AddressBlockType](https://altiumdeveloper.github.io/cdm/llms/enums/dm_AddressBlockType.md) | 0..1 | The type of the address block. |  |  |
| memories | [dm_Memory](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Memory.md) | * | List of memory entries associated with this block. |  |  |
| registers | [dm_Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md) | * | List of registers contained within this address block. |  |  |
| peripheralInstance | [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | 0..1 | A peripheral instance associated with this address block. |  |  |
| startAddress | integer | 1 | The base physical address of the memory region. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |
| size | integer | 0..1 | The total span of the memory region in bytes. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md) | blocks | * |  |

---

# File: llms/classes/dm_AddressMap.md

# AddressMap (dm_AddressMap)

- Name: `dm_AddressMap`
- IRI: `dm:AddressMap` (https://w3id.org/altium/cdm/deviceModel/AddressMap)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_AddressMap/](https://altiumdeveloper.github.io/cdm/classes/dm_AddressMap/)

Address map for the device including memory and peripheral regions.

## In the API

- Platform API type: [`DmAddressMapModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAddressMapModel/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| segments | [dm_AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md) | * | A collection of memory segments defined within the device's address space. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) | addressMap | 0..1 |  |

---

# File: llms/classes/dm_AddressSegment.md

# AddressSegment (dm_AddressSegment)

- Name: `dm_AddressSegment`
- IRI: `dm:AddressSegment` (https://w3id.org/altium/cdm/deviceModel/AddressSegment)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md)
- HTML page: [classes/dm_AddressSegment/](https://altiumdeveloper.github.io/cdm/classes/dm_AddressSegment/)

A contiguous region of the device's memory map. Each segment can represent either a memory or a peripheral region.

## In the API

- Platform API type: [`DmAddressSegment`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAddressSegment/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the address segment. |  |  |
| aliases | string | * | Alternative names for the segment. |  |  |
| blocks | [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) | * | The nested address blocks within the segment |  |  |
| peripherals | [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) | * | The peripherals associated with this segment. |  |  |
| startAddress | integer | 1 | The base physical address of the memory region. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |
| size | integer | 0..1 | The total span of the memory region in bytes. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressMap](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressMap.md) | segments | * |  |

---

# File: llms/classes/dm_ConfiguredDeviceModel.md

# ConfiguredDeviceModel (dm_ConfiguredDeviceModel)

- Name: `dm_ConfiguredDeviceModel`
- IRI: `dm:ConfiguredDeviceModel` (https://w3id.org/altium/cdm/deviceModel/ConfiguredDeviceModel)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_ConfiguredDeviceModel/](https://altiumdeveloper.github.io/cdm/classes/dm_ConfiguredDeviceModel/)

A digital twin of an embedded hardware device as configured for a specific use-case. It exposes the device model filtered to specific device configuration.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) (primary)

## In the API

- Platform API type: [`DmDeviceModelAsConfigured`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmDeviceModelAsConfigured/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| boardName | string | 0..1 | Board name for the device |  |  |
| mpn | string | 1 | Manufacturer Part Number (MPN) for the device. |  |  |
| peripherals | [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) | * | List of all peripherals available on the device. |  |  |
| ports | [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | * | List of physical ports on the device. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) | deviceModelId | 0..1 |  |
| [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) | deviceModelId | 0..1 |  |

---

# File: llms/classes/dm_FieldEnum.md

# FieldEnum (dm_FieldEnum)

- Name: `dm_FieldEnum`
- IRI: `dm:FieldEnum` (https://w3id.org/altium/cdm/deviceModel/FieldEnum)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_FieldEnum/](https://altiumdeveloper.github.io/cdm/classes/dm_FieldEnum/)

An enumerated value for a register field.

## In the API

- Platform API type: [`DmAmFieldEnum`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAmFieldEnum/) (object)

## In standards

- exact: [CMSIS-SVD enumeratedValue element](https://open-cmsis-pack.github.io/svd-spec/main/elem_registers.html#elem_enumeratedValue)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the enumerated value. |  |  |
| value | string | 0..1 | The actual value of the enumeration. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md) | enums | * |  |

---

# File: llms/classes/dm_FullStackDeviceModel.md

# FullStackDeviceModel (dm_FullStackDeviceModel)

- Name: `dm_FullStackDeviceModel`
- IRI: `dm:FullStackDeviceModel` (https://w3id.org/altium/cdm/deviceModel/FullStackDeviceModel)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/dm_FullStackDeviceModel/](https://altiumdeveloper.github.io/cdm/classes/dm_FullStackDeviceModel/)

A digital twin of an embedded hardware device. It exposes the full device model, including interfaces, peripherals, and ports.

## In the API

- Platform API type: [`DmFullStackDeviceModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmFullStackDeviceModel/) (object)

## In standards

- close: [CMSIS-SVD device element](https://open-cmsis-pack.github.io/svd-spec/main/elem_device.html)
- close: [CMSIS-Pack PDSC device element](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_family_pg.html#element_device)

## GRID

`grid:global::device-model:fullstack-dm/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| mpn | string | 1 | Manufacturer Part Number (MPN) for the device. |  |  |
| peripherals | [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) | * | List of all peripherals available on the device. |  |  |
| ports | [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | * | List of physical ports on the device. |  |  |
| family | string | 1 | The family to which the device belongs. |  |  |
| processors | [dm_Processor](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Processor.md) | * | List of processors included in the device. |  |  |
| addressMap | [dm_AddressMap](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressMap.md) | 0..1 | The hardware address map configuration. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/dm_HasAddressRange.md

# dm_HasAddressRange

- Name: `dm_HasAddressRange`
- IRI: `dm:HasAddressRange` (https://w3id.org/altium/cdm/deviceModel/HasAddressRange)
- Bounded context: none
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/dm_HasAddressRange/](https://altiumdeveloper.github.io/cdm/classes/dm_HasAddressRange/)

A mixin for entities that occupy a specific span of the memory map. It provides the foundational properties required for addressing and size-based feasibility checks.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| startAddress | integer | 1 | The base physical address of the memory region. |  |  |
| size | integer | 0..1 | The total span of the memory region in bytes. |  |  |

---

# File: llms/classes/dm_Memory.md

# Memory (dm_Memory)

- Name: `dm_Memory`
- IRI: `dm:Memory` (https://w3id.org/altium/cdm/deviceModel/Memory)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_Memory/](https://altiumdeveloper.github.io/cdm/classes/dm_Memory/)

A memory entry within an address block.

## In the API

- Platform API type: [`DmAmMemory`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAmMemory/) (object)

## In standards

- close: [CMSIS-Pack PDSC memory element](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_family_pg.html#element_memory)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | The name of the memory entry. |  |  |
| type | string | 0..1 | The type of memory entry. |  |  |
| size | integer | 0..1 | The total span of the memory region in bytes. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) | memories | * |  |

---

# File: llms/classes/dm_Peripheral.md

# Peripheral (dm_Peripheral)

- Name: `dm_Peripheral`
- IRI: `dm:Peripheral` (https://w3id.org/altium/cdm/deviceModel/Peripheral)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_Peripheral/](https://altiumdeveloper.github.io/cdm/classes/dm_Peripheral/)

A single peripheral definition, including its instances and properties.

## In the API

- Platform API type: [`DmPeripheral`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPeripheral/) (object)

## In standards

- related: [CMSIS-SVD peripheral element](https://open-cmsis-pack.github.io/svd-spec/main/elem_peripherals.html#elem_peripheral)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | The name of the peripheral. |  |  |
| instances | [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | * | The list of instances of this peripheral present on the device. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressSegment](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressSegment.md) | peripherals | * |  |
| [dm_ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) | peripherals | * |  |
| [dm_FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) | peripherals | * |  |
| [system_SdmDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md) | peripherals | * |  |

---

# File: llms/classes/dm_PeripheralConfiguration.md

# PeripheralConfiguration (dm_PeripheralConfiguration)

- Name: `dm_PeripheralConfiguration`
- IRI: `dm:PeripheralConfiguration` (https://w3id.org/altium/cdm/deviceModel/PeripheralConfiguration)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralConfiguration/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralConfiguration/)

A concrete configuration for a peripheral role, containing pin multiplexing details.

## In the API

- Platform API type `DmPeripheralConfiguration` is named by the class but is not in the API snapshot.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| parameters | [dm_PeripheralParameter](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralParameter.md) | * | The list of parameters associated with this peripheral configuration. |  |  |
| pinConfigs | [dm_PeripheralPinConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinConfig.md) | * | The list of pin function to port mappings for this configuration. |  |  |
| pinDependencyConfigs | [dm_PeripheralPinDependencyConfig](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralPinDependencyConfig.md) | * | The list of alternative pin configurations that must be applied together with this configuration. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralMode](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralMode.md) | configurations | * |  |

---

# File: llms/classes/dm_PeripheralInstance.md

# PeripheralInstance (dm_PeripheralInstance)

- Name: `dm_PeripheralInstance`
- IRI: `dm:PeripheralInstance` (https://w3id.org/altium/cdm/deviceModel/PeripheralInstance)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralInstance/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralInstance/)

A concrete instance of a peripheral (e.g., SCI0), including available modes.

## In the API

- Platform API type: [`DmPeripheralInstance`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPeripheralInstance/) (object)

## In standards

- close: [CMSIS-SVD peripheral element](https://open-cmsis-pack.github.io/svd-spec/main/elem_peripherals.html#elem_peripheral)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | The name of the peripheral instance. |  |  |
| unit | string | 0..1 | The specific hardware unit index for the peripheral instance. |  |  |
| modes | [dm_PeripheralMode](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralMode.md) | * | The list of modes this peripheral instance can fulfill (e.g., Asynchronous UART). |  |  |
| interfaceType | string | 0..1 | The generic interface this peripheral instance is configured as. |  |  |
| virtualization | [dm_PeripheralVirtualization](https://altiumdeveloper.github.io/cdm/llms/enums/dm_PeripheralVirtualization.md) | 0..1 | Specifies how this peripheral instance is virtualized, indicating whether the instance represents a single, non-virtualized peripheral or a channel-virtualized peripheral where individual functions act as separate interface instances. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) | peripheralInstance | 0..1 |  |
| [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) | instances | * |  |
| [dm_PortFunction](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortFunction.md) | peripheralInstance | 0..1 |  |
| [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | peripheralInstanceId | 0..1 |  |
| [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | peripheralInstanceId | 0..1 |  |

---

# File: llms/classes/dm_PeripheralMode.md

# PeripheralMode (dm_PeripheralMode)

- Name: `dm_PeripheralMode`
- IRI: `dm:PeripheralMode` (https://w3id.org/altium/cdm/deviceModel/PeripheralMode)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralMode/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralMode/)

A specific mode that a peripheral instance can fulfill,

## In the API

- Platform API type: [`DmPeripheralMode`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPeripheralMode/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | Name of the peripheral mode (e.g., Asynchronous UART). |  |  |
| configurations | [dm_PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) | * | The configurations available within this peripheral modes. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | modes | * |  |

---

# File: llms/classes/dm_PeripheralParameter.md

# PeripheralParameter (dm_PeripheralParameter)

- Name: `dm_PeripheralParameter`
- IRI: `dm:PeripheralParameter` (https://w3id.org/altium/cdm/deviceModel/PeripheralParameter)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralParameter/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralParameter/)

A parameter associated with peripheral instance configuration.

## In the API

- Platform API type `DmPeripheralParameters` is named by the class but is not in the API snapshot.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | The name of the peripheral parameter. |  |  |
| value | string | 1 | The value of the peripheral parameter. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) | parameters | * |  |

---

# File: llms/classes/dm_PeripheralPinConfig.md

# PeripheralPinConfig (dm_PeripheralPinConfig)

- Name: `dm_PeripheralPinConfig`
- IRI: `dm:PeripheralPinConfig` (https://w3id.org/altium/cdm/deviceModel/PeripheralPinConfig)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralPinConfig/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralPinConfig/)

A specific pin multiplexing configuration within peripheral configuration.

## In the API

- Platform API type `DmPeripheralPinConfig` is named by the class but is not in the API snapshot.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| pinName | string | 0..1 | The fully qualified identifier representing the channel, and pin function (e.g., sci0.txt, iic1.scl). |  |  |
| pinValue | string | 0..1 | The fully qualified identifier representing the channel, pin function, and physical pin (e.g., sci0.txd.p101, iic1.scl.p402). |  |  |
| function | string | 0..1 | The logical pin function name (e.g., TXD, RXD). |  |  |
| port | string | 0..1 | The physical port target for the pin function. |  |  |
| portName | string | 0..1 | The physical port mapping target for the pin function. |  |  |
| channel | string | 0..1 | Identifies the specific virtualized channel used by this pin configuration. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) | pinConfigs | * |  |

---

# File: llms/classes/dm_PeripheralPinDependencyConfig.md

# PeripheralPinDependencyConfig (dm_PeripheralPinDependencyConfig)

- Name: `dm_PeripheralPinDependencyConfig`
- IRI: `dm:PeripheralPinDependencyConfig` (https://w3id.org/altium/cdm/deviceModel/PeripheralPinDependencyConfig)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PeripheralPinDependencyConfig/](https://altiumdeveloper.github.io/cdm/classes/dm_PeripheralPinDependencyConfig/)

A pin dependency to port mapping entry within peripheral configuration.

## In the API

- Platform API type `DmPeripheralPinDependencyConfig` is named by the class but is not in the API snapshot.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | The name of the pin dependency configuration. |  |  |
| value | string | 0..1 | The value of the pin dependency configuration. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralConfiguration.md) | pinDependencyConfigs | * |  |

---

# File: llms/classes/dm_Pin.md

# Pin (dm_Pin)

- Name: `dm_Pin`
- IRI: `dm:Pin` (https://w3id.org/altium/cdm/deviceModel/Pin)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_Pin/](https://altiumdeveloper.github.io/cdm/classes/dm_Pin/)

A physical pin on the device.

## In the API

- Platform API type: [`DmPin`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPin/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | The name of the pin. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | pin | 0..1 |  |

---

# File: llms/classes/dm_Port.md

# Port (dm_Port)

- Name: `dm_Port`
- IRI: `dm:Port` (https://w3id.org/altium/cdm/deviceModel/Port)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_Port/](https://altiumdeveloper.github.io/cdm/classes/dm_Port/)

A physical port on the device, with its functions, configurations, and connections.

## In the API

- Platform API type: [`DmPort`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPort/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the port. |  |  |
| symbolicName | string | 0..1 | A symbolic name for the port used in code or configuration. |  |  |
| pin | [dm_Pin](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Pin.md) | 0..1 | The physical pin associated with this port. |  |  |
| functions | [dm_PortFunction](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortFunction.md) | * | The list of functions that this port can perform. |  |  |
| configurations | [dm_PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md) | * | The list of configurations available for this port. |  |  |
| connections | [dm_PortConnection](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConnection.md) | * | The list of connections associated with this port to other components or signals. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) | ports | * |  |
| [dm_FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) | ports | * |  |
| [system_SdmDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md) | ports | * |  |

---

# File: llms/classes/dm_PortConfiguration.md

# PortConfiguration (dm_PortConfiguration)

- Name: `dm_PortConfiguration`
- IRI: `dm:PortConfiguration` (https://w3id.org/altium/cdm/deviceModel/PortConfiguration)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PortConfiguration/](https://altiumdeveloper.github.io/cdm/classes/dm_PortConfiguration/)

A specific configuration for a port.

## In the API

- Platform API type: [`DmPortConfiguration`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPortConfiguration/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | The name of the port configuration. |  |  |
| enumValues | [dm_PortConfigurationEnumValue](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationEnumValue.md) | * | The possible values that can be associated with this port configuration. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | configurations | * |  |

---

# File: llms/classes/dm_PortConfigurationDependency.md

# PortConfigurationDependency (dm_PortConfigurationDependency)

- Name: `dm_PortConfigurationDependency`
- IRI: `dm:PortConfigurationDependency` (https://w3id.org/altium/cdm/deviceModel/PortConfigurationDependency)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PortConfigurationDependency/](https://altiumdeveloper.github.io/cdm/classes/dm_PortConfigurationDependency/)

A dependency describing how a configuration value maps to GPIO or alternate function usage.

## In the API

- Platform API type: [`DmConfigDependency`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmConfigDependency/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| configRef | string | 1 | Root configuration reference token (e.g., P408). |  |  |
| altRef | string | 0..1 | Full alternative reference string used to derive mode/function tokens. |  |  |
| port | string | 0..1 | Port identifier extracted from the configuration reference (e.g., P000). |  |  |
| portMode | [dm_PortMode](https://altiumdeveloper.github.io/cdm/llms/enums/dm_PortMode.md) | 0..1 | Port mode. |  |  |
| gpioMode | [dm_GpioMode](https://altiumdeveloper.github.io/cdm/llms/enums/dm_GpioMode.md) | 0..1 | GPIO mode. |  |  |
| peripheralInstanceName | string | 0..1 | Peripheral instance name for alternate function mode (e.g., SCI0). |  |  |
| functionName | string | 0..1 | Peripheral function name for alternate mode (e.g., TXD, RXD). |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PortConfigurationEnumValue](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationEnumValue.md) | dependencies | * |  |

---

# File: llms/classes/dm_PortConfigurationEnumValue.md

# PortConfigurationEnumValue (dm_PortConfigurationEnumValue)

- Name: `dm_PortConfigurationEnumValue`
- IRI: `dm:PortConfigurationEnumValue` (https://w3id.org/altium/cdm/deviceModel/PortConfigurationEnumValue)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PortConfigurationEnumValue/](https://altiumdeveloper.github.io/cdm/classes/dm_PortConfigurationEnumValue/)

An enumerated value for a port configuration.

## In the API

- Platform API type: [`DmConfigEnumValue`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmConfigEnumValue/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | The name of the enumerated value. |  |  |
| dependencies | [dm_PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md) | * | The list of dependencies associated with this enumerated value. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PortConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfiguration.md) | enumValues | * |  |

---

# File: llms/classes/dm_PortConnection.md

# PortConnection (dm_PortConnection)

- Name: `dm_PortConnection`
- IRI: `dm:PortConnection` (https://w3id.org/altium/cdm/deviceModel/PortConnection)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PortConnection/](https://altiumdeveloper.github.io/cdm/classes/dm_PortConnection/)

A connection from this port to another component or signal.

## In the API

- Platform API type: [`DmPortConnection`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPortConnection/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | The name of the port connection. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | connections | * |  |

---

# File: llms/classes/dm_PortFunction.md

# PortFunction (dm_PortFunction)

- Name: `dm_PortFunction`
- IRI: `dm:PortFunction` (https://w3id.org/altium/cdm/deviceModel/PortFunction)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_PortFunction/](https://altiumdeveloper.github.io/cdm/classes/dm_PortFunction/)

A specific function that a port can perform.

## In the product

- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project) (primary)

## In the API

- Platform API type: [`DmPortFunction`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmPortFunction/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | The name of the port function. |  |  |
| peripheralInstance | [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | 0..1 | The peripheral instance associated with this port function. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | functions | * |  |

---

# File: llms/classes/dm_Processor.md

# Processor (dm_Processor)

- Name: `dm_Processor`
- IRI: `dm:Processor` (https://w3id.org/altium/cdm/deviceModel/Processor)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_Processor/](https://altiumdeveloper.github.io/cdm/classes/dm_Processor/)

Represents a physical processing core. Defining endianness and clock frequency allows the system to determine if the hardware can meet the computational and data-ordering requirements of a use-case.

## In standards

- close: [CMSIS-Pack PDSC processor element](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_family_pg.html#element_processor)
- close: [CMSIS-SVD cpu element](https://open-cmsis-pack.github.io/svd-spec/main/elem_cpu.html)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | The unique identifier for this processor instance. |  |  |
| core | string | 1 | Architectural core type (e.g., Cortex-M4). |  |  |
| endian | [dm_Endianness](https://altiumdeveloper.github.io/cdm/llms/enums/dm_Endianness.md) | 1 | The byte-ordering capability of the core. |  |  |
| clock | integer | 1 | The operating frequency in Hz. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_FullStackDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FullStackDeviceModel.md) | processors | * |  |

---

# File: llms/classes/dm_Register.md

# Register (dm_Register)

- Name: `dm_Register`
- IRI: `dm:Register` (https://w3id.org/altium/cdm/deviceModel/Register)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md)
- HTML page: [classes/dm_Register/](https://altiumdeveloper.github.io/cdm/classes/dm_Register/)

A hardware register within an address block.

## In the API

- Platform API type: [`DmAmRegister`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAmRegister/) (object)

## In standards

- close: [CMSIS-SVD register element](https://open-cmsis-pack.github.io/svd-spec/main/elem_registers.html#elem_register)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the register. |  |  |
| access | [dm_AccessType](https://altiumdeveloper.github.io/cdm/llms/enums/dm_AccessType.md) | 0..1 | The access type of the register. |  |  |
| resetValue | string | 0..1 | The value to reset the register. |  |  |
| resetMask | string | 0..1 | The mask applied during register reset. |  |  |
| fields | [dm_RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md) | * | Bit fields within this register. |  |  |
| startAddress | integer | 1 | The base physical address of the memory region. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |
| size | integer | 0..1 | The total span of the memory region in bytes. |  | [dm_HasAddressRange](https://altiumdeveloper.github.io/cdm/llms/classes/dm_HasAddressRange.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) | registers | * |  |

---

# File: llms/classes/dm_RegisterField.md

# RegisterField (dm_RegisterField)

- Name: `dm_RegisterField`
- IRI: `dm:RegisterField` (https://w3id.org/altium/cdm/deviceModel/RegisterField)
- Bounded context: [deviceModel](https://altiumdeveloper.github.io/cdm/llms/deviceModel.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/dm_RegisterField/](https://altiumdeveloper.github.io/cdm/classes/dm_RegisterField/)

A bit field within a register.

## In the API

- Platform API type: [`DmAmRegisterField`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DmAmRegisterField/) (object)

## In standards

- exact: [CMSIS-SVD field element](https://open-cmsis-pack.github.io/svd-spec/main/elem_registers.html#elem_field)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 | A brief description of the entity. |  |  |
| name | string | 0..1 | The name of the register field. |  |  |
| lsb | integer | 0..1 | The least significant bit position of the field. |  |  |
| msb | integer | 0..1 | The most significant bit position of the field. |  |  |
| access | [dm_AccessType](https://altiumdeveloper.github.io/cdm/llms/enums/dm_AccessType.md) | 0..1 | The access type of the register field. |  |  |
| enums | [dm_FieldEnum](https://altiumdeveloper.github.io/cdm/llms/classes/dm_FieldEnum.md) | * | Enumerated values for the register field. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md) | fields | * |  |

---

# File: llms/classes/ins_DesignInsight.md

# Design Insight (ins_DesignInsight)

- Name: `ins_DesignInsight`
- IRI: `ins:DesignInsight` (https://w3id.org/altium/cdm/insights/DesignInsight)
- Bounded context: [insights](https://altiumdeveloper.github.io/cdm/llms/insights.md)
- Kind: Activity
- Is a: [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md)
- HTML page: [classes/ins_DesignInsight/](https://altiumdeveloper.github.io/cdm/classes/ins_DesignInsight/)

An insight within the design domain: a finding, detected asynchronously, about the design under review in a design review. It is always part of that review and can be followed up by tasks.

## In the product

- No public product documentation exists for this concept.

## In the API

- Platform API type: [`DesWorkspaceInsInsight`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspaceInsInsight/) (object)
- Inherited from [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md).

## GRID

None declared (nearest ancestor `ins_Insight`: `grid:workspace:{workspace-id}:insights:insight/{id}`).

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| designReview | [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | 1 | The design review that the insight is part of. | core_partOf |  |
| tasks | [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) | * | Task associated with this insight | core_informs | [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/ins_Insight.md

# Insight (ins_Insight)

- Name: `ins_Insight`
- IRI: `ins:Insight` (https://w3id.org/altium/cdm/insights/Insight)
- Bounded context: [insights](https://altiumdeveloper.github.io/cdm/llms/insights.md)
- Kind: Activity, abstract
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Subclasses: [ins_DesignInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_DesignInsight.md), [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md)
- HTML page: [classes/ins_Insight/](https://altiumdeveloper.github.io/cdm/classes/ins_Insight/)

A finding, detected asynchronously, that gives the user insight within one domain area: the library (part insights) or design (design insights). Insights can be followed up by tasks.

## Comments

- Working definition from the model owner; insights have no public product documentation yet.

## In the API

- Platform API type: [`DesWorkspaceInsInsight`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspaceInsInsight/) (object)

## GRID

`grid:workspace:{workspace-id}:insights:insight/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| tasks | [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) | * | Task associated with this insight | core_informs |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/ins_PartInsight.md

# Part Insight (ins_PartInsight)

- Name: `ins_PartInsight`
- IRI: `ins:PartInsight` (https://w3id.org/altium/cdm/insights/PartInsight)
- Bounded context: [insights](https://altiumdeveloper.github.io/cdm/llms/insights.md)
- Kind: Activity
- Is a: [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md)
- HTML page: [classes/ins_PartInsight/](https://altiumdeveloper.github.io/cdm/classes/ins_PartInsight/)

## In the API

- Platform API type: [`DesWorkspaceInsInsight`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspaceInsInsight/) (object)
- Inherited from [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md).

## GRID

None declared (nearest ancestor `ins_Insight`: `grid:workspace:{workspace-id}:insights:insight/{id}`).

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| part | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | 1 | Part associated with this insight | core_informs |  |
| informedBy | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) or [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | * | Entities associated with this insight | core_informedBy |  |
| occursIn | [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) or [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) or [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Entities associated with this insight | core_occursIn |  |
| tasks | [col_Task](https://altiumdeveloper.github.io/cdm/llms/classes/col_Task.md) | * | Task associated with this insight | core_informs | [ins_Insight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_Insight.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_Component.md

# Component (lib_Component)

- Name: `lib_Component`
- IRI: `lib:Component` (https://w3id.org/altium/cdm/library/Component)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_Component/](https://altiumdeveloper.github.io/cdm/classes/lib_Component/)

Component represents a uniquely identifiable electronic part, defined by both its abstract design intent and its concrete realizations in manufacturing and supply.

## Comments

- Component encapsulates schematic symbols, PCB footprints, simulation models, parameters, and lifecycle states, serving as the single source of truth that links design, procurement, and manufacturing. Its identity persists across revisions, even as attributes such as supplier availability, footprint variants, or parameter values evolve, making it a cornerstone of consistency and traceability across Altium Designer, Altium 365, and the broader ECAD–MCAD co-design workflow.

## In the product

- [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) (primary)
- [Workspace Components](https://www.altium.com/documentation/altium-365/workspace-components)
- [Single Component Editing](https://www.altium.com/documentation/altium-designer/components-libraries/single-component-editing)
- Term: **Workspace component** (exact; altium-designer, altium-365)
- Term: **managed component** (exact; altium-365)
- Term: **library component** (exact; altium-365)

## GRID

`grid:workspace:{workspace-id}:library:component/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| parameters | [lib_ComponentParameter](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentParameter.md) | * | Component parameters |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_ComponentParameter.md

# Component Parameter (lib_ComponentParameter)

- Name: `lib_ComponentParameter`
- IRI: `lib:ComponentParameter` (https://w3id.org/altium/cdm/library/ComponentParameter)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/lib_ComponentParameter/](https://altiumdeveloper.github.io/cdm/classes/lib_ComponentParameter/)

A named parameter of a Workspace component, holding a value and, optionally, a data type. Parameters can be inherited from a component template or added directly to the component; a template can give them unit-aware (e.g. Farad, Ohm) or dictionary-defined types.

## In the product

- [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates#UACPDT) (primary)

## In the API

- Platform API type: [`DesComponentParameter`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesComponentParameter/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 |  |  |  |
| value | string | 0..1 |  |  |  |
| type | string | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) | parameters | * |  |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | parameters | * |  |

---

# File: llms/classes/lib_ComponentRevision.md

# Component Revision (lib_ComponentRevision)

- Name: `lib_ComponentRevision`
- IRI: `lib:ComponentRevision` (https://w3id.org/altium/cdm/library/ComponentRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_ComponentRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_ComponentRevision/)

Revision of a Component.

## In the product

- [Building & Maintaining Your Components and Libraries](https://www.altium.com/documentation/altium-designer/components-libraries#WSL) (primary)
- [Single Component Editing](https://www.altium.com/documentation/altium-designer/components-libraries/single-component-editing)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## In the API

- Platform API type: [`DesComponent`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesComponent/) (object)

## GRID

`grid:workspace:{workspace-id}:library:component-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| consistsOfParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Artifact | core_hasPart |  |
| parameters | [lib_ComponentParameter](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentParameter.md) | * | Component parameters |  |  |
| partChoiceList | [lib_PartChoiceList](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoiceList.md) | 1 | List of part choices |  |  |
| template | [lib_ComponentTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md) | 0..1 |  | core_derivedFrom |  |
| symbols | [lib_SymbolRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md) | * |  | core_hasPart |  |
| footprints | [lib_FootprintRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md) | * |  | core_hasPart |  |
| usedByProjectVariant | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | * | There is a relation per each project/variant where this Component Revision is used. | core_inputOf |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | usesComponents | * | core_hasInput |
| [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | consistsOfComponents | * | core_hasPart |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | occursIn | * | core_occursIn |
| [lib_Component](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Component.md) | revisions | * | core_revisions |
| [lib_ManagedSheetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) | consistsOfComponents | * | core_hasPart |
| [lib_ReuseBlockRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) | consistsOfComponents | * | core_hasPart |
| [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) | component | 0..1 |  |
| [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | consistsOfComponents | * | core_hasPart |
| [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) | usesComponents | * | core_hasInput |

---

# File: llms/classes/lib_ComponentTemplate.md

# Component Template (lib_ComponentTemplate)

- Name: `lib_ComponentTemplate`
- IRI: `lib:ComponentTemplate` (https://w3id.org/altium/cdm/library/ComponentTemplate)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_ComponentTemplate/](https://altiumdeveloper.github.io/cdm/classes/lib_ComponentTemplate/)

Component Template defines a reusable blueprint for creating and managing electronic components with consistent parameters, metadata, and lifecycle policies.

## Comments

- Component Template establishes the structural and semantic boundaries for Components of a given class (e.g., resistors, ICs, connectors), ensuring uniformity in attributes such as electrical ratings, supplier links, simulation models, or documentation references. Its identity is independent of any individual Component but directly governs how Components are instantiated and validated, making it a key mechanism for enforcing standards, reducing errors, and enabling scalable library management across teams and projects.

## In the product

- [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates) (primary)

## In the API

- Platform API type: [`DesComponentTemplate`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesComponentTemplate/) (object)

## GRID

`grid:workspace:{workspace-id}:library:component-template/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_ComponentTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplateRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_ComponentTemplateRevision.md

# Component Template Revision (lib_ComponentTemplateRevision)

- Name: `lib_ComponentTemplateRevision`
- IRI: `lib:ComponentTemplateRevision` (https://w3id.org/altium/cdm/library/ComponentTemplateRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_ComponentTemplateRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_ComponentTemplateRevision/)

A revision of a Component Template: the template definition, stored as a *.CMPT document, saved into the Workspace at one point in time. A component revision can be linked to a specific template revision, from which it takes its predefined parameters, models and settings.

## In the product

- [Component Templates](https://www.altium.com/documentation/altium-designer/components-libraries/workspace-component-templates) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## In the API

- Platform API type: [`DesComponentTemplateRevision`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesComponentTemplateRevision/) (object)

## GRID

`grid:workspace:{workspace-id}:library:component-template-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | template | 0..1 | core_derivedFrom |
| [lib_ComponentTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentTemplate.md) | revisions | * | core_revisions |

---

# File: llms/classes/lib_Datasheet.md

# Datasheet (lib_Datasheet)

- Name: `lib_Datasheet`
- IRI: `lib:Datasheet` (https://w3id.org/altium/cdm/library/Datasheet)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_Datasheet/](https://altiumdeveloper.github.io/cdm/classes/lib_Datasheet/)

Datasheet represents a technical document associated with a Component or Part, providing authoritative specifications, electrical characteristics, and manufacturer information.

## Comments

- Each Datasheet has its own identity and version reference, ensuring consistent access to verified technical details.
- It supports informed design decisions, validation, and compliance by linking engineering data with official manufacturer documentation across Components and managed libraries within Altium 365.

## In the product

- [Adding Datasheets to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-datasheets-component) (primary)

## In the API

- Platform API type: [`DesDatasheet`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesDatasheet/) (object)

## GRID

`grid:workspace:{workspace-id}:library:datasheet/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_Footprint.md

# Footprint (lib_Footprint)

- Name: `lib_Footprint`
- IRI: `lib:Footprint` (https://w3id.org/altium/cdm/library/Footprint)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_Footprint/](https://altiumdeveloper.github.io/cdm/classes/lib_Footprint/)

Footprint represents the physical layout definition of a Component on a PCB, specifying pad geometry, land patterns, and mechanical clearances required for assembly and manufacturing.

## Comments

- Each Footprint has its own identity and lifecycle, and is associated with one or more Components.
- It binds the abstract logical design to its physical implementation, ensuring accurate placement, routing, and compatibility with fabrication and MCAD workflows within Altium Designer and Altium 365.

## In the product

- [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) (primary)
- Term: **Workspace Footprint** (exact; altium-designer)
- Term: **PCB footprint** (related; altium-designer)

## GRID

`grid:workspace:{workspace-id}:library:footprint/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_FootprintRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_FootprintRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_FootprintRevision.md

# Footprint Revision (lib_FootprintRevision)

- Name: `lib_FootprintRevision`
- IRI: `lib:FootprintRevision` (https://w3id.org/altium/cdm/library/FootprintRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_FootprintRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_FootprintRevision/)

A revision of a Footprint: the PCB footprint as saved into the Workspace at one point in time, with its own lifecycle state. Editing a Workspace Footprint saves it into the next revision; components that still link to an earlier revision become out of date until they are updated.

## In the product

- [Creating a PCB Footprint](https://www.altium.com/documentation/altium-designer/components-libraries/creating-pcb-footprint) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## In the API

- Platform API type: [`DesFootprint`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesFootprint/) (object)

## GRID

`grid:workspace:{workspace-id}:library:footprint-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | footprints | * | core_hasPart |
| [lib_Footprint](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Footprint.md) | revisions | * | core_revisions |

---

# File: llms/classes/lib_ManagedSheet.md

# Managed Sheet (lib_ManagedSheet)

- Name: `lib_ManagedSheet`
- IRI: `lib:ManagedSheet` (https://w3id.org/altium/cdm/library/ManagedSheet)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_ManagedSheet/](https://altiumdeveloper.github.io/cdm/classes/lib_ManagedSheet/)

A schematic sheet, with its components and wiring, stored in a Workspace so that it can be reused in other designs. A managed sheet may itself contain further managed sheets beneath it in a hierarchy, and the Workspace lets you trace which components it contains and which designs use it.

## Comments

- TBD

## In the product

- [Working with Managed Schematic Sheets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/workspace-managed-schematic-sheets#just_what_is_a_managed_schematic_sheet) (primary)
- Term: **managed schematic sheet** (exact; altium-designer)

## GRID

`grid:workspace:{workspace-id}:library:managed-sheet/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_ManagedSheetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheetRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_ManagedSheetRevision.md

# Managed Sheet Revision (lib_ManagedSheetRevision)

- Name: `lib_ManagedSheetRevision`
- IRI: `lib:ManagedSheetRevision` (https://w3id.org/altium/cdm/library/ManagedSheetRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_ManagedSheetRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_ManagedSheetRevision/)

A revision of a Managed Sheet: the schematic sheet as saved into the Workspace at one point in time. A design uses a specific revision, so when the sheet is revised, existing designs can be updated to the new revision or kept on the previous one.

## In the product

- [Working with Managed Schematic Sheets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/workspace-managed-schematic-sheets#just_what_is_a_managed_schematic_sheet) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## GRID

`grid:workspace:{workspace-id}:library:managed-sheet-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| consistsOfComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Artifact | core_hasPart |  |
| template | [con_SchematicTemplateRevision](https://altiumdeveloper.github.io/cdm/llms/classes/con_SchematicTemplateRevision.md) | 0..1 |  | core_derivedFrom |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ManagedSheet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ManagedSheet.md) | revisions | * | core_revisions |

---

# File: llms/classes/lib_Part.md

# Part (lib_Part)

- Name: `lib_Part`
- IRI: `lib:Part` (https://w3id.org/altium/cdm/library/Part)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_Part/](https://altiumdeveloper.github.io/cdm/classes/lib_Part/)

A manufacturer part, identified by manufacturer and part number, as held in the Workspace's Part Catalog together with the supplier parts through which it is sold. Workspace components reference manufacturer parts through their Part Choices.

## In the product

- [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component#the_part_catalog) (primary)
- [Part Source Configuration](https://www.altium.com/documentation/altium-365/part-source-configuration)
- Term: **Manufacturer Part** (exact; altium-designer, altium-365)

## In the API

- Platform API type: [`DesPart`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesPart/) (object)

## GRID

`grid:workspace:{workspace-id}:library:part/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | usesParts | * | core_hasInput |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | part | 1 | core_informs |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | consistsOfParts | * | core_hasPart |
| [lib_PartChoice](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoice.md) | part | 1 |  |
| [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) | part | 0..1 |  |
| [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | consistsOfParts | * | core_hasPart |
| [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) | usesParts | * | core_hasInput |

---

# File: llms/classes/lib_PartChoice.md

# Part Choice (lib_PartChoice)

- Name: `lib_PartChoice`
- IRI: `lib:PartChoice` (https://w3id.org/altium/cdm/library/PartChoice)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/lib_PartChoice/](https://altiumdeveloper.github.io/cdm/classes/lib_PartChoice/)

One entry in a component's Part Choice list: a manufacturer part, rather than a specific supplier, that may be used to implement the component, bringing with it the offers of the suppliers that sell it. Entries are ranked automatically by availability, price and lifecycle, and users can override the order with their own rank; the top preferred entry is used as the component's part choice in a BOM.

## In the product

- [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component#anatomy_of_a_part_choice) (primary)
- [Workspace Components](https://www.altium.com/documentation/altium-365/workspace-components#view_edit_part_choices)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| rank | integer | 1 | Rank of the part choice in the list |  |  |
| part | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | 1 | The part associated with this choice |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_PartChoiceList](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoiceList.md) | partChoices | * |  |

---

# File: llms/classes/lib_PartChoiceList.md

# Part Choice List (lib_PartChoiceList)

- Name: `lib_PartChoiceList`
- IRI: `lib:PartChoiceList` (https://w3id.org/altium/cdm/library/PartChoiceList)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/lib_PartChoiceList/](https://altiumdeveloper.github.io/cdm/classes/lib_PartChoiceList/)

The list of Part Choices for a component: the manufacturer parts that may be used to implement it on the assembled board. In the product the list is associated with the component and seen by all of its revisions; when part choice revision control is enabled, changing the list saves a new component revision.

## In the product

- [Adding Supply Chain Information to a Component](https://www.altium.com/documentation/altium-designer/components-libraries/adding-supply-chain-information-component#part_choices) (primary)
- [Workspace Components](https://www.altium.com/documentation/altium-365/workspace-components#view_edit_part_choices)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| partChoices | [lib_PartChoice](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PartChoice.md) | * | List of part choices |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | partChoiceList | 1 |  |

---

# File: llms/classes/lib_PartRequest.md

# Part Request (lib_PartRequest)

- Name: `lib_PartRequest`
- IRI: `lib:PartRequest` (https://w3id.org/altium/cdm/library/PartRequest)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/lib_PartRequest/](https://altiumdeveloper.github.io/cdm/classes/lib_PartRequest/)

Part Request represents a formal demand from a designer to introduce a new Component or Part into the managed library, typically triggered when an item is not yet available in the workspace.

## Comments

- Part Request has its own identity and lifecycle, capturing intent, justification, and required attributes, and serving as the entry point for librarian or librarian-like roles to validate, enrich, and release the requested item. It connects design needs with library governance, ensuring that sourcing, compliance, and lifecycle rules are applied consistently before the Part becomes available for use in projects.

## In the product

- [Part Requests](https://www.altium.com/documentation/altium-365/workflow-part-requests) (primary)
- [Process-based Part Requests](https://www.altium.com/documentation/altium-designer/interactive-process-workflows/part-requests)

## GRID

`grid:workspace:{workspace-id}:library:part-request/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_PcbSnippet.md

# PCB Snippet (lib_PcbSnippet)

- Name: `lib_PcbSnippet`
- IRI: `lib:PcbSnippet` (https://w3id.org/altium/cdm/library/PcbSnippet)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_PcbSnippet/](https://altiumdeveloper.github.io/cdm/classes/lib_PcbSnippet/)

A selection of circuitry from a PCB design, including its components and routing, saved so that it can be placed in other PCB documents. A snippet saved to a Workspace is revised like other Workspace items; snippets can also be kept in local folders.

## In the product

- [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) (primary)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_PcbSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippetRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_PcbSnippetRevision.md

# PCB Snippet Revision (lib_PcbSnippetRevision)

- Name: `lib_PcbSnippetRevision`
- IRI: `lib:PcbSnippetRevision` (https://w3id.org/altium/cdm/library/PcbSnippetRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_PcbSnippetRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_PcbSnippetRevision/)

A revision of a PCB snippet as saved into the Workspace at one point in time. Editing a Workspace snippet saves it into the next revision.

## In the product

- [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_PcbSnippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippet.md) | revisions | * | core_revisions |
| [lib_ReuseBlockRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) | pcbSnippet | 0..1 | core_hasPart |

---

# File: llms/classes/lib_ReuseBlock.md

# Reuse Block (lib_ReuseBlock)

- Name: `lib_ReuseBlock`
- IRI: `lib:ReuseBlock` (https://w3id.org/altium/cdm/library/ReuseBlock)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_ReuseBlock/](https://altiumdeveloper.github.io/cdm/classes/lib_ReuseBlock/)

A reusable section of a design stored in a Workspace, typically combining schematic circuitry with its PCB representation; a block can also be schematic-only or PCB-only. Placing a reuse block on a schematic sheet brings its PCB content into the board design when changes are transferred through an ECO.

## Comments

- TBD

## In the product

- [Working with Reuse Blocks](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/reuse-blocks) (primary)

## In the API

- Platform API type: [`DesReuseBlock`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesReuseBlock/) (object)

## GRID

`grid:workspace:{workspace-id}:library:reuse-block/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_ReuseBlockRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_ReuseBlockRevision.md

# Reuse Block Revision (lib_ReuseBlockRevision)

- Name: `lib_ReuseBlockRevision`
- IRI: `lib:ReuseBlockRevision` (https://w3id.org/altium/cdm/library/ReuseBlockRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_ReuseBlockRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_ReuseBlockRevision/)

A revision of a Reuse Block: its schematic and/or PCB content as saved into the Workspace at one point in time, with its own lifecycle state. Editing a reuse block saves it into the next revision.

## In the product

- [Working with Reuse Blocks](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/reuse-blocks) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## In the API

- Platform API type: [`DesReuseBlockRevision`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesReuseBlockRevision/) (object)

## GRID

`grid:workspace:{workspace-id}:library:reuse-block-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| consistsOfComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Artifact | core_hasPart |  |
| schSnippet | [lib_SchSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippetRevision.md) | 0..1 |  | core_hasPart |  |
| pcbSnippet | [lib_PcbSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_PcbSnippetRevision.md) | 0..1 |  | core_hasPart |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ReuseBlock](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlock.md) | revisions | * | core_revisions |

---

# File: llms/classes/lib_SchSnippet.md

# SCH Snippet (lib_SchSnippet)

- Name: `lib_SchSnippet`
- IRI: `lib:SchSnippet` (https://w3id.org/altium/cdm/library/SchSnippet)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_SchSnippet/](https://altiumdeveloper.github.io/cdm/classes/lib_SchSnippet/)

A selection of circuitry from a single schematic sheet, including its components, saved so that it can be placed in other designs. A snippet saved to a Workspace is revised like other Workspace items; snippets can also be kept in local folders.

## In the product

- [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) (primary)
- Term: **schematic snippet** (exact; altium-designer)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_SchSnippetRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippetRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_SchSnippetRevision.md

# SCH Snippet Revision (lib_SchSnippetRevision)

- Name: `lib_SchSnippetRevision`
- IRI: `lib:SchSnippetRevision` (https://w3id.org/altium/cdm/library/SchSnippetRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_SchSnippetRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_SchSnippetRevision/)

A revision of a schematic snippet as saved into the Workspace at one point in time. Editing a Workspace snippet saves it into the next revision.

## In the product

- [Working with Snippets](https://www.altium.com/documentation/altium-designer/schematic/design-reuse/snippets) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ReuseBlockRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ReuseBlockRevision.md) | schSnippet | 0..1 | core_hasPart |
| [lib_SchSnippet](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SchSnippet.md) | revisions | * | core_revisions |

---

# File: llms/classes/lib_Symbol.md

# Symbol (lib_Symbol)

- Name: `lib_Symbol`
- IRI: `lib:Symbol` (https://w3id.org/altium/cdm/library/Symbol)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/lib_Symbol/](https://altiumdeveloper.github.io/cdm/classes/lib_Symbol/)

Symbol represents the logical schematic view of a Component, defining its electrical interface, pins, and attributes used to express circuit intent in design schematics.

## Comments

- Each Symbol has its own identity and structure, and may be reused across multiple Components or designs.
- It provides the abstract representation of a Component within the schematic domain, ensuring clarity, consistency, and accurate electrical connectivity throughout the design process.

## In the product

- [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) (primary)
- Term: **Workspace Symbol** (exact; altium-designer)
- Term: **schematic symbol** (related; altium-designer)

## GRID

`grid:workspace:{workspace-id}:library:symbol/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [lib_SymbolRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_SymbolRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/lib_SymbolRevision.md

# Symbol Revision (lib_SymbolRevision)

- Name: `lib_SymbolRevision`
- IRI: `lib:SymbolRevision` (https://w3id.org/altium/cdm/library/SymbolRevision)
- Bounded context: [library](https://altiumdeveloper.github.io/cdm/llms/library.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/lib_SymbolRevision/](https://altiumdeveloper.github.io/cdm/classes/lib_SymbolRevision/)

A revision of a Symbol: the schematic symbol as saved into the Workspace at one point in time, with its own lifecycle state. Editing a Workspace Symbol saves it into the next revision; components that still link to an earlier revision become out of date until they are updated.

## In the product

- [Creating a Schematic Symbol](https://www.altium.com/documentation/altium-designer/components-libraries/creating-schematic-symbol) (primary)
- [Working with Items](https://www.altium.com/documentation/altium-designer/connected-workspace/items)

## In the API

- Platform API type: [`DesSymbol`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesSymbol/) (object)

## GRID

`grid:workspace:{workspace-id}:library:symbol-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | symbols | * | core_hasPart |
| [lib_Symbol](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Symbol.md) | revisions | * | core_revisions |

---

# File: llms/classes/ota_Deployment.md

# Deployment (ota_Deployment)

- Name: `ota_Deployment`
- IRI: `ota:Deployment` (https://w3id.org/altium/cdm/ota/Deployment)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/ota_Deployment/](https://altiumdeveloper.github.io/cdm/classes/ota_Deployment/)

Deployment represents the request for an OTA update that assigns packages to the ECUs of its target, either a single device or all devices of a single fleet. It records what was requested, not how it was carried out: the outcome on each targeted device is a separate Deployment Result, which refers to the deployment. Provider-specific scheduling and cancellation restrictions are defined by the corresponding API profile.

## GRID

`grid:workspace:{workspace-id}:ota:deployment/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| targetDevice | [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | 0..1 | The single device targeted by the deployment. | core_occursIn |  |
| targetFleet | [ota_Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md) | 0..1 | The fleet targeted by the deployment; all devices of the fleet are addressed. | core_occursIn |  |
| createdAt | datetime | 0..1 | The date and time the deployment was requested, in UTC, when reported by the provider. |  |  |
| scheduledFor | datetime | 0..1 | The date and time the deployment is scheduled to start, in UTC. |  |  |
| assignments | [ota_DeploymentAssignment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentAssignment.md) | 1..* | The packages assigned per hardware identifier, at least one. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_DeploymentResult](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) | deployment | 1 | core_outputOf |

---

# File: llms/classes/ota_DeploymentAssignment.md

# Deployment Assignment (ota_DeploymentAssignment)

- Name: `ota_DeploymentAssignment`
- IRI: `ota:DeploymentAssignment` (https://w3id.org/altium/cdm/ota/DeploymentAssignment)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/ota_DeploymentAssignment/](https://altiumdeveloper.github.io/cdm/classes/ota_DeploymentAssignment/)

Deployment Assignment assigns a package to the ECUs with a given hardware identifier. Deployment requests may name packages only; the provider then resolves the hardware identifier from the package and the target device's ECUs.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| hardwareId | string | 0..1 | The hardware identifier of the target ECUs. |  |  |
| package | [ota_Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) | 1 | The package to install on the target ECUs, referenced by its GRID. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) | assignments | 1..* |  |

---

# File: llms/classes/ota_DeploymentResult.md

# Deployment Result (ota_DeploymentResult)

- Name: `ota_DeploymentResult`
- IRI: `ota:DeploymentResult` (https://w3id.org/altium/cdm/ota/DeploymentResult)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/ota_DeploymentResult/](https://altiumdeveloper.github.io/cdm/classes/ota_DeploymentResult/)

Deployment Result is the outcome of a deployment on one target device, from the time the device is addressed by the deployment, before its update is created. It is kept apart from the deployment, which records the request: the request is fixed when it is created, while the result is updated from the reports of the device as the update progresses. A device deployment has one result; a fleet deployment has one result per device of the fleet.

## GRID

`grid:workspace:{workspace-id}:ota:deployment-result/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| deployment | [ota_Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) | 1 | The deployment whose outcome this result records, referenced by its GRID. | core_outputOf |  |
| device | [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | 1 | The target device the result applies to, referenced by its GRID. |  |  |
| status | [ota_DeploymentStatus](https://altiumdeveloper.github.io/cdm/llms/enums/ota_DeploymentStatus.md) | 0..1 | The status of the deployment on the device. |  |  |
| completedAt | datetime | 0..1 | The date and time the deployment finished on the device, in UTC. |  |  |
| isSuccessful | boolean | 0..1 | Indicates whether the deployment on the device succeeded, once reported. |  |  |
| resultCode | string | 0..1 | The result code reported by the device. |  |  |
| resultDescription | string | 0..1 | The human-readable result reported by the device. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/ota_Device.md

# Device (ota_Device)

- Name: `ota_Device`
- IRI: `ota:Device` (https://w3id.org/altium/cdm/ota/Device)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/ota_Device/](https://altiumdeveloper.github.io/cdm/classes/ota_Device/)

Device represents a physical unit registered for OTA updates. A device consists of one primary ECU and optional secondary ECUs, and may belong to fleets.

## GRID

`grid:workspace:{workspace-id}:ota:device/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| description | string | 0..1 | Free-form notes associated with the device. |  |  |
| deviceId | string | 0..1 | The device-side identifier provided at provisioning. |  |  |
| hardwareId | string | 0..1 | The hardware type of the device as a whole (for example the product or board type), as reported by the provider, when provided. |  |  |
| status | [ota_DeviceStatus](https://altiumdeveloper.github.io/cdm/llms/enums/ota_DeviceStatus.md) | 0..1 | The current status of the device, set by the provider. |  |  |
| lastSeenAt | datetime | 0..1 | The date and time the device last connected, in UTC, set by the provider. |  |  |
| createdAt | datetime | 0..1 | The date and time the device was registered, in UTC, set by the provider. |  |  |
| activatedAt | datetime | 0..1 | The date and time the device first connected, in UTC, set by the provider. |  |  |
| lastUpdatedAt | datetime | 0..1 | The date and time the device was last updated, in UTC, set by the provider. |  |  |
| hibernated | boolean | 0..1 | Indicates whether the device is hibernated and excluded from updates. |  |  |
| packages | [ota_Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) | * | The registered packages installed on the device, when known, referenced by their GRID. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) | targetDevice | 0..1 | core_occursIn |
| [ota_DeploymentResult](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) | device | 1 |  |
| [ota_Fleet](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Fleet.md) | devices | * |  |

---

# File: llms/classes/ota_Fleet.md

# Fleet (ota_Fleet)

- Name: `ota_Fleet`
- IRI: `ota:Fleet` (https://w3id.org/altium/cdm/ota/Fleet)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/ota_Fleet/](https://altiumdeveloper.github.io/cdm/classes/ota_Fleet/)

Fleet represents a named group of devices managed and updated together.

## GRID

`grid:workspace:{workspace-id}:ota:fleet/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | The fleet name. |  |  |
| createdAt | datetime | 0..1 | The date and time the fleet was created, in UTC. |  |  |
| devices | [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | * | The devices that are members of this fleet. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_Deployment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Deployment.md) | targetFleet | 0..1 | core_occursIn |

---

# File: llms/classes/ota_Package.md

# Package (ota_Package)

- Name: `ota_Package`
- IRI: `ota:Package` (https://w3id.org/altium/cdm/ota/Package)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/ota_Package/](https://altiumdeveloper.github.io/cdm/classes/ota_Package/)

Package represents one version of a software package registered for OTA deployment. A package is identified by its name and version; the version list of a package is the set of packages sharing the same name.

## GRID

`grid:workspace:{workspace-id}:ota:package/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | The package name. |  |  |
| description | string | 0..1 | A brief description of the entity. |  |  |
| version | string | 1 | The version identifier assigned to this package. |  |  |
| size | integer | 0..1 | The size of the package binary in bytes. |  |  |
| hashes | [ota_PackageHash](https://altiumdeveloper.github.io/cdm/llms/classes/ota_PackageHash.md) | * | The checksums of the package binary. |  |  |
| hardwareIds | string | * | The hardware identifiers of the ECU types compatible with the package, matched against the hardware identifiers reported by the ECUs of the target devices. |  |  |
| createdAt | datetime | 0..1 | The date and time the package was registered, in UTC. |  |  |
| packageType | string | 0..1 | The package format reported by the provider, for example ostree or binary. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_DeploymentAssignment](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentAssignment.md) | package | 1 |  |
| [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | packages | * |  |

---

# File: llms/classes/ota_PackageHash.md

# Package Hash (ota_PackageHash)

- Name: `ota_PackageHash`
- IRI: `ota:PackageHash` (https://w3id.org/altium/cdm/ota/PackageHash)
- Bounded context: [ota](https://altiumdeveloper.github.io/cdm/llms/ota.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/ota_PackageHash/](https://altiumdeveloper.github.io/cdm/classes/ota_PackageHash/)

Package Hash is a checksum of a package binary, used for Uptane target metadata.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| algorithm | string | 1 | The lowercase hash algorithm identifier, for example sha256 or sha512. |  |  |
| value | string | 1 | The hash value encoded as hexadecimal characters. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_Package](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Package.md) | hashes | * |  |

---

# File: llms/classes/plt_Application.md

# Application (plt_Application)

- Name: `plt_Application`
- IRI: `plt:Application` (https://w3id.org/altium/cdm/platform/Application)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_Application/](https://altiumdeveloper.github.io/cdm/classes/plt_Application/)

## In the API

- Platform API type: [`GloApp`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloApp/) (object)

## GRID

`grid:global::platform:app/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmAuthoringApplication](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmAuthoringApplication.md) | applicationId | 1 |  |

---

# File: llms/classes/plt_EventSubscription.md

# Event Subscription (plt_EventSubscription)

- Name: `plt_EventSubscription`
- IRI: `plt:EventSubscription` (https://w3id.org/altium/cdm/platform/EventSubscription)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_EventSubscription/](https://altiumdeveloper.github.io/cdm/classes/plt_EventSubscription/)

## In the API

- Platform API type: [`GloEvtSubscription`](https://altiumdeveloper.github.io/platform-api-docs/types/interfaces/GloEvtSubscription/) (interface)

## GRID

`grid:global::events:subscription/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_HasLifecycle.md

# Has Lifecycle (plt_HasLifecycle)

- Name: `plt_HasLifecycle`
- IRI: `plt:HasLifecycle` (https://w3id.org/altium/cdm/platform/HasLifecycle)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/plt_HasLifecycle/](https://altiumdeveloper.github.io/cdm/classes/plt_HasLifecycle/)

Mixin that adds a lifecycle state reference to an entity.

## In the product

- [Managing Item Revision Lifecycle](https://www.altium.com/documentation/altium-designer/connected-workspace/items/managing-revision-lifecycle) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  |  |

---

# File: llms/classes/plt_LifecycleDefinition.md

# Lifecycle Definition (plt_LifecycleDefinition)

- Name: `plt_LifecycleDefinition`
- IRI: `plt:LifecycleDefinition` (https://w3id.org/altium/cdm/platform/LifecycleDefinition)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_LifecycleDefinition/](https://altiumdeveloper.github.io/cdm/classes/plt_LifecycleDefinition/)

Defines the set of states that an entity can transition through in its lifecycle. This definition clarifies what stage a revision of an entity has reached in its 'life' and what it can be safely used for. Different entities can have different lifecycle definitions assigned to them.

## In the product

- [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions) (primary)
- [Lifecycle Management](https://www.altium.com/documentation/altium-365/lifecycle-management)

## In the API

- Platform API type: [`DesLifeCycleDefinition`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesLifeCycleDefinition/) (object)

## GRID

`grid:workspace:{workspace-id}:platform:lifecycle-definition/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| stages | [plt_LifecycleStage](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleStage.md) | * |  |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_LifecycleStage.md

# Lifecycle Stage (plt_LifecycleStage)

- Name: `plt_LifecycleStage`
- IRI: `plt:LifecycleStage` (https://w3id.org/altium/cdm/platform/LifecycleStage)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/plt_LifecycleStage/](https://altiumdeveloper.github.io/cdm/classes/plt_LifecycleStage/)

A named stage that groups lifecycle states in a lifecycle definition using the Advanced management style (e.g. Design, Prototype, Production), indicating how far a revision has progressed in its development. Stages can be linked to the levels of the revision naming scheme. Definitions using the Simple style have states and transitions but no stages.

## In the product

- [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions) (primary)
- [Lifecycle Management](https://www.altium.com/documentation/altium-365/lifecycle-management)

## In the API

- Platform API type: [`DesLifeCycleStage`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesLifeCycleStage/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 |  |  |  |
| states | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1..* |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_LifecycleDefinition](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleDefinition.md) | stages | * |  |

---

# File: llms/classes/plt_LifecycleState.md

# Lifecycle State (plt_LifecycleState)

- Name: `plt_LifecycleState`
- IRI: `plt:LifecycleState` (https://w3id.org/altium/cdm/platform/LifecycleState)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/plt_LifecycleState/](https://altiumdeveloper.github.io/cdm/classes/plt_LifecycleState/)

A named point in an Item Revision's lifecycle (e.g. Planned, New From Design, In Production, Obsolete) that shows its status from a business perspective. Each state's properties include whether revisions in that state are shown in the Explorer panel and whether they may be used in designs; a revision moves to another state only through a transition defined in its lifecycle definition.

## In the product

- [Defining Lifecycle Definitions for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-lifecycle-definitions#options_and_controls_of_the_state_properties_dialog) (primary)
- [Managing Item Revision Lifecycle](https://www.altium.com/documentation/altium-designer/connected-workspace/items/managing-revision-lifecycle)
- [Lifecycle Management](https://www.altium.com/documentation/altium-365/lifecycle-management)

## In the API

- Platform API type: [`DesLifeCycleState`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesLifeCycleState/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) | lifecycleState | 1 |  |
| [plt_LifecycleStage](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleStage.md) | states | 1..* |  |

---

# File: llms/classes/plt_NamingScheme.md

# Revision Naming Scheme (plt_NamingScheme)

- Name: `plt_NamingScheme`
- IRI: `plt:NamingScheme` (https://w3id.org/altium/cdm/platform/NamingScheme)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_NamingScheme/](https://altiumdeveloper.github.io/cdm/classes/plt_NamingScheme/)

Defines the format of Revision IDs for the Items that use it: one to three levels (e.g. Model, Prototype and Revision), each with its own format, separator and minimum width. The scheme is chosen per Item when the Item is created and cannot be changed after its first release. It is distinct from the Item Naming Scheme, which determines the Item ID rather than the revision's ID.

## In the product

- [Defining Revision Naming Schemes for a Workspace](https://www.altium.com/documentation/altium-designer/connected-workspace/defining-naming-schemes) (primary)

## In the API

- Platform API type: [`DesRevisionNamingScheme`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesRevisionNamingScheme/) (object)

## GRID

`grid:workspace:{workspace-id}:platform:revision-naming-scheme/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_Organization.md

# Organization (plt_Organization)

- Name: `plt_Organization`
- IRI: `plt:Organization` (https://w3id.org/altium/cdm/platform/Organization)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_Organization/](https://altiumdeveloper.github.io/cdm/classes/plt_Organization/)

An Altium customer organization, represented by its Company Account. The Company Account brings together the organization's users and groups of users, its purchased licenses and the Altium 365 Workspaces created for it, along with a company profile (e.g. name, logo and website). Administrators manage it through the Company Dashboard.

## In the product

- [Company Dashboard](https://www.altium.com/documentation/altium-dashboard) (primary)
- [Configuring Your Company Profile](https://www.altium.com/documentation/altium-dashboard/profile)
- Term: **Company Account** (exact; altium-dashboard)

## In the API

- Platform API type: [`GloOrganization`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloOrganization/) (object)

## GRID

`grid:global::platform:organization/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_Solution.md

# Solution (plt_Solution)

- Name: `plt_Solution`
- IRI: `plt:Solution` (https://w3id.org/altium/cdm/platform/Solution)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/plt_Solution/](https://altiumdeveloper.github.io/cdm/classes/plt_Solution/)

A Renesas 365 solution: the main, top-level object of a Renesas 365 Workspace, which brings together the system design (an ESD document), PCB projects and software projects of one system. System designs and software projects both push their changes to the solution's System Data Model (SDM) and pull from it; Altium Designer can open a solution's PCB projects and pull SDM changes into them.

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365) (primary)
- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions)
- Term: **Renesas 365 solution** (exact; altium-365, altium-designer)

## In the API

- Platform API type: [`SolSolution`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SolSolution/) (object)

## GRID

`grid:workspace:{workspace-id}:platform:solution/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [plt_SolutionRelease](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionRelease.md) | * | The release artifacts produced by this activity. | core_releases |  |
| solutionItems | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) | * |  | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) | partOfSolution | * | core_partOf |

---

# File: llms/classes/plt_SolutionItem.md

# Solution Item (plt_SolutionItem)

- Name: `plt_SolutionItem`
- IRI: `plt:SolutionItem` (https://w3id.org/altium/cdm/platform/SolutionItem)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/plt_SolutionItem/](https://altiumdeveloper.github.io/cdm/classes/plt_SolutionItem/)

Mixin that marks an entity as an item belonging to a platform Solution.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | solutionItems | * | core_hasPart |

---

# File: llms/classes/plt_SolutionRelease.md

# Solution Release (plt_SolutionRelease)

- Name: `plt_SolutionRelease`
- IRI: `plt:SolutionRelease` (https://w3id.org/altium/cdm/platform/SolutionRelease)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_SolutionRelease/](https://altiumdeveloper.github.io/cdm/classes/plt_SolutionRelease/)

Release of the Solution. This is a formal immutable artifact, representing a specific state of the Solution at the time of release.

## In the product

- No public product documentation exists for this concept.

## GRID

`grid:workspace:{workspace-id}:platform:solution-release/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | releases | * | core_releases |

---

# File: llms/classes/plt_User.md

# User (plt_User)

- Name: `plt_User`
- IRI: `plt:User` (https://w3id.org/altium/cdm/platform/User)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_User/](https://altiumdeveloper.github.io/cdm/classes/plt_User/)

A person identified by a global Altium Account, the identity used for signing in to Altium services. A user can be registered in an organization's Company Account, either added by an administrator or admitted through an approved join request, and can then be given access to licenses through the Company Account's user groups. Access to a Workspace is granted separately, by making the user a member of that Workspace.

## In the product

- [Managing Users](https://www.altium.com/documentation/altium-dashboard/managing-users) (primary)
- Term: **Altium Account** (related; altium-dashboard, altium-365)

## In the API

- Platform API type: [`GloUser`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloUser/) (object)

## GRID

`grid:global::platform:user/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_UserGroup.md

# User Group (plt_UserGroup)

- Name: `plt_UserGroup`
- IRI: `plt:UserGroup` (https://w3id.org/altium/cdm/platform/UserGroup)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_UserGroup/](https://altiumdeveloper.github.io/cdm/classes/plt_UserGroup/)

A named group of users within an organization's Company Account, managed in the Company Dashboard. Licenses can be allocated to a group so that its members can use them, and the Group Administrators system group gives its members Dashboard administration rights. A user can belong to any number of groups, groups can be provisioned from an identity provider via SCIM, and they are distinct from the groups defined inside a Workspace.

## In the product

- [Managing Groups](https://www.altium.com/documentation/altium-dashboard/managing-groups) (primary)

## In the API

- Platform API type: [`GloUserGroup`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/GloUserGroup/) (object)

## GRID

`grid:global::platform:group/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_Workspace.md

# Workspace (plt_Workspace)

- Name: `plt_Workspace`
- IRI: `plt:Workspace` (https://w3id.org/altium/cdm/platform/Workspace)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_Workspace/](https://altiumdeveloper.github.io/cdm/classes/plt_Workspace/)

The top-level entity that plays a role of a closed environment for other entities (members, projects, components, etc.).

## Comments

- A Workspace belongs to exactly one realm (e.g. a commercial region such as Europe or US West, GovCloud, or a Single-Tenant Environment), and all of its data is stored and processed in that realm. This is a major data governance function of the workspaces.
- Typically an organization has a single workspace but large entirprises may have multiple.

## In the product

- [Altium 365 Workspace](https://www.altium.com/documentation/altium-365/workspace) (primary)
- [Activation & Management](https://www.altium.com/documentation/altium-365/workspace-activation-management)
- [Realms](https://www.altium.com/documentation/altium-developer-center/altium-365/key-concepts/realms)
- Term: **Altium 365 Workspace** (exact; altium-365)

## In the API

- Platform API type: [`DesWorkspace`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspace/) (object)

## GRID

`grid:global::platform:workspace/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| environmentConfigurations | [con_EnvironmentConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/con_EnvironmentConfiguration.md) | * |  | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_WorkspaceGroup.md

# Workspace Group (plt_WorkspaceGroup)

- Name: `plt_WorkspaceGroup`
- IRI: `plt:WorkspaceGroup` (https://w3id.org/altium/cdm/platform/WorkspaceGroup)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_WorkspaceGroup/](https://altiumdeveloper.github.io/cdm/classes/plt_WorkspaceGroup/)

Workspace Group represents a logical collection of users within a workspace, used to manage access control, permissions, and collaboration roles across projects and data assets.

## Comments

- Each Workspace Group has its own identity and membership, defining collective rights and responsibilities for its members.
- It simplifies administration and governance by enabling consistent permission management and role-based access across Altium 365 projects, libraries, and shared resources.

## In the product

- [Managing Workspace Membership](https://www.altium.com/documentation/altium-365/managing-workspace-membership#admin_groups) (primary)

## In the API

- Platform API type: [`DesWorkspaceGroup`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspaceGroup/) (object)

## GRID

`grid:workspace:{workspace-id}:team:group/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/plt_WorkspaceUser.md

# Workspace User (plt_WorkspaceUser)

- Name: `plt_WorkspaceUser`
- IRI: `plt:WorkspaceUser` (https://w3id.org/altium/cdm/platform/WorkspaceUser)
- Bounded context: [platform](https://altiumdeveloper.github.io/cdm/llms/platform.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/plt_WorkspaceUser/](https://altiumdeveloper.github.io/cdm/classes/plt_WorkspaceUser/)

A person's membership in a particular Workspace, connecting their Altium Account to that Workspace and to the Workspace groups they are assigned to. Members can come from the organization that owns the Workspace or from other organizations, and inviting an outside user does not add them to the owning organization. People who only have a project shared with them (External Share guests) are not members.

## In the product

- [Managing Workspace Membership](https://www.altium.com/documentation/altium-365/managing-workspace-membership#workspace_members) (primary)
- [Inviting other Users to Your Workspace](https://www.altium.com/documentation/altium-365/inviting-users)
- Term: **Workspace member** (exact; altium-365)

## In the API

- Platform API type: [`DesWorkspaceUser`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/DesWorkspaceUser/) (object)

## GRID

`grid:workspace:{workspace-id}:team:user/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | initiator | 1 |  |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | reviewers | * |  |
| [system_SdmSystemModelVersionMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md) | createdBy | 1 |  |

---

# File: llms/classes/pro_Bom.md

# BOM (pro_Bom)

- Name: `pro_Bom`
- IRI: `pro:Bom` (https://w3id.org/altium/cdm/procurement/Bom)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/pro_Bom/](https://altiumdeveloper.github.io/cdm/classes/pro_Bom/)

Bill of Materials

## In the product

- [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  |  |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  |  |

---

# File: llms/classes/pro_BomIssue.md

# BOM Issue (pro_BomIssue)

- Name: `pro_BomIssue`
- IRI: `pro:BomIssue` (https://w3id.org/altium/cdm/procurement/BomIssue)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/pro_BomIssue/](https://altiumdeveloper.github.io/cdm/classes/pro_BomIssue/)

A problem found when a BOM is analysed, usually against a particular BOM line: for example an unknown part number, a duplicated designator, or a part that is deprecated, low in stock or not compliant with a standard such as REACH. The level at which each kind of check reports (Fatal Error, Error or Warning, or No Report to ignore it) is configurable, and an individual issue can be waived.

## In the product

- [BOM Error Detection and Correction](https://www.altium.com/documentation/altium-365/bom-portal/error-detection-correction) (primary)

## In the API

- Platform API type: [`BomIssue`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomIssue/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| description | string | 0..1 |  |  |  |
| howToFix | string | 0..1 |  |  |  |
| severity | string | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) | issues | * |  |
| [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | issues | * |  |
| [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) | issues | * |  |

---

# File: llms/classes/pro_BomItem.md

# BOM Item (pro_BomItem)

- Name: `pro_BomItem`
- IRI: `pro:BomItem` (https://w3id.org/altium/cdm/procurement/BomItem)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/pro_BomItem/](https://altiumdeveloper.github.io/cdm/classes/pro_BomItem/)

One line of a BOM: its designators and quantity, the primary manufacturer part used for it (identified by manufacturer and manufacturer part number), and any alternate parts recorded for that line. A line can be linked to a Workspace component that lists its part among its Part Choices, and BOM checks report issues against individual lines.

## In the product

- [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#bom-structure-features) (primary)
- Term: **BOM line** (exact; altium-365)

## In the API

- Platform API type: [`BomItem`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomItem/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * | Issues associated with this BOM item. |  |  |
| designators | string | * | A list of designators that specify the placements of the item within the schematic. |  |  |
| quantity | integer | 1 | The quantity of the item required to produce one unit. |  |  |
| primaryElement | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) | 0..1 | The primary element chosen for this item. |  |  |
| alternates | [pro_BomItemAlternate](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemAlternate.md) | * | Alternate elements that could be used for this item. |  |  |
| substitutes | [pro_BomItemSubstitute](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemSubstitute.md) | * | Substitute elements that could be used for this item. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) | items | * |  |

---

# File: llms/classes/pro_BomItemAlternate.md

# BOM Item Alternate (pro_BomItemAlternate)

- Name: `pro_BomItemAlternate`
- IRI: `pro:BomItemAlternate` (https://w3id.org/altium/cdm/procurement/BomItemAlternate)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Resource
- Is a: [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md)
- HTML page: [classes/pro_BomItemAlternate/](https://altiumdeveloper.github.io/cdm/classes/pro_BomItemAlternate/)

An alternate part recorded for one BOM line: another manufacturer part that could be used instead of the line's primary part. Alternates belong to the individual BOM line rather than applying across BOMs. They can come from an uploaded BOM file, be added by hand, or be filled in automatically from the linked component's Part Choices and from suggested alternates, and an alternate can be promoted to become the line's primary part.

## In the product

- [Configuration and Options](https://www.altium.com/documentation/altium-365/bom-portal/configuration-options#add_alternate) (primary)
- Term: **Alternate** (exact; altium-365)

## In the API

- Platform API type: [`BomItemAlternate`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomItemAlternate/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| mpn | string | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| manufacturer | string | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| part | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) or [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | 0..1 | The Part this element resolves to - a workspace library Part for workspace BOMs, or a supply Part for BOMs that live outside a workspace (e.g. Global BOM). |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| component | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | alternates | * |  |

---

# File: llms/classes/pro_BomItemElement.md

# BOM Item Element (pro_BomItemElement)

- Name: `pro_BomItemElement`
- IRI: `pro:BomItemElement` (https://w3id.org/altium/cdm/procurement/BomItemElement)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Resource, abstract
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Subclasses: [pro_BomItemAlternate](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemAlternate.md), [pro_BomItemSubstitute](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemSubstitute.md)
- HTML page: [classes/pro_BomItemElement/](https://altiumdeveloper.github.io/cdm/classes/pro_BomItemElement/)

An element (part) that might be used for a particular BOM item.

## In the product

- [Workspace Components Integration](https://www.altium.com/documentation/altium-365/bom-portal/workspace-components-integration) (primary)

## In the API

- Platform API type: [`BomItemElement`](https://altiumdeveloper.github.io/platform-api-docs/types/interfaces/BomItemElement/) (interface)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  |  |
| mpn | string | 0..1 |  |  |  |
| manufacturer | string | 0..1 |  |  |  |
| part | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) or [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | 0..1 | The Part this element resolves to - a workspace library Part for workspace BOMs, or a supply Part for BOMs that live outside a workspace (e.g. Global BOM). |  |  |
| component | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | primaryElement | 0..1 |  |

---

# File: llms/classes/pro_BomItemSubstitute.md

# BOM Item Substitute (pro_BomItemSubstitute)

- Name: `pro_BomItemSubstitute`
- IRI: `pro:BomItemSubstitute` (https://w3id.org/altium/cdm/procurement/BomItemSubstitute)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Resource
- Is a: [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md)
- HTML page: [classes/pro_BomItemSubstitute/](https://altiumdeveloper.github.io/cdm/classes/pro_BomItemSubstitute/)

Substitute is a replacement of a part by another within an individual BOM.

## In the API

- Platform API type: [`BomItemSubstitute`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomItemSubstitute/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| mpn | string | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| manufacturer | string | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| part | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) or [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | 0..1 | The Part this element resolves to - a workspace library Part for workspace BOMs, or a supply Part for BOMs that live outside a workspace (e.g. Global BOM). |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |
| component | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | 0..1 |  |  | [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | substitutes | * |  |

---

# File: llms/classes/pro_BomRelease.md

# BOM Release (pro_BomRelease)

- Name: `pro_BomRelease`
- IRI: `pro:BomRelease` (https://w3id.org/altium/cdm/procurement/BomRelease)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md), [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- HTML page: [classes/pro_BomRelease/](https://altiumdeveloper.github.io/cdm/classes/pro_BomRelease/)

A static snapshot of a Managed BOM's data, saved under a release name with an incremented revision number and optional notes. The BOM Portal makes a release automatically when a Managed BOM is first created and again once its data has been mapped, and further releases can be made whenever needed. Each release moves through its own lifecycle states (by default Draft, Approved and Obsolete), and a Workspace can be configured to block releasing while the BOM has Error or Fatal Error issues.

## In the product

- [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal#release_naming) (primary)

## In the API

- Platform API type: [`BomRelease`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomRelease/) (object)

## GRID

`grid:workspace:{workspace-id}:procurement:bom-release/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| consistsOfParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Artifact | core_hasPart |  |
| consistsOfComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Artifact | core_hasPart |  |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | occursIn | * | core_occursIn |
| [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) | releases | * | core_releases |

---

# File: llms/classes/pro_BomWIP.md

# BOM WIP (pro_BomWIP)

- Name: `pro_BomWIP`
- IRI: `pro:BomWIP` (https://w3id.org/altium/cdm/procurement/BomWIP)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Activity, abstract
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Subclasses: [pro_ConsolidatedBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ConsolidatedBOM.md), [pro_ManagedBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_ManagedBOM.md)
- Mixins: [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md)
- HTML page: [classes/pro_BomWIP/](https://altiumdeveloper.github.io/cdm/classes/pro_BomWIP/)

The current, editable working state of a Workspace BOM, as opposed to a BOM release, which is a static snapshot of its data. It is the common base of Managed BOM and Consolidated BOM; in the BOM Portal, BOM releases are made from a Managed BOM's working state.

## In the product

- Term: **WIP BOM** (related; altium-365)

## In the API

- Platform API type: [`BomWip`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomWip/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | * | The release artifacts produced by this activity. | core_releases |  |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput |  |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput |  |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ins_PartInsight](https://altiumdeveloper.github.io/cdm/llms/classes/ins_PartInsight.md) | informedBy | * | core_informedBy |

---

# File: llms/classes/pro_ConsolidatedBOM.md

# Consolidated BOM (pro_ConsolidatedBOM)

- Name: `pro_ConsolidatedBOM`
- IRI: `pro:ConsolidatedBOM` (https://w3id.org/altium/cdm/procurement/ConsolidatedBOM)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Activity
- Is a: [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md)
- HTML page: [classes/pro_ConsolidatedBOM/](https://altiumdeveloper.github.io/cdm/classes/pro_ConsolidatedBOM/)

Consolidated BOM represents the aggregated bill of materials across one or more Projects or variants, combining all required Parts into a single, unified view for procurement and manufacturing.

## Comments

- Consolidated BOM provides a supply-chain–ready artifact with its own identity and lifecycle, ensuring traceability back to the originating designs while normalizing duplicates, alternates, and quantity rollups. It acts as the bridge between engineering output and enterprise procurement systems, enabling efficient sourcing, cost analysis, and lifecycle validation across multiple boards or product configurations within the Altium 365 ecosystem.

## In the product

- [Consolidated BOM](https://www.altium.com/documentation/altium-365/bom-portal/consolidated-bom) (primary)

## In the API

- Platform API type: [`BomWip`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomWip/) (object)
- Inherited from [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md).

## GRID

`grid:workspace:{workspace-id}:procurement:consolidated-bom/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | * | The release artifacts produced by this activity. | core_releases | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/pro_GlobalBOM.md

# Global BOM (pro_GlobalBOM)

- Name: `pro_GlobalBOM`
- IRI: `pro:GlobalBOM` (https://w3id.org/altium/cdm/procurement/GlobalBOM)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Mixins: [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md)
- HTML page: [classes/pro_GlobalBOM/](https://altiumdeveloper.github.io/cdm/classes/pro_GlobalBOM/)

Global BOM represents a bill of materials that resides outside of any workspace, on Octopart, where users can create, edit, collaborate on and share it with others.

## Comments

- Global BOM follows the same conceptual BOM model as workspace-scoped BOMs (items, alternates, substitutes and issues), but its identity and access are not bound to a workspace. This mirrors other entities that can exist both workspace-scoped and globally (e.g. workspace Hardware Projects vs. personal, shareable projects).
- Global BOM does not produce releases yet, hence it does not specialise BOM WIP and has no releases relation.
- Global BOM has no access to workspace libraries, so it references supply Parts only. Its item elements resolve to supply Parts; the workspace component reference is not used.

## In the product

- No public product documentation exists for this concept.

## GRID

`grid:global::procurement:bom/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| usesParts | [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | * | Supply Parts used in this Global BOM. | core_hasInput |  |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/pro_ManagedBOM.md

# Managed BOM (pro_ManagedBOM)

- Name: `pro_ManagedBOM`
- IRI: `pro:ManagedBOM` (https://w3id.org/altium/cdm/procurement/ManagedBOM)
- Bounded context: [procurement](https://altiumdeveloper.github.io/cdm/llms/procurement.md)
- Kind: Activity
- Is a: [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md)
- HTML page: [classes/pro_ManagedBOM/](https://altiumdeveloper.github.io/cdm/classes/pro_ManagedBOM/)

A bill of materials kept in a Workspace and worked on in the BOM Portal, where its lines are enriched with manufacturer and supplier data for review and procurement. It can be created from a design project (one of its variants or releases) or uploaded as a CSV/XLS file from any source. A Managed BOM made from a project keeps a link to that project, so it can be updated when the project changes, either in place or as a new revision; snapshots of its data at a point in time are kept as BOM releases.

## Comments

- Managed BOM has its own identity and lifecycle, separate from any design project it is created from (though linked to it), and serves as the authoritative reference for procurement, manufacturing, and compliance processes. It supports traceability, repeatability, and governance by recording sourcing decisions and alternates and capturing them in BOM releases, while enabling collaboration between engineering, supply chain, and manufacturing teams within the Altium 365 environment.

## In the product

- [BOM Portal](https://www.altium.com/documentation/altium-365/bom-portal) (primary)
- [Workspace Projects](https://www.altium.com/documentation/altium-365/workspace-projects#uploading_or_creating_a_managed_bom)

## In the API

- Platform API type: [`BomWip`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/BomWip/) (object)
- Inherited from [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md).

## GRID

`grid:workspace:{workspace-id}:procurement:bom/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [pro_BomRelease](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomRelease.md) | * | The release artifacts produced by this activity. | core_releases | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| usesParts | [lib_Part](https://altiumdeveloper.github.io/cdm/llms/classes/lib_Part.md) | * | Parts used in this Activity | core_hasInput | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| usesComponents | [lib_ComponentRevision](https://altiumdeveloper.github.io/cdm/llms/classes/lib_ComponentRevision.md) | * | Components used in this Activity | core_hasInput | [pro_BomWIP](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomWIP.md) |
| issues | [pro_BomIssue](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomIssue.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| items | [pro_BomItem](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItem.md) | * |  |  | [pro_Bom](https://altiumdeveloper.github.io/cdm/llms/classes/pro_Bom.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/req_Artifact.md

# Requirement Artifact (req_Artifact)

- Name: `req_Artifact`
- IRI: `req:Artifact` (https://w3id.org/altium/cdm/requirement/Artifact)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/req_Artifact/](https://altiumdeveloper.github.io/cdm/classes/req_Artifact/)

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | artifacts | * |  |
| [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | satisfiedByArtifacts | * |  |
| [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | tracedFromSources | * |  |
| [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | inputs | * |  |
| [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | generatesEvidence | * |  |
| [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | usesArtifacts | * |  |

---

# File: llms/classes/req_Project.md

# Requirements Project (req_Project)

- Name: `req_Project`
- IRI: `req:Project` (https://w3id.org/altium/cdm/requirement/Project)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_Project/](https://altiumdeveloper.github.io/cdm/classes/req_Project/)

The orchestration space for capturing, evolving, and validating requirements scoped to a product, program increment, or regulatory engagement.

## Comments

- Provides planning scaffolding comparable to Hardware Projects, enabling traceable alignment between requirement deliverables and downstream design artifacts.
- The product already links requirements projects to design projects, through blocks of the Electronics type that are linked to PCB projects (e.g. choosing PCB projects when creating a requirements project creates a linked block and a specification for each); cross-domain slots for this link are not modelled yet. Future idea: synchronize milestone states via baselines vs. releases.

## In the product

- [Project Module](https://www.altium.com/documentation/altium-365/requirements-portal/project-module#creating_a_new_requirements_project) (primary)
- [Working with Requirements](https://www.altium.com/documentation/altium-365/requirements-integration#basic_requirements_portal_setup)
- [Working with Requirements](https://www.altium.com/documentation/altium-365/requirements-integration#linking_requirements_to_a_design_project)

## GRID

`grid:workspace:{workspace-id}:requirements:project/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 1 | Compact display name for the requirement effort. |  |  |
| description | string | 0..1 | Longer narrative describing objectives, scope, and constraints. |  |  |
| owner | string | 0..1 | Responsible program, platform team, or external stakeholder. |  |  |
| specifications | [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | 1..* | Specifications authored or curated within this requirements project. | core_hasPart |  |
| baselines | [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | * | Baselines approved under this project to govern execution. | core_hasPart |  |
| changeRequests | [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | * | Change requests logged against this requirements project. |  |  |
| verificationCases | [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | * | Verification cases scoped to this project for coverage planning. |  |  |
| artifacts | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Supporting artifacts (models, audits, customer inputs) managed by the project. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | targetsProjects | * |  |

---

# File: llms/classes/req_Requirement.md

# Requirement (req_Requirement)

- Name: `req_Requirement`
- IRI: `req:Requirement` (https://w3id.org/altium/cdm/requirement/Requirement)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_Requirement/](https://altiumdeveloper.github.io/cdm/classes/req_Requirement/)

A single, testable statement of intent or constraint that governs a solution or process outcome.

## Comments

- Requirements aggregate rationales, acceptance criteria, and trace links needed to drive downstream design and verification.

## In the product

- [Requirement Fields](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/requirement-fields) (primary)
- [Creating Requirements](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/creating-requirements)
- [Requirements Breakdown Process](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/requirements-breakdown-process)

## GRID

`grid:workspace:{workspace-id}:requirements:requirement/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [req_RequirementRevision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| identifier | string | 1 | Human-friendly identifier that is unique within a specification context (e.g. SYS-001). |  |  |
| title | string | 1 | Concise human-readable title of the requirement. |  |  |
| text | string | 1 | Canonical textual form of the requirement. |  |  |
| rationale | string | 0..1 | Justification or reasoning that motivates the requirement intent. |  |  |
| category | string | 0..1 | Classification such as functional, safety, regulatory, or usability. |  |  |
| priority | string | 0..1 | Relative importance or sequencing hint for planning. |  |  |
| acceptanceCriteria | string | * | Objective criteria or measurements that prove the requirement is met. |  |  |
| owner | string | 0..1 | Responsible role or team accountable for the requirement. |  |  |
| sourceReference | uriorcurie | * | Link or citation to originating contract, regulation, or customer input. |  |  |
| children | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | * | Requirements that refine or decompose this requirement. | core_hasPart |  |
| parent | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 0..1 | Higher-level requirement that allocates scope to this requirement. | core_partOf |  |
| satisfiedByArtifacts | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Artifacts, designs, or solutions that implement this requirement. |  |  |
| verifiedByActivities | [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md) | * | Verification activities that produce evidence for this requirement. |  |  |
| tracedFromSources | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Upstream sources such as contracts, standards, or customer requests. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | includesRequirements | 1..* | core_hasPart |
| [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | impactsRequirements | 1..* |  |
| [req_RequirementRevision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) | revisionOf | 1 | core_revisionOf |
| [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | includesRequirements | 1..* | core_hasPart |
| [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | validatesRequirements | 1..* |  |

---

# File: llms/classes/req_RequirementBaseline.md

# Requirement Baseline (req_RequirementBaseline)

- Name: `req_RequirementBaseline`
- IRI: `req:RequirementBaseline` (https://w3id.org/altium/cdm/requirement/RequirementBaseline)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_RequirementBaseline/](https://altiumdeveloper.github.io/cdm/classes/req_RequirementBaseline/)

A version-managed release of a specification or subset of requirements approved for execution. In the product this corresponds to a released specification (Release Specification). It is not what the product calls a baseline: in the Requirements & Systems Portal (Legacy), a baseline is a named bookmark for a point in time (e.g. a design review) that is used to compare how requirements and values have changed.

## In the product

- [Requirement Versioning and Releasing](https://www.altium.com/documentation/altium-365/requirements-systems-portal/requirements-module/requirement-versioning-and-releasing) (primary)
- Term: **Release Specification** (related; altium-365)

## GRID

`grid:workspace:{workspace-id}:requirements:baseline/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| identifier | string | 1 | Distinguishing label for the approved baseline (e.g. BL-2025.1). |  |  |
| notes | string | 0..1 | Additional context for the approval, deviations, or applicability limits. |  |  |
| ofSpecification | [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | 1 | Specification for which this baseline is approved. |  |  |
| includesRequirements | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 1..* | Specific requirements frozen into this baseline. | core_hasPart |  |
| targetsProjectReleases | [des_ProjectRelease](https://altiumdeveloper.github.io/cdm/llms/classes/des_ProjectRelease.md) | * | Project releases that must comply with this baseline. |  |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | baselines | * | core_hasPart |
| [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | revisions | * | core_revisions |

---

# File: llms/classes/req_RequirementChangeRequest.md

# Requirement Change Request (req_RequirementChangeRequest)

- Name: `req_RequirementChangeRequest`
- IRI: `req:RequirementChangeRequest` (https://w3id.org/altium/cdm/requirement/RequirementChangeRequest)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_RequirementChangeRequest/](https://altiumdeveloper.github.io/cdm/classes/req_RequirementChangeRequest/)

Structured workflow item proposing additions, updates, or removals of requirements.

## GRID

`grid:workspace:{workspace-id}:requirements:change-request/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| reason | string | 1 | Business, technical, or compliance driver motivating the change. |  |  |
| priority | string | 0..1 | Handling urgency for backlog triage. |  |  |
| decision | string | 0..1 | Outcome such as approved, rejected, or deferred. |  |  |
| impactsRequirements | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 1..* | Requirements directly impacted by the change request. |  |  |
| impactsSpecifications | [req_RequirementSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementSpecification.md) | * | Specifications that must be updated when processing the change. |  |  |
| generatesRevisions | [req_RequirementRevision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) | * | Requirement revisions produced as the outcome of the change request. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | changeRequests | * |  |
| [req_RequirementRevision](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementRevision.md) | derivesFromChange | 0..1 |  |
| [req_VerificationCase](https://altiumdeveloper.github.io/cdm/llms/classes/req_VerificationCase.md) | triggersChanges | * |  |

---

# File: llms/classes/req_RequirementRevision.md

# Requirement Revision (req_RequirementRevision)

- Name: `req_RequirementRevision`
- IRI: `req:RequirementRevision` (https://w3id.org/altium/cdm/requirement/RequirementRevision)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_RequirementRevision/](https://altiumdeveloper.github.io/cdm/classes/req_RequirementRevision/)

An immutable snapshot of a requirement statement at a specific revision.

## In the product

- [Requirement Versioning and Releasing](https://www.altium.com/documentation/altium-365/requirements-systems-portal/requirements-module/requirement-versioning-and-releasing) (primary)

## GRID

`grid:workspace:{workspace-id}:requirements:requirement-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisionOf | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 1 | A versioned snapshot derived from a prior artifact version. | core_revisionOf |  |
| number | string | 1 | Ordinal or semver-like revision number. |  |  |
| changeSummary | string | 0..1 | Concise description of what changed in this revision. |  |  |
| derivesFromChange | [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | 0..1 | Change request that authorized this requirement revision. |  |  |
| lifecycleState | [plt_LifecycleState](https://altiumdeveloper.github.io/cdm/llms/classes/plt_LifecycleState.md) | 1 | The current lifecycle state assigned to this entity. |  | [plt_HasLifecycle](https://altiumdeveloper.github.io/cdm/llms/classes/plt_HasLifecycle.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | revisions | * | core_revisions |
| [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | generatesRevisions | * |  |

---

# File: llms/classes/req_RequirementSpecification.md

# Requirement Specification (req_RequirementSpecification)

- Name: `req_RequirementSpecification`
- IRI: `req:RequirementSpecification` (https://w3id.org/altium/cdm/requirement/RequirementSpecification)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_RequirementSpecification/](https://altiumdeveloper.github.io/cdm/classes/req_RequirementSpecification/)

A curated collection of requirements scoped to a program, domain, or release horizon.

## In the product

- [Create Specifications](https://www.altium.com/documentation/altium-365/requirements-portal/requirements-module/create-specifications) (primary)
- Term: **Specification** (exact; altium-365)

## GRID

`grid:workspace:{workspace-id}:requirements:specification/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| name | string | 1 | Human-readable name for the specification (e.g. "System Requirements"). |  |  |
| description | string | 0..1 | Narrative describing the boundaries and context of the specification. |  |  |
| owner | string | 0..1 | Role or organization managing this specification. |  |  |
| includesRequirements | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 1..* | Requirements curated under this specification. | core_hasPart |  |
| targetsProjects | [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | * | Requirements projects that receive scope from this specification. |  |  |
| inputs | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Artifacts or agreements that feed this specification. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | specifications | 1..* | core_hasPart |
| [req_RequirementBaseline](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementBaseline.md) | ofSpecification | 1 |  |
| [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | impactsSpecifications | * |  |

---

# File: llms/classes/req_VerificationCase.md

# Verification Case (req_VerificationCase)

- Name: `req_VerificationCase`
- IRI: `req:VerificationCase` (https://w3id.org/altium/cdm/requirement/VerificationCase)
- Bounded context: [requirements](https://altiumdeveloper.github.io/cdm/llms/requirements.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/req_VerificationCase/](https://altiumdeveloper.github.io/cdm/classes/req_VerificationCase/)

A planned verification procedure or test that produces objective evidence against requirements.

## In the product

- [Verification & Validation Module](https://www.altium.com/documentation/altium-365/requirements-portal/verification-validation-module) (primary)
- [Flow 1: Plan Verification Activities](https://www.altium.com/documentation/altium-365/requirements-portal/verification-validation-module/flow-1-plan-verification-activities)
- Term: **V&V Activity** (related; altium-365)

## GRID

`grid:workspace:{workspace-id}:requirements:verification-case/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| identifier | string | 1 | External-facing identifier or document number for the verification case. |  |  |
| method | string | 1 | Verification technique such as analysis, inspection, demonstration, or test. |  |  |
| environment | string | 0..1 | Description of lab, simulation, or operational context for execution. |  |  |
| result | string | 0..1 | Pass/fail or summary of latest execution outcome. |  |  |
| validatesRequirements | [req_Requirement](https://altiumdeveloper.github.io/cdm/llms/classes/req_Requirement.md) | 1..* | Requirements validated by executing this verification case. |  |  |
| usesArtifacts | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Test articles, prototypes, or simulations consumed during verification. |  |  |
| generatesEvidence | [req_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/req_Artifact.md) | * | Reports, datasets, or other artifacts captured as verification evidence. |  |  |
| triggersChanges | [req_RequirementChangeRequest](https://altiumdeveloper.github.io/cdm/llms/classes/req_RequirementChangeRequest.md) | * | Change requests created due to verification findings. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [req_Project](https://altiumdeveloper.github.io/cdm/llms/classes/req_Project.md) | verificationCases | * |  |

---

# File: llms/classes/sft_AIModel.md

# AI Model (sft_AIModel)

- Name: `sft_AIModel`
- IRI: `sft:AIModel` (https://w3id.org/altium/cdm/software/AIModel)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- Mixins: [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md)
- Maturity: EXPERIMENTAL
- HTML page: [classes/sft_AIModel/](https://altiumdeveloper.github.io/cdm/classes/sft_AIModel/)

AI model artifact in context of a workspace

## Comments

- We start with a simple Artifact-like entity without explicit revisions support. The assumption is that if we need revisions going forward, we'll add explicit revision entity, define GRID for it, relations, etc.

## GRID

`grid:workspace:{workspace-id}:software:ai-model/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | aiModels | 0..1 | core_hasInput |
| [sft_SoftwareRelease](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) | aiModels | 0..1 | core_hasPart |

---

# File: llms/classes/sft_BuildArtifact.md

# Build Artifact (sft_BuildArtifact)

- Name: `sft_BuildArtifact`
- IRI: `sft:BuildArtifact` (https://w3id.org/altium/cdm/software/BuildArtifact)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sft_BuildArtifact/](https://altiumdeveloper.github.io/cdm/classes/sft_BuildArtifact/)

## In the product

- No public product documentation exists for this concept.

## GRID

None declared.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | latestBuildArtifacts | * | core_hasOutput |
| [sft_SoftwareRelease](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) | buildArtifacts | * | core_hasPart |

---

# File: llms/classes/sft_DeviceConfiguration.md

# Device Configuration (sft_DeviceConfiguration)

- Name: `sft_DeviceConfiguration`
- IRI: `sft:DeviceConfiguration` (https://w3id.org/altium/cdm/software/DeviceConfiguration)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sft_DeviceConfiguration/](https://altiumdeveloper.github.io/cdm/classes/sft_DeviceConfiguration/)

The configuration of a device (e.g. an MCU placed as a hardware component in an ESD document), covering its ports, package information, peripherals and pin assignments. It is viewed and edited on the hardware component in the ESD document, and the pin functions it defines can be pulled from the solution's SDM onto the pins of the associated component in a hardware project in Altium Designer.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) (primary)
- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project)

## In the API

- Platform API type: [`SftDevCfgDeviceConfiguration`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SftDevCfgDeviceConfiguration/) (object)

## GRID

`grid:workspace:{workspace-id}:software:device-configuration/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| revisions | [sft_DeviceConfigurationRevision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md) | * | The set of versioned snapshots derived from this artifact. | core_revisions |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | deviceConfiguration | 0..1 | core_hasOutput |

---

# File: llms/classes/sft_DeviceConfigurationRevision.md

# Device Configuration Revision (sft_DeviceConfigurationRevision)

- Name: `sft_DeviceConfigurationRevision`
- IRI: `sft:DeviceConfigurationRevision` (https://w3id.org/altium/cdm/software/DeviceConfigurationRevision)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sft_DeviceConfigurationRevision/](https://altiumdeveloper.github.io/cdm/classes/sft_DeviceConfigurationRevision/)

## In the API

- Platform API type: [`SftDevCfgDeviceConfigurationRevision`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SftDevCfgDeviceConfigurationRevision/) (object)

## GRID

`grid:workspace:{workspace-id}:software:device-configuration-revision/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| pinModel | [sft_PinAssignmentModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignmentModel.md) | 1 |  |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_DeviceConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md) | revisions | * | core_revisions |

---

# File: llms/classes/sft_PinAssignment.md

# Pin Assignment (sft_PinAssignment)

- Name: `sft_PinAssignment`
- IRI: `sft:PinAssignment` (https://w3id.org/altium/cdm/software/PinAssignment)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/sft_PinAssignment/](https://altiumdeveloper.github.io/cdm/classes/sft_PinAssignment/)

The assignment of a function to one pin of a device, identified by pin number and name. When a hardware project pulls changes from the solution's SDM, pin functions from the device configuration are added to or removed from the pins of the associated component.

## In the product

- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| pinNumber | integer | 1 |  |  |  |
| pinName | string | 1 |  |  |  |
| pinFunction | string | 1 |  |  |  |
| symbolicName | string | 1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_PinAssignmentModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignmentModel.md) | pins | 1..* |  |

---

# File: llms/classes/sft_PinAssignmentModel.md

# Pin Assignment Model (sft_PinAssignmentModel)

- Name: `sft_PinAssignmentModel`
- IRI: `sft:PinAssignmentModel` (https://w3id.org/altium/cdm/software/PinAssignmentModel)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/sft_PinAssignmentModel/](https://altiumdeveloper.github.io/cdm/classes/sft_PinAssignmentModel/)

The set of pin assignments of a device, one part of its device configuration alongside ports, package information and peripherals.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| pins | [sft_PinAssignment](https://altiumdeveloper.github.io/cdm/llms/classes/sft_PinAssignment.md) | 1..* |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_DeviceConfigurationRevision](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfigurationRevision.md) | pinModel | 1 |  |

---

# File: llms/classes/sft_SoftwareProject.md

# Software Project (sft_SoftwareProject)

- Name: `sft_SoftwareProject`
- IRI: `sft:SoftwareProject` (https://w3id.org/altium/cdm/software/SoftwareProject)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Mixins: [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md)
- HTML page: [classes/sft_SoftwareProject/](https://altiumdeveloper.github.io/cdm/classes/sft_SoftwareProject/)

The software part of a Renesas 365 solution, developed in the built-in Web IDE (based on the Theia framework) or in e² studio; it can also be created with an external repository type. In the solution's ESD document it can be linked to a software blanket, and generating a board support package (BSP) from that blanket pushes the SDM and applies the changes to the linked project, creating the project first if none exists yet.

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#exploring_a_solution) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#generating_a_board_support_package)

## In the API

- Platform API type: [`SftSoftwareProject`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SftSoftwareProject/) (object)

## GRID

`grid:workspace:{workspace-id}:software:software-project/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| releases | [sft_SoftwareRelease](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareRelease.md) | * | The release artifacts produced by this activity. | core_releases |  |
| aiModels | [sft_AIModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md) | 0..1 |  | core_hasInput |  |
| deviceConfiguration | [sft_DeviceConfiguration](https://altiumdeveloper.github.io/cdm/llms/classes/sft_DeviceConfiguration.md) | 0..1 | Device Configuration derived from the project | core_hasOutput |  |
| latestBuildArtifacts | [sft_BuildArtifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md) | * | Latest build artifacts produced from the project | core_hasOutput |  |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | implementedBy | 0..1 | core_implementedBy |
| [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) | implementedBy | 0..1 | core_implementedBy |
| [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) | implementedBy | 0..1 | core_implementedBy |

---

# File: llms/classes/sft_SoftwareRelease.md

# Software Release (sft_SoftwareRelease)

- Name: `sft_SoftwareRelease`
- IRI: `sft:SoftwareRelease` (https://w3id.org/altium/cdm/software/SoftwareRelease)
- Bounded context: [software](https://altiumdeveloper.github.io/cdm/llms/software.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sft_SoftwareRelease/](https://altiumdeveloper.github.io/cdm/classes/sft_SoftwareRelease/)

## In the product

- No public product documentation exists for this concept.

## GRID

`grid:workspace:{workspace-id}:software:software-release/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| title | string | 0..1 | Title of the release |  |  |
| description | string | 0..1 | Free form text with additional details about the release. |  |  |
| attachments | BLOB | 0..1 | Additional files associated with the release (reports, documents, etc.) |  |  |
| aiModels | [sft_AIModel](https://altiumdeveloper.github.io/cdm/llms/classes/sft_AIModel.md) | 0..1 | AI model artifacts included into the release. | core_hasPart |  |
| buildArtifacts | [sft_BuildArtifact](https://altiumdeveloper.github.io/cdm/llms/classes/sft_BuildArtifact.md) | * | Firmware build artifacts, deployable to the device. | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | releases | * | core_releases |

---

# File: llms/classes/sup_Company.md

# Company (sup_Company)

- Name: `sup_Company`
- IRI: `sup:Company` (https://w3id.org/altium/cdm/supply/Company)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_Company/](https://altiumdeveloper.github.io/cdm/classes/sup_Company/)

Supply Company represents an organization in the electronics supply chain. Depending on context it is the manufacturer of a Part or a distributor (or broker) that sells it.

## Comments

- Each Supply Company has its own identity and metadata, including contact, regional, and certification details.
- It serves as the authoritative entity behind Supply Offers, enabling traceability, supplier qualification, and integration of trusted sourcing data across Octopart and Altium 365 workflows.

## In the API

- Nexar type: `SupCompany` ([Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api))

## GRID

`grid:supply::platform:company/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | manufacturer | 1 |  |

---

# File: llms/classes/sup_EvalKit.md

# Evaluation Kit (sup_EvalKit)

- Name: `sup_EvalKit`
- IRI: `sup:EvalKit` (https://w3id.org/altium/cdm/supply/EvalKit)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_EvalKit/](https://altiumdeveloper.github.io/cdm/classes/sup_EvalKit/)

A vendor evaluation kit in the supply catalog, described by its associated devices, its reference designs (including a main one) and the software projects compatible with it. In Renesas 365 an eval kit can be linked to a solution, and the browser can connect to the kit over J-Link.

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#linking_an_evaluation_kit) (primary)
- Term: **Eval Kit** (exact; altium-365)

## In the API

- Platform API type: [`SupEvalKit`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupEvalKit/) (object)

## GRID

`grid:supply::platform:eval-kit/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sup_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md) | evalKits | * | core_hasPart |
| [sup_SolutionTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md) | evalKits | * | core_hasPart |

---

# File: llms/classes/sup_Offer.md

# Offer (sup_Offer)

- Name: `sup_Offer`
- IRI: `sup:Offer` (https://w3id.org/altium/cdm/supply/Offer)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_Offer/](https://altiumdeveloper.github.io/cdm/classes/sup_Offer/)

Supply Offer represents a specific commercial listing of a Part from a supplier, detailing price breaks, stock availability, lead times, and ordering conditions at a given point in time.

## Comments

- Each Supply Offer has its own identity and is associated with a Supply Part, reflecting one supplier’s current market position.
- It enables designers and procurement teams to evaluate sourcing options dynamically, supporting cost optimization, risk mitigation, and automated supply validation within the Altium 365 and Octopart ecosystems.

## In the product

- [Sourced Manufacturer and Supplier Data](https://www.altium.com/documentation/altium-365/bom-portal/sourced-manufacturer-supplier-data#order_list) (primary)
- [Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api)
- Term: **Supplier Part** (related; altium-designer)

## In the API

- Nexar type: `SupOffer` ([Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api))

## GRID

`grid:supply::platform:part/{id}/offer/{offerID}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/sup_Part.md

# Part (sup_Part)

- Name: `sup_Part`
- IRI: `sup:Part` (https://w3id.org/altium/cdm/supply/Part)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_Part/](https://altiumdeveloper.github.io/cdm/classes/sup_Part/)

Supply Part represents a market-available instance of a manufactured Part, providing aggregated sourcing data such as pricing, stock levels, and supplier offers.

## Comments

- Each Supply Part has its own identity derived from manufacturer and supplier metadata, and may correspond to multiple suppliers’ listings.
- It bridges the design and supply chain domains by enriching managed Parts with real-time market intelligence, enabling informed sourcing, alternates evaluation, and procurement optimization within Altium 365.

## In the product

- [Searching for Manufacturer Parts](https://www.altium.com/documentation/altium-designer/components-libraries/searching-manufacturer-parts#manufacturer_and_supplier_data) (primary)
- [Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api)
- Term: **Manufacturer Part** (related; altium-designer)

## In the API

- Nexar type: `SupPart` ([Octopart API](https://www.altium.com/documentation/altium-developer-center/octopart/api))

## GRID

`grid:supply::platform:part/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| mpn | string | 1 |  |  |  |
| manufacturer | [sup_Company](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Company.md) | 1 | The company that manufactures this part. |  |  |
| referenceDesigns | [sup_ReferenceDesign](https://altiumdeveloper.github.io/cdm/llms/classes/sup_ReferenceDesign.md) | * | Reference designs that use this part. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [pro_BomItemElement](https://altiumdeveloper.github.io/cdm/llms/classes/pro_BomItemElement.md) | part | 0..1 |  |
| [pro_GlobalBOM](https://altiumdeveloper.github.io/cdm/llms/classes/pro_GlobalBOM.md) | usesParts | * | core_hasInput |
| [sup_PartGroup](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) | parts | * |  |

---

# File: llms/classes/sup_PartFamily.md

# Part Family (sup_PartFamily)

- Name: `sup_PartFamily`
- IRI: `sup:PartFamily` (https://w3id.org/altium/cdm/supply/PartFamily)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_PartFamily/](https://altiumdeveloper.github.io/cdm/classes/sup_PartFamily/)

A manufacturer's grouping of parts in the supply data, where the kind of family is vendor-specific (e.g. Series or Family). Part families form a hierarchy: a family has either child families or, at the lowest level, Part Groups. Families sharing the same parent are usually close alternatives to one another.

## In the API

- Platform API type: [`SupPartFamily`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupPartFamily/) (object)

## GRID

`grid:supply::platform:part-family/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| partGroups | [sup_PartGroup](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) | * | Part groups belonging to this part family. |  |  |
| alternatives | [sup_PartFamily](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md) | * | Alternative part families that can substitute this one. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/sup_PartGroup.md

# Part Group (sup_PartGroup)

- Name: `sup_PartGroup`
- IRI: `sup:PartGroup` (https://w3id.org/altium/cdm/supply/PartGroup)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_PartGroup/](https://altiumdeveloper.github.io/cdm/classes/sup_PartGroup/)

A leaf of the part family hierarchy in the supply data, holding the parts that belong to it together with group-level information such as its manufacturer, overview, key features and documents. Groups sharing the same parent family are usually close alternatives to one another.

## In the API

- Platform API type: [`SupPartGroup`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupPartGroup/) (object)

## GRID

`grid:supply::platform:part-group/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| parts | [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | * | Parts belonging to this part group. |  |  |
| alternatives | [sup_PartGroup](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartGroup.md) | * | Alternative part groups that can substitute this one. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sup_PartFamily](https://altiumdeveloper.github.io/cdm/llms/classes/sup_PartFamily.md) | partGroups | * |  |

---

# File: llms/classes/sup_ReferenceDesign.md

# Reference Design (sup_ReferenceDesign)

- Name: `sup_ReferenceDesign`
- IRI: `sup:ReferenceDesign` (https://w3id.org/altium/cdm/supply/ReferenceDesign)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_ReferenceDesign/](https://altiumdeveloper.github.io/cdm/classes/sup_ReferenceDesign/)

An example design published in the supply catalog, bringing together its design files (e.g. schematics and layouts), documentation and the parts it uses. In Renesas 365 a reference design can be imported into a solution, which adds it to the Workspace as a PCB project linked to that solution.

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#import_project) (primary)

## In the API

- Platform API type: [`SupRefDesign`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupRefDesign/) (object)

## GRID

`grid:supply::platform:ref-design/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sup_Part](https://altiumdeveloper.github.io/cdm/llms/classes/sup_Part.md) | referenceDesigns | * |  |

---

# File: llms/classes/sup_SoftwareProject.md

# Software Project (sup_SoftwareProject)

- Name: `sup_SoftwareProject`
- IRI: `sup:SoftwareProject` (https://w3id.org/altium/cdm/supply/SoftwareProject)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_SoftwareProject/](https://altiumdeveloper.github.io/cdm/classes/sup_SoftwareProject/)

A software project published in the supply catalog, together with the evaluation kits it is compatible with. In Renesas 365 it can be imported into a solution with a compatible eval kit; the import places the project in the Workspace and links it to the solution (see sft_SoftwareProject).

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#import_project) (primary)

## In the API

- Platform API type: [`SupSoftwareProject`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupSoftwareProject/) (object)

## GRID

`grid:supply::platform:software-project/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| evalKits | [sup_EvalKit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) | * | Evaluation Kits included in this Artifact | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [sup_SolutionTemplate](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SolutionTemplate.md) | softwareProjects | * | core_hasPart |

---

# File: llms/classes/sup_SolutionTemplate.md

# Solution Template (sup_SolutionTemplate)

- Name: `sup_SolutionTemplate`
- IRI: `sup:SolutionTemplate` (https://w3id.org/altium/cdm/supply/SolutionTemplate)
- Bounded context: [supply](https://altiumdeveloper.github.io/cdm/llms/supply.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/sup_SolutionTemplate/](https://altiumdeveloper.github.io/cdm/classes/sup_SolutionTemplate/)

A publisher's template for a solution, held in the supply catalog. It brings together catalog software projects, evaluation kits and a system design (ESD) source, and users can clone it.

## In the API

- Platform API type: [`SupSolutionTemplate`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SupSolutionTemplate/) (object)

## GRID

`grid:supply::platform:solution-template/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| evalKits | [sup_EvalKit](https://altiumdeveloper.github.io/cdm/llms/classes/sup_EvalKit.md) | * | Evaluation Kits included in this Artifact | core_hasPart |  |
| softwareProjects | [sup_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sup_SoftwareProject.md) | * | Software Projects included in this Artifact | core_hasPart |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/system_Connection.md

# Connection (system_Connection)

- Name: `system_Connection`
- IRI: `sys:Connection` (https://w3id.org/altium/cdm/system/Connection)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_Connection/](https://altiumdeveloper.github.io/cdm/classes/system_Connection/)

A connection line in an ESD document representing an interconnection between functional blocks (e.g. signals passed between the interfaces of two devices), drawn directly between blocks or between their ports. In the editor a line can also start or end on other objects or in free space; this model records each end as a functional block and port (see system_Endpoint).

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#connecting_functional_blocks) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#defining_an_esd_document)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| endpoints | [system_Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md) | 1..* |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) | connections | * |  |

---

# File: llms/classes/system_ESD.md

# ESD (system_ESD)

- Name: `system_ESD`
- IRI: `sys:ESD` (https://w3id.org/altium/cdm/system/ESD)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/system_ESD/](https://altiumdeveloper.github.io/cdm/classes/system_ESD/)

Electronic System Design: a system-level block diagram of functional blocks and the connections between them, together with the hardware and software projects that implement the system.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| functionalBlocks | [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | * | The functional blocks of the system design. |  |  |
| connections | [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) | * | The connections between functional blocks. |  |  |
| hardwareProjects | [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) | * | Hardware projects associated with this system design. |  |  |
| softwareProjects | [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) | * | Software projects associated with this system design. |  |  |

---

# File: llms/classes/system_ESDDocument.md

# ESD Document (system_ESDDocument)

- Name: `system_ESDDocument`
- IRI: `sys:ESDDocument` (https://w3id.org/altium/cdm/system/ESDDocument)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Mixins: [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md), [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md)
- HTML page: [classes/system_ESDDocument/](https://altiumdeveloper.github.io/cdm/classes/system_ESDDocument/)

A system-level block diagram document used in a Renesas 365 solution (listed there as a System Design project) to describe the architecture of the system at a functional level. It holds functional blocks with their hardware components, software components and ports, the connections between blocks, and blankets through which parts of the design can be linked to PCB or software projects. Pushing to and pulling from the solution's System Data Model (SDM) for the system design is done from the ESD document. Blankets are not modelled as a separate entity here (see MF-068).

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd) (primary)
- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#exploring_a_solution)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#pushing_pulling_sdm)
- Term: **System Design** (related; altium-365)

## In the API

- Platform API type: [`SysEsdDocument`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysEsdDocument/) (object)

## GRID

`grid:workspace:{workspace-id}:system-design:esd/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| partOfSolution | [plt_Solution](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Solution.md) | * |  | core_partOf | [plt_SolutionItem](https://altiumdeveloper.github.io/cdm/llms/classes/plt_SolutionItem.md) |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| functionalBlocks | [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | * | The functional blocks of the system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| connections | [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) | * | The connections between functional blocks. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| hardwareProjects | [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) | * | Hardware projects associated with this system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| softwareProjects | [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) | * | Software projects associated with this system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) | implementedBy | 0..1 | core_implementedBy |

---

# File: llms/classes/system_Endpoint.md

# Endpoint (system_Endpoint)

- Name: `system_Endpoint`
- IRI: `sys:Endpoint` (https://w3id.org/altium/cdm/system/Endpoint)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_Endpoint/](https://altiumdeveloper.github.io/cdm/classes/system_Endpoint/)

One end of a connection in an ESD document, identified by the functional block and the port where the connection line starts or ends.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| functionalBlockId | [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | 1 |  |  |  |
| portId | [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) | 1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) | endpoints | 1..* |  |

---

# File: llms/classes/system_FunctionalBlock.md

# Functional Block (system_FunctionalBlock)

- Name: `system_FunctionalBlock`
- IRI: `sys:FunctionalBlock` (https://w3id.org/altium/cdm/system/FunctionalBlock)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_FunctionalBlock/](https://altiumdeveloper.github.io/cdm/classes/system_FunctionalBlock/)

Represents a logical block within an ESD document (e.g., MCU subsystem, LED driver block) that stands for a function, operation or device of the system, including parameters, key components, software components, ports, and associations. In the ESD editor a functional block can also contain other blocks; this nesting is not modelled here.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#defining_an_esd_document) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#placing_and_configuring_functional_blocks)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| implementedBy | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) or [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| ports | [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) | * |  |  |  |
| keyComponents | [system_KeyComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) | * |  |  |  |
| softwareComponents | [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | * |  |  |  |
| portsAssociations | [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | * |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) | functionalBlocks | * |  |
| [system_Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md) | functionalBlockId | 1 |  |
| [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) | functionalBlocks | * |  |

---

# File: llms/classes/system_GlobalESD.md

# Global ESD (system_GlobalESD)

- Name: `system_GlobalESD`
- IRI: `sys:GlobalESD` (https://w3id.org/altium/cdm/system/GlobalESD)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- Mixins: [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md)
- HTML page: [classes/system_GlobalESD/](https://altiumdeveloper.github.io/cdm/classes/system_GlobalESD/)

An Electronic System Design that resides outside of any Workspace. It has the same content as an ESD document but is not part of a solution.

## In the product

- No public product documentation exists for this concept.

## GRID

`grid:global::system-design:esd/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| functionalBlocks | [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | * | The functional blocks of the system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| connections | [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) | * | The connections between functional blocks. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| hardwareProjects | [system_HardwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_HardwareProject.md) | * | Hardware projects associated with this system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| softwareProjects | [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) | * | Software projects associated with this system design. |  | [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/system_HardwareProject.md

# Hardware Project (system_HardwareProject)

- Name: `system_HardwareProject`
- IRI: `sys:HardwareProject` (https://w3id.org/altium/cdm/system/HardwareProject)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_HardwareProject/](https://altiumdeveloper.github.io/cdm/classes/system_HardwareProject/)

An entry of an ESD document for a PCB design project (des_Project) that implements part of the system, listing the functional blocks that project covers. In the ESD editor a PCB project can be linked to a hardware blanket (which can be placed around functional blocks), and each project can be linked to at most one blanket in a document.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| implementedBy | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| functionalBlocks | [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | * | Functional blocks associated with this hardware project. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) | hardwareProjects | * |  |

---

# File: llms/classes/system_HasSdmReferenceDesignator.md

# system_HasSdmReferenceDesignator

- Name: `system_HasSdmReferenceDesignator`
- IRI: `sys:HasSdmReferenceDesignator` (https://w3id.org/altium/cdm/system/HasSdmReferenceDesignator)
- Bounded context: none
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/system_HasSdmReferenceDesignator/](https://altiumdeveloper.github.io/cdm/classes/system_HasSdmReferenceDesignator/)

A mixin for entities within the System Data Model (SDM) that are identifiable by reference designators

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| sdmReferenceDesignator | string | 1 | Reference designator |  |  |

---

# File: llms/classes/system_KeyComponent.md

# Key Component (system_KeyComponent)

- Name: `system_KeyComponent`
- IRI: `sys:KeyComponent` (https://w3id.org/altium/cdm/system/KeyComponent)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_KeyComponent/](https://altiumdeveloper.github.io/cdm/classes/system_KeyComponent/)

A key component of a functional block in an ESD document, shown in the editor as a hardware component (e.g. a Renesas RA MCU chosen with the RA Explorer). Its device configuration (ports, package information, peripherals and pin assignments) can be viewed and edited on the hardware component. Software components of the block reference their parent key component. Its SDM counterpart is system_SdmHardwareComponent.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#hardware_component) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration)
- Term: **Hardware Component** (exact; altium-365)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| childSoftwareComponentsIds | [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | * |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | keyComponents | * |  |
| [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | parentKeyComponentId | 1 |  |

---

# File: llms/classes/system_Parameter.md

# Parameter (system_Parameter)

- Name: `system_Parameter`
- IRI: `sys:Parameter` (https://w3id.org/altium/cdm/system/Parameter)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_Parameter/](https://altiumdeveloper.github.io/cdm/classes/system_Parameter/)

Name–value parameter associated with functional blocks, ports, or other system design resources.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#accessing_object_properties) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| value | string | 1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_Connection](https://altiumdeveloper.github.io/cdm/llms/classes/system_Connection.md) | parameters | * |  |
| [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) | parameters | * |  |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | parameters | * |  |
| [system_KeyComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) | parameters | * |  |
| [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) | parameters | * |  |
| [system_SdmClientMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmClientMetadata.md) | parameters | * |  |
| [system_SdmConnection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md) | parameters | * |  |
| [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | parameters | * |  |
| [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) | parameters | * |  |
| [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | parameters | * |  |
| [system_SdmSoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) | parameters | * |  |
| [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | parameters | * |  |
| [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | parameters | * |  |

---

# File: llms/classes/system_Port.md

# Port (system_Port)

- Name: `system_Port`
- IRI: `sys:Port` (https://w3id.org/altium/cdm/system/Port)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_Port/](https://altiumdeveloper.github.io/cdm/classes/system_Port/)

An interface of a functional block in an ESD document (e.g. the I2C interface of an MPU), placed inside the block's boundaries; connection lines between blocks can start and end at ports. It is a logical interface, distinct from dm_Port, which is a physical port of a device.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#defining_an_esd_document) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#port)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| associationId | [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_Endpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_Endpoint.md) | portId | 1 |  |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | ports | * |  |
| [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | portId | 1 |  |

---

# File: llms/classes/system_PortAssociation.md

# Port Association (system_PortAssociation)

- Name: `system_PortAssociation`
- IRI: `sys:PortAssociation` (https://w3id.org/altium/cdm/system/PortAssociation)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_PortAssociation/](https://altiumdeveloper.github.io/cdm/classes/system_PortAssociation/)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| portId | [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) | 1 |  |  |  |
| softwareComponentId | [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | 1 |  |  |  |
| portLibraryName | [system_PortType](https://altiumdeveloper.github.io/cdm/llms/enums/system_PortType.md) | 1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | portsAssociations | * |  |
| [system_Port](https://altiumdeveloper.github.io/cdm/llms/classes/system_Port.md) | associationId | 0..1 |  |
| [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | portsAssociationsIds | * |  |

---

# File: llms/classes/system_SdmAuthoringApplication.md

# Authoring Application (system_SdmAuthoringApplication)

- Name: `system_SdmAuthoringApplication`
- IRI: `sys:SdmAuthoringApplication` (https://w3id.org/altium/cdm/system/SdmAuthoringApplication)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmAuthoringApplication/](https://altiumdeveloper.github.io/cdm/classes/system_SdmAuthoringApplication/)

Identifies the application used to create a system model version.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| applicationId | [plt_Application](https://altiumdeveloper.github.io/cdm/llms/classes/plt_Application.md) | 1 | The platform application associated with this authoring application. |  |  |
| name | string | 0..1 | The name of the application. |  |  |
| version | string | 0..1 | The version of the application. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersionMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md) | authoringApplication | 1 |  |

---

# File: llms/classes/system_SdmClientMetadata.md

# Domain Metadata (system_SdmClientMetadata)

- Name: `system_SdmClientMetadata`
- IRI: `sys:SdmClientMetadata` (https://w3id.org/altium/cdm/system/SdmClientMetadata)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmClientMetadata/](https://altiumdeveloper.github.io/cdm/classes/system_SdmClientMetadata/)

Captures metadata specific to a particular client (e.g., ESD, AD, E2Studio).

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| clientId | string | 1 | The client identifier (e.g., "ESD", "AD", "E2Studio") this metadata are associated with. |  |  |

---

# File: llms/classes/system_SdmConnection.md

# Connection (system_SdmConnection)

- Name: `system_SdmConnection`
- IRI: `sys:SdmConnection` (https://w3id.org/altium/cdm/system/SdmConnection)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md)
- HTML page: [classes/system_SdmConnection/](https://altiumdeveloper.github.io/cdm/classes/system_SdmConnection/)

Represents a connection between functional blocks.

## In the API

- Platform API type: [`SysSdmConnection`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmConnection/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| endpoints | [system_SdmEndpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md) | * | Endpoints of the connection. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) | connections | * |  |

---

# File: llms/classes/system_SdmDeviceModel.md

# Device Model (system_SdmDeviceModel)

- Name: `system_SdmDeviceModel`
- IRI: `sys:SdmDeviceModel` (https://w3id.org/altium/cdm/system/SdmDeviceModel)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md)
- HTML page: [classes/system_SdmDeviceModel/](https://altiumdeveloper.github.io/cdm/classes/system_SdmDeviceModel/)

Represents a device model within the system design.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#using_the_device_configuration) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#generating_a_board_support_package)

## In the API

- Platform API type: [`SysSdmDeviceModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmDeviceModel/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| boardName | string | 0..1 | Board name for the device |  |  |
| mpn | string | 1 | Manufacturer Part Number (MPN) for the device. |  |  |
| peripherals | [dm_Peripheral](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Peripheral.md) | * | List of all peripherals available on the device. |  |  |
| ports | [dm_Port](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Port.md) | * | List of physical ports on the device. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | deviceModels | * |  |

---

# File: llms/classes/system_SdmEndpoint.md

# Endpoint (system_SdmEndpoint)

- Name: `system_SdmEndpoint`
- IRI: `sys:SdmEndpoint` (https://w3id.org/altium/cdm/system/SdmEndpoint)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmEndpoint/](https://altiumdeveloper.github.io/cdm/classes/system_SdmEndpoint/)

Represents an endpoint of a connection.

## In the API

- Platform API type: [`SysSdmEndpoint`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmEndpoint/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| functionalBlockId | [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | 1 | Functional block associated with this endpoint. |  |  |
| portId | [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | 1 | Port associated with this endpoint. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmConnection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md) | endpoints | * |  |

---

# File: llms/classes/system_SdmFunctionalBlock.md

# Functional Block (system_SdmFunctionalBlock)

- Name: `system_SdmFunctionalBlock`
- IRI: `sys:SdmFunctionalBlock` (https://w3id.org/altium/cdm/system/SdmFunctionalBlock)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmFunctionalBlock/](https://altiumdeveloper.github.io/cdm/classes/system_SdmFunctionalBlock/)

Represents a logical block within a system functional model.

## In the API

- Platform API type: [`SysSdmFunctionalBlock`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmFunctionalBlock/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| hardwareComponentIds | [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) | * | Hardware components associated with this functional block. |  |  |
| ports | [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | * | Ports associated with this functional block. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmEndpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md) | functionalBlockId | 1 |  |
| [system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) | functionalBlocks | * |  |
| [system_SdmHardwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) | functionalBlockIds | * |  |

---

# File: llms/classes/system_SdmFunctionalModel.md

# Functional Model (system_SdmFunctionalModel)

- Name: `system_SdmFunctionalModel`
- IRI: `sys:SdmFunctionalModel` (https://w3id.org/altium/cdm/system/SdmFunctionalModel)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md)
- HTML page: [classes/system_SdmFunctionalModel/](https://altiumdeveloper.github.io/cdm/classes/system_SdmFunctionalModel/)

Captures the functional aspects of the system design, focusing on the behavior and interactions of functional blocks.

## In the API

- Platform API type: [`SysSdmFunctionalModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmFunctionalModel/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| implementedBy | [system_ESDDocument](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESDDocument.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| functionalBlocks | [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | * | Functional blocks that make up this functional model. |  |  |
| connections | [system_SdmConnection](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmConnection.md) | * | Connections between functional blocks in this functional model. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | functionalModel | 0..1 |  |

---

# File: llms/classes/system_SdmHardwareComponent.md

# Hardware Component (system_SdmHardwareComponent)

- Name: `system_SdmHardwareComponent`
- IRI: `sys:SdmHardwareComponent` (https://w3id.org/altium/cdm/system/SdmHardwareComponent)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmHardwareComponent/](https://altiumdeveloper.github.io/cdm/classes/system_SdmHardwareComponent/)

Represents a hardware component / part.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#hardware_component) (primary)
- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project)

## In the API

- Platform API type: [`SysSdmHardwareComponent`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmHardwareComponent/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| deviceModelId | [dm_ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) | 0..1 | A device model associated with this hardware component. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | hardwareComponentIds | * |  |
| [system_SdmHardwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) | hardwareComponents | * |  |
| [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | hardwareComponentId | 0..1 |  |

---

# File: llms/classes/system_SdmHardwareModel.md

# Hardware Model (system_SdmHardwareModel)

- Name: `system_SdmHardwareModel`
- IRI: `sys:SdmHardwareModel` (https://w3id.org/altium/cdm/system/SdmHardwareModel)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmHardwareModel/](https://altiumdeveloper.github.io/cdm/classes/system_SdmHardwareModel/)

Captures the hardware components and their interactions within the system design.

## In the API

- Platform API type: [`SysSdmHardwareModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmHardwareModel/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| implementedBy | [des_Project](https://altiumdeveloper.github.io/cdm/llms/classes/des_Project.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| hardwareComponents | [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) | * | The hardware components that make up this hardware model. |  |  |
| functionalBlockIds | [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | * | A functional blocks associated with this hardware model. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | hardwareModels | * |  |

---

# File: llms/classes/system_SdmMappableEntity.md

# system_SdmMappableEntity

- Name: `system_SdmMappableEntity`
- IRI: `sys:SdmEntity` (https://w3id.org/altium/cdm/system/SdmEntity)
- Bounded context: none
- Kind: abstract, mixin
- Is a: [core_Meta](https://altiumdeveloper.github.io/cdm/llms/classes/core_Meta.md)
- HTML page: [classes/system_SdmMappableEntity/](https://altiumdeveloper.github.io/cdm/classes/system_SdmMappableEntity/)

A mixin for entities within the System Data Model (SDM) that are mappable to domain-specific concepts

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |

---

# File: llms/classes/system_SdmPort.md

# Port (system_SdmPort)

- Name: `system_SdmPort`
- IRI: `sys:SdmPort` (https://w3id.org/altium/cdm/system/SdmPort)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmPort/](https://altiumdeveloper.github.io/cdm/classes/system_SdmPort/)

Represents a port within a system design. It is a logical interface of a functional block, distinct from dm_Port, which is a physical port of a device.

## In the API

- Platform API type: [`SysSdmPort`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmPort/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| portType | [system_PortType](https://altiumdeveloper.github.io/cdm/llms/enums/system_PortType.md) | 0..1 | The type of this port (e.g., UART, GPIO, I2C). |  |  |
| hardwareComponentId | [system_SdmHardwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareComponent.md) | 0..1 | The hardware component associated with this port. |  |  |
| softwareComponentId | [system_SdmSoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) | 0..1 | The software component associated with this port. |  |  |
| peripheralInstanceId | [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | 0..1 | The peripheral instance associated with this port. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmEndpoint](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmEndpoint.md) | portId | 1 |  |
| [system_SdmFunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalBlock.md) | ports | * |  |

---

# File: llms/classes/system_SdmSoftwareComponent.md

# Software Component (system_SdmSoftwareComponent)

- Name: `system_SdmSoftwareComponent`
- IRI: `sys:SdmSoftwareComponent` (https://w3id.org/altium/cdm/system/SdmSoftwareComponent)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmSoftwareComponent/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSoftwareComponent/)

Represents a software component instance and its dependencies.

## In the API

- Platform API type: [`SysSdmSoftwareComponent`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSoftwareComponent/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| implementedBy | [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | * | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| libraryComponentId | string | 0..1 | The id of the library software component |  |  |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | softwareComponentId | 0..1 |  |
| [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) | softwareComponents | * |  |

---

# File: llms/classes/system_SdmSoftwareModel.md

# Software Model (system_SdmSoftwareModel)

- Name: `system_SdmSoftwareModel`
- IRI: `sys:SdmSoftwareModel` (https://w3id.org/altium/cdm/system/SdmSoftwareModel)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- Mixins: [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md), [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md)
- HTML page: [classes/system_SdmSoftwareModel/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSoftwareModel/)

Captures the software components and their interactions within the system design.

## In the API

- Platform API type: [`SysSdmSoftwareModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSoftwareModel/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| implementedBy | [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| softwareComponents | [system_SdmSoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) | * | The software components that make up this software model. |  |  |
| softwareStackInstances | [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | * | The stack instances used by this software model. |  |  |
| deviceModelId | [dm_ConfiguredDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/dm_ConfiguredDeviceModel.md) | 0..1 | A device model associated with this software model. |  |  |
| id | string | 1 | Local unique identifier within a given context. |  | [system_SdmMappableEntity](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmMappableEntity.md) |
| sdmReferenceDesignator | string | 1 | Reference designator |  | [system_HasSdmReferenceDesignator](https://altiumdeveloper.github.io/cdm/llms/classes/system_HasSdmReferenceDesignator.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | softwareModels | * |  |

---

# File: llms/classes/system_SdmSoftwareSpecification.md

# Software Specification (system_SdmSoftwareSpecification)

- Name: `system_SdmSoftwareSpecification`
- IRI: `sys:SdmSoftwareSpecification` (https://w3id.org/altium/cdm/system/SdmSoftwareSpecification)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmSoftwareSpecification/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSoftwareSpecification/)

The "blueprint" for a software component. Captures the identity and classification of the software independently of any specific instance.

## In the API

- Platform API type: [`SysSdmSoftwareSpecification`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSoftwareSpecification/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | The identifier within the ecosystem (e.g., module.driver.uart). |  |  |
| category | [system_SdmSoftwareComponentCategory](https://altiumdeveloper.github.io/cdm/llms/enums/system_SdmSoftwareComponentCategory.md) | 0..1 | The architectural role of this specification (e.g. DRIVER). |  |  |
| ecosystem | string | 0..1 | The platform or framework (e.g., FSP). |  |  |
| vendor | string | 0..1 | The organization providing the software (e.g. Renesas). |  |  |
| version | string | 0..1 |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | specification | 1 |  |

---

# File: llms/classes/system_SdmSoftwareStackInstance.md

# Software Stack Instance (system_SdmSoftwareStackInstance)

- Name: `system_SdmSoftwareStackInstance`
- IRI: `sys:SdmSoftwareStackInstance` (https://w3id.org/altium/cdm/system/SdmSoftwareStackInstance)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmSoftwareStackInstance/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSoftwareStackInstance/)

Represents a software stack instance and its dependencies.

## In the API

- Platform API type: [`SysSdmSoftwareStackInstance`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSoftwareStackInstance/) (object)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| specification | [system_SdmSoftwareSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareSpecification.md) | 1 | The specification of this software stack instance. |  |  |
| dependencyIds | [system_SdmSoftwareStackInstance](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareStackInstance.md) | 1..* | The software stacks that this instance depends on. |  |  |
| peripheralInstanceId | [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | 0..1 | The peripheral associated with this software stack. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareComponent.md) | implementedBy | * | core_implementedBy |
| [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) | softwareStackInstances | * |  |

---

# File: llms/classes/system_SdmSystemModel.md

# System Model (system_SdmSystemModel)

- Name: `system_SdmSystemModel`
- IRI: `sys:SystemModel` (https://w3id.org/altium/cdm/system/SystemModel)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Activity
- Is a: [core_Activity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Activity.md)
- HTML page: [classes/system_SdmSystemModel/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSystemModel/)

A high-level system model that captures the overall system architecture, crossing boundary between functional and logical domains (e.g., hardware and software).

## In the product

- [Renesas 365](https://www.altium.com/documentation/altium-365/renesas-365#system_data_model) (primary)
- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#pushing_pulling_sdm)
- [Working with Renesas 365 Solutions](https://www.altium.com/documentation/altium-designer/working-renesas-365-solutions#pulling_sdm_into_a_hardware_project)
- Term: **System Data Model** (exact; altium-365, altium-designer)
- Term: **SDM** (exact; altium-365, altium-designer)

## In the API

- Platform API type: [`SysSdmSystemModel`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSystemModel/) (object)

## GRID

`grid:workspace:{workspace-id}:system-design:sdm/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| latestVersion | [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | 1 | Latest version of the system model. |  |  |
| versions | [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | * | Versions of the system model, used for tracking changes over time. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

---

# File: llms/classes/system_SdmSystemModelVersion.md

# System Model Version (system_SdmSystemModelVersion)

- Name: `system_SdmSystemModelVersion`
- IRI: `sys:SystemModelVersion` (https://w3id.org/altium/cdm/system/SystemModelVersion)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Artifact
- Is a: [core_Artifact](https://altiumdeveloper.github.io/cdm/llms/classes/core_Artifact.md)
- HTML page: [classes/system_SdmSystemModelVersion/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSystemModelVersion/)

A specific version of a system model, capturing the state of the system design at a particular point in time.

## In the API

- Platform API type: [`SysSdmSystemModelVersion`](https://altiumdeveloper.github.io/platform-api-docs/types/objects/SysSdmSystemModelVersion/) (object)

## GRID

`grid:workspace:{workspace-id}:system-design:sdm-version/{id}`

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| name | string | 0..1 | A short name of the entity. |  |  |
| version | integer | 1 | Version of the system model, used for tracking changes over time. |  |  |
| schemaVersion | string | 0..1 | The semantic version of the SDM schema this model version conforms to, used for compatibility checks. |  |  |
| functionalModel | [system_SdmFunctionalModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmFunctionalModel.md) | 0..1 | A functional model associated with the system model. |  |  |
| deviceModels | [system_SdmDeviceModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmDeviceModel.md) | * | A device models associated with this system model. |  |  |
| softwareModels | [system_SdmSoftwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareModel.md) | * | A software models associated with this system model. |  |  |
| hardwareModels | [system_SdmHardwareModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmHardwareModel.md) | * | A hardware models associated with this system model. |  |  |
| metadata | [system_SdmSystemModelVersionMetadata](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersionMetadata.md) | 0..1 | Metadata associated with this system model version. |  |  |
| id | GRID | 1 | Globally unique identifier across the whole platform. |  | [core_Entity](https://altiumdeveloper.github.io/cdm/llms/classes/core_Entity.md) |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) | latestVersion | 1 |  |
| [system_SdmSystemModel](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModel.md) | versions | * |  |

---

# File: llms/classes/system_SdmSystemModelVersionMetadata.md

# System Model Version Metadata (system_SdmSystemModelVersionMetadata)

- Name: `system_SdmSystemModelVersionMetadata`
- IRI: `sys:SdmSystemModelVersionMetadata` (https://w3id.org/altium/cdm/system/SdmSystemModelVersionMetadata)
- Bounded context: [system-sdm](https://altiumdeveloper.github.io/cdm/llms/system-sdm.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SdmSystemModelVersionMetadata/](https://altiumdeveloper.github.io/cdm/classes/system_SdmSystemModelVersionMetadata/)

Metadata associated with a specific version of a system model, capturing provenance information.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| createdAt | datetime | 1 | The date and time when the SDM version was created. |  |  |
| createdBy | [plt_WorkspaceUser](https://altiumdeveloper.github.io/cdm/llms/classes/plt_WorkspaceUser.md) | 1 | The user that created this SDM version. |  |  |
| authoringApplication | [system_SdmAuthoringApplication](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmAuthoringApplication.md) | 1 | The application used to create this SDM version. |  |  |
| tags | string | 1..* | The tags associated with this SDM version. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSystemModelVersion](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSystemModelVersion.md) | metadata | 0..1 |  |

---

# File: llms/classes/system_SoftwareComponent.md

# Software Component (system_SoftwareComponent)

- Name: `system_SoftwareComponent`
- IRI: `sys:SoftwareComponent` (https://w3id.org/altium/cdm/system/SoftwareComponent)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SoftwareComponent/](https://altiumdeveloper.github.io/cdm/classes/system_SoftwareComponent/)

Functional in nature, abstracted from but connected to logical implementation.

## In the product

- [Electronic System Design](https://www.altium.com/documentation/altium-365/esd#software_component) (primary)

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| name | string | 0..1 | A short name of the entity. |  |  |
| parameters | [system_Parameter](https://altiumdeveloper.github.io/cdm/llms/classes/system_Parameter.md) | * |  |  |  |
| parentKeyComponentId | [system_KeyComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) | 1 |  |  |  |
| portsAssociationsIds | [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | * |  |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_FunctionalBlock](https://altiumdeveloper.github.io/cdm/llms/classes/system_FunctionalBlock.md) | softwareComponents | * |  |
| [system_KeyComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_KeyComponent.md) | childSoftwareComponentsIds | * |  |
| [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | softwareComponentId | 1 |  |
| [system_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareProject.md) | softwareComponents | * |  |

---

# File: llms/classes/system_SoftwareProject.md

# Software Project (system_SoftwareProject)

- Name: `system_SoftwareProject`
- IRI: `sys:SoftwareProject` (https://w3id.org/altium/cdm/system/SoftwareProject)
- Bounded context: [system](https://altiumdeveloper.github.io/cdm/llms/system.md)
- Kind: Resource
- Is a: [core_Resource](https://altiumdeveloper.github.io/cdm/llms/classes/core_Resource.md)
- HTML page: [classes/system_SoftwareProject/](https://altiumdeveloper.github.io/cdm/classes/system_SoftwareProject/)

An entry of an ESD document for a software project (sft_SoftwareProject) that implements part of the system, listing the software components that project covers. In the ESD editor a software project can be linked to a software blanket, and each project can be linked to at most one blanket in a document.

## Attributes

| Field | Range | Cardinality | Description | Relation | Inherited from |
| --- | --- | --- | --- | --- | --- |
| id | string | 1 | Local unique identifier within a given context. |  |  |
| implementedBy | [sft_SoftwareProject](https://altiumdeveloper.github.io/cdm/llms/classes/sft_SoftwareProject.md) | 0..1 | This activity is implemented by another activity (e.g. a requirement implemented by a design). | core_implementedBy |  |
| softwareComponents | [system_SoftwareComponent](https://altiumdeveloper.github.io/cdm/llms/classes/system_SoftwareComponent.md) | * | Software components associated with this software project. |  |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_ESD](https://altiumdeveloper.github.io/cdm/llms/classes/system_ESD.md) | softwareProjects | * |  |

---

# File: llms/enums/Enumeration.md

# Enumeration

- Name: `Enumeration`
- Kind: enumeration
- HTML page: [enums/Enumeration/](https://altiumdeveloper.github.io/cdm/enums/Enumeration/)

---

# File: llms/enums/Maturity.md

# Maturity

- Name: `Maturity`
- IRI: `core:Maturity` (https://w3id.org/altium/cdm/core/Maturity)
- Kind: enumeration
- HTML page: [enums/Maturity/](https://altiumdeveloper.github.io/cdm/enums/Maturity/)

## Values

| Value | Description |
| --- | --- |
| `EXPERIMENTAL` |  |
| `PRODUCTION` |  |
| `OBSOLETE` |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [core_WithMaturity](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithMaturity.md) | maturity | 0..1 |  |

---

# File: llms/enums/VaultContentType.md

# Vault Content Type (VaultContentType)

- Name: `VaultContentType`
- IRI: `core:VaultContentType` (https://w3id.org/altium/cdm/core/VaultContentType)
- Kind: enumeration
- HTML page: [enums/VaultContentType/](https://altiumdeveloper.github.io/cdm/enums/VaultContentType/)

## Values

| Value | Description |
| --- | --- |
| `altium-project` |  |
| `altium-component` |  |
| `altium-symbol` |  |
| `altium-reuse-block` |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [core_WithVault](https://altiumdeveloper.github.io/cdm/llms/classes/core_WithVault.md) | contentType | 0..1 |  |

---

# File: llms/enums/des_DesignReviewStatus.md

# Design Review Status (des_DesignReviewStatus)

- Name: `des_DesignReviewStatus`
- IRI: `des:DesignReviewStatus` (https://w3id.org/altium/cdm/design/DesignReviewStatus)
- Kind: enumeration
- HTML page: [enums/des_DesignReviewStatus/](https://altiumdeveloper.github.io/cdm/enums/des_DesignReviewStatus/)

The state of a design review.

## Values

| Value | Description |
| --- | --- |
| `InProgress` | The review is open; Reviewers can complete their tasks. |
| `Completed` | The Initiator closed the review as completed; it can no longer be changed. |
| `Rejected` | The Initiator closed the review as rejected; it can no longer be changed. |
| `Cancelled` | The Initiator or a Reviewer cancelled the review; its tasks are resolved and it can no longer be changed. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [des_DesignReview](https://altiumdeveloper.github.io/cdm/llms/classes/des_DesignReview.md) | status | 1 |  |

---

# File: llms/enums/dm_AccessType.md

# Access Type (dm_AccessType)

- Name: `dm_AccessType`
- IRI: `dm:AccessType` (https://w3id.org/altium/cdm/deviceModel/AccessType)
- Kind: enumeration
- HTML page: [enums/dm_AccessType/](https://altiumdeveloper.github.io/cdm/enums/dm_AccessType/)

Specifies the access permissions for a register or memory region.

## Values

| Value | Description |
| --- | --- |
| `ReadOnly` | The register or memory region can only be read. |
| `WriteOnly` | The register or memory region can only be written to. |
| `ReadWrite` | The register or memory region can be both read from and written to. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Register](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Register.md) | access | 0..1 |  |
| [dm_RegisterField](https://altiumdeveloper.github.io/cdm/llms/classes/dm_RegisterField.md) | access | 0..1 |  |

---

# File: llms/enums/dm_AddressBlockType.md

# Address Block Type (dm_AddressBlockType)

- Name: `dm_AddressBlockType`
- IRI: `dm:AddressBlockType` (https://w3id.org/altium/cdm/deviceModel/AddressBlockType)
- Kind: enumeration
- HTML page: [enums/dm_AddressBlockType/](https://altiumdeveloper.github.io/cdm/enums/dm_AddressBlockType/)

Specifies the type of address block within the device's memory map.

## Values

| Value | Description |
| --- | --- |
| `Memory` | Address block represents a memory region (e.g., RAM, Flash). |
| `Peripheral` | Address block represents a peripheral device (e.g., UART, GPIO). |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_AddressBlock](https://altiumdeveloper.github.io/cdm/llms/classes/dm_AddressBlock.md) | type | 0..1 |  |

---

# File: llms/enums/dm_Endianness.md

# Endianness (dm_Endianness)

- Name: `dm_Endianness`
- IRI: `dm:Endianness` (https://w3id.org/altium/cdm/deviceModel/Endianness)
- Kind: enumeration
- HTML page: [enums/dm_Endianness/](https://altiumdeveloper.github.io/cdm/enums/dm_Endianness/)

Specifies the byte-ordering convention of the processor. Bi-endian indicates the hardware can be configured for either mode.

## Values

| Value | Description |
| --- | --- |
| `LittleEndian` | Least significant byte is stored at the lowest address. |
| `BigEndian` | Most significant byte is stored at the lowest address. |
| `BiEndian` | Processor supports switching between little and big endian modes. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_Processor](https://altiumdeveloper.github.io/cdm/llms/classes/dm_Processor.md) | endian | 1 |  |

---

# File: llms/enums/dm_GpioMode.md

# GPIO Mode (dm_GpioMode)

- Name: `dm_GpioMode`
- IRI: `dm:GpioMode` (https://w3id.org/altium/cdm/deviceModel/GpioMode)
- Kind: enumeration
- HTML page: [enums/dm_GpioMode/](https://altiumdeveloper.github.io/cdm/enums/dm_GpioMode/)

Defines the specific electrical and logical configuration of a pin when PortMode is set to Gpio.

## Values

| Value | Description |
| --- | --- |
| `None` | No specific GPIO mode assigned (often used for high-impedance or initial state). |
| `Input` | Pin is configured as a digital input. |
| `OutputLow` | Pin is configured as a digital output with a default logic low (0) state. |
| `OutputHigh` | Pin is configured as a digital output with a default logic high (1) state. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md) | gpioMode | 0..1 |  |

---

# File: llms/enums/dm_PeripheralVirtualization.md

# Peripheral Virtualization (dm_PeripheralVirtualization)

- Name: `dm_PeripheralVirtualization`
- IRI: `dm:PeripheralVirtualization` (https://w3id.org/altium/cdm/deviceModel/PeripheralVirtualization)
- Kind: enumeration
- HTML page: [enums/dm_PeripheralVirtualization/](https://altiumdeveloper.github.io/cdm/enums/dm_PeripheralVirtualization/)

Defines the virtualization model used by a peripheral interface, describing whether the peripheral is implemented as a single, non-virtualized instance or as multiple virtualized instances mapped to individual functional channels.

## Values

| Value | Description |
| --- | --- |
| `None` | No virtualization. All associated functions collectively implement a single peripheral interface instance (for example, SCI0 on RA devices). |
| `Channel` | Channel-based virtualization. Each individual function represents an independent channel and implements the peripheral interface type separately (for example, ADC on RA devices where each ANxxx function corresponds to an ADC channel). |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PeripheralInstance](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PeripheralInstance.md) | virtualization | 0..1 |  |

---

# File: llms/enums/dm_PortMode.md

# Port Mode (dm_PortMode)

- Name: `dm_PortMode`
- IRI: `dm:PortMode` (https://w3id.org/altium/cdm/deviceModel/PortMode)
- Kind: enumeration
- HTML page: [enums/dm_PortMode/](https://altiumdeveloper.github.io/cdm/enums/dm_PortMode/)

Defines the primary operational mode of a physical port pin. Determines if the pin is controlled by the GPIO controller or routed to a specific peripheral function.

## Values

| Value | Description |
| --- | --- |
| `Gpio` | Pin is configured as General Purpose Input/Output. |
| `AlternateFunction` | Pin is routed to a specific peripheral internal signal (e.g., UART TX, SPI CLK). |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [dm_PortConfigurationDependency](https://altiumdeveloper.github.io/cdm/llms/classes/dm_PortConfigurationDependency.md) | portMode | 0..1 |  |

---

# File: llms/enums/ota_DeploymentStatus.md

# ota_DeploymentStatus

- Name: `ota_DeploymentStatus`
- IRI: `ota:DeploymentStatus` (https://w3id.org/altium/cdm/ota/DeploymentStatus)
- Kind: enumeration
- HTML page: [enums/ota_DeploymentStatus/](https://altiumdeveloper.github.io/cdm/enums/ota_DeploymentStatus/)

The status of a deployment on one target device, reported by its Deployment Result. Success or failure of a completed deployment is reported by the result's isSuccessful.

## Values

| Value | Description |
| --- | --- |
| `Pending` | The deployment is created and not yet received by the device. |
| `Scheduled` | The deployment is scheduled to start at a future date and time. |
| `InProgress` | The device has received the update instructions and is installing. |
| `Completed` | The deployment finished, either successfully or with a failure. A partially completed deployment, where only some ECUs installed successfully, is also Completed, with isSuccessful false. |
| `Cancelled` | The deployment was cancelled before it was received by the device. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_DeploymentResult](https://altiumdeveloper.github.io/cdm/llms/classes/ota_DeploymentResult.md) | status | 0..1 |  |

---

# File: llms/enums/ota_DeviceStatus.md

# Device Status (ota_DeviceStatus)

- Name: `ota_DeviceStatus`
- IRI: `ota:DeviceStatus` (https://w3id.org/altium/cdm/ota/DeviceStatus)
- Kind: enumeration
- HTML page: [enums/ota_DeviceStatus/](https://altiumdeveloper.github.io/cdm/enums/ota_DeviceStatus/)

The OTA update status of a device.

## Values

| Value | Description |
| --- | --- |
| `NotSeen` | The device has not connected to the platform yet. |
| `Error` | The last update reported an error. |
| `UpToDate` | The installed software matches the assigned software. |
| `UpdatePending` | An update is assigned and waits to be delivered. |
| `Outdated` | The installed software differs from the assigned software. |
| `UpdateScheduled` | An update is scheduled for a future date and time. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [ota_Device](https://altiumdeveloper.github.io/cdm/llms/classes/ota_Device.md) | status | 0..1 |  |

---

# File: llms/enums/system_PortType.md

# Port Type (system_PortType)

- Name: `system_PortType`
- IRI: `sys:PortType` (https://w3id.org/altium/cdm/system/PortType)
- Kind: enumeration
- HTML page: [enums/system_PortType/](https://altiumdeveloper.github.io/cdm/enums/system_PortType/)

## Values

| Value | Description |
| --- | --- |
| `UART` |  |
| `GPIO` |  |
| `I2C` |  |
| `PWM` |  |
| `ADC` |  |
| `SPI` |  |
| `CAN` |  |
| `USB` |  |
| `DAC` |  |
| `DISPLAY` |  |
| `ETHERNET` |  |
| `IRQ` |  |
| `CAMERA` |  |
| `AUDIO` |  |
| `CD/MMC` |  |
| `POWER_MCU` |  |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_PortAssociation](https://altiumdeveloper.github.io/cdm/llms/classes/system_PortAssociation.md) | portLibraryName | 1 |  |
| [system_SdmPort](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmPort.md) | portType | 0..1 |  |

---

# File: llms/enums/system_SdmSoftwareComponentCategory.md

# Software Component Category (system_SdmSoftwareComponentCategory)

- Name: `system_SdmSoftwareComponentCategory`
- Kind: enumeration
- HTML page: [enums/system_SdmSoftwareComponentCategory/](https://altiumdeveloper.github.io/cdm/enums/system_SdmSoftwareComponentCategory/)

High-level classification of software components.

## Values

| Value | Description |
| --- | --- |
| `DRIVER` | Low-level HAL/drivers interacting with hardware. |
| `MIDDLEWARE` | Functional stacks (e.g., Motor Control, USB, TCP/IP). |
| `OPERATING_SYSTEM` | Kernel or RTOS components. |
| `APPLICATION` | High-level logic, AI models, or user-defined code. |
| `LIBRARY` | Static utility code or mathematical libraries. |

## Referenced by

| From | Field | Cardinality | Relation |
| --- | --- | --- | --- |
| [system_SdmSoftwareSpecification](https://altiumdeveloper.github.io/cdm/llms/classes/system_SdmSoftwareSpecification.md) | category | 0..1 |  |