Access Modifiers
CK language 2 adds three modifiers. All of them require ckLanguage: 2 (message 90 otherwise).
All documents that are targeted at developers
View all tagsCK language 2 adds three modifiers. All of them require ckLanguage: 2 (message 90 otherwise).
This document provides a comprehensive guide to developing adapters for OctoMesh, covering both Edge and Mesh adapters.
This document covers how to integrate with OctoMesh APIs, including authentication, GraphQL operations, and the service client SDK.
A blueprint update re-imports the seed data into a tenant that has been in use for a while. The import is a full replace of every entity it touches, so without rules a seed that carries an empty value would erase what the tenant has entered since the install (an adapter configuration, an enforcement mode, a counter, a mail text). The rules on this page decide, for every value, whether the blueprint or the tenant owns it and what the platform does when the two disagree.
Blueprints are versioned, declarative bundles of Construction Kit (CK) models and runtime seed data that bootstrap a tenant — and continue to manage it across its lifetime. A blueprint can be installed, re-applied, updated, rolled back, uninstalled, and may depend on other blueprints. Versioned migration scripts transform tenant data when a blueprint's own version moves forward.
The compiler and the engine report CK language 2 problems with the message numbers below (Error 112 types/types.yaml: ...). The same checks run when a compiled model is resolved — on publish and on import into a tenant — so a model that bypassed the compiler is refused as well. All messages are errors unless marked warning.
Configuration surface for the MCP (Model Context Protocol) Services. Most settings are static for hosted clusters (set via Helm values at deploy time); this page documents what each one does so you can override sensibly during local development or when reviewing a Helm change.
This document explains the fundamental data modeling concepts in OctoMesh, including Construction Kits, Runtime Entities, and Stream Data.
Every deprecated OctoMesh REST endpoint with the CK method that replaces it, the date it was deprecated and the date it may be removed.
The formula engine evaluates small numeric expressions wherever the platform accepts a
Several OctoMesh features let you enter a formula — a small numeric expression that
This page describes how CK language 2 elements appear in a tenant's GraphQL schema (asset repository): attribute access, CK interfaces as GraphQL interfaces, and the CK meta API.
This page is the architectural foundation for stream data: the mental model and vocabulary you need before reading either the full Stream Data Archives reference or the Rollups & recompute deep-dive. It explains how the pieces fit together — the two-store split, the three archive types, how rows are stored, how an archive moves through its lifecycle, and what happens on the write and read paths — and then hands off to the reference and deep-dive pages for the exhaustive detail.
A method is declared in a Construction Kit model. A handler is the code that runs when the method is called. This guide shows how to write one for each of the three ways a method can be handled, and which rules every handler follows. The consistency rules (transactions, failures, retries) are stated in the Method Consistency Model; read it first.
An interface is a versioned contract that types implement. It names attributes, associations and methods a type must provide, without fixing the type's position in the inheritance hierarchy. Dependent models can then rely on "anything that is Named-1" instead of on a concrete type of another model — which is what keeps a change of that concrete type from cascading into every dependent.
Welcome to OctoMesh, the premier platform for building robust and scalable services, client applications, and communication adapters. OctoMesh is designed to empower developers with a suite of APIs that streamline the development process, enabling the creation of high-performance, reliable, and interconnected systems. Our comprehensive API library, tailored for .NET, provides the tools and resources necessary to harness the full potential of OctoMesh.
This Developer Guide is the starting point for developers and system architects who are looking to integrate and build on the OctoMesh platform. OctoMesh is an advanced, scalable platform designed for the modern needs of the Industrial Internet of Things (IIoT), multi-tenant environments, and complex distributed systems.
OctoMesh helps you to bring structure into your data in your organization. It is a powerful tool that can help you to manage your data in a more efficient way.
Running the MCP (Model Context Protocol) Services from source against a local OctoMesh stack on your own machine.
This section is for developers working on the MCP (Model Context Protocol) Services itself — building from source, running it against a local OctoMesh stack, and understanding the configuration surface. For end-user documentation (registering the hosted endpoints with Claude Code, available tools, troubleshooting), see MCP Services in the Tech Guide.
This page states what a method may assume about transactions, failures, ordering and repeated calls, and what the caller can rely on. It is the contract between the platform, the author of a method handler and the caller of a method. The practical how-to is in Implementing Method Handlers.
CK language 2 lets a type or an interface declare methods MethodOnly) and to replace ad-hoc REST endpoints.
method-metrics}
When a Construction Kit (CK) model evolves to a new version, existing runtime entities in tenant databases may need to be updated to match the new schema. CK model migrations automate this process by defining versioned transformation scripts that update entity data (rename types, change attributes, etc.) during model import.
CK language 2 is an opt-in extension of the Construction Kit YAML language. A model that declares ckLanguage
pipeline-method-handlers}
Today a compiled model freezes every dependency range into an exact pin: System-2.5,3.0) in ckModel.yaml becomes System-2.5.0 in the compiled model, and a tenant must hold exactly that version (see [Versioning rules). Every new System version therefore forces every dependent to be rebuilt and republished.
This page is the engineer-facing companion to Stream Data Archives. It explains how a RollupArchive keeps its derived aggregations correct as the underlying data changes — the detection criterion, the dirty-windows ledger, the dependency graph, the periodic orchestrator, and the optimistic atomic swap that keeps readers on a consistent snapshot throughout.
The attribute value type Secret stores credentials — passwords, client secrets, API keys, bot tokens, private keys, refresh tokens — encrypted at rest. The engine enforces it: a Secret value is encrypted on every write, no public API returns it, and readers only see whether a value is set.
A blueprint update imports its seed with Upsert, which is a full replace of the entity. Which attribute values survive
Generated by scripts/seed-ownership-audit/seedownershipaudit.py from the origin/main snapshot described on
This document provides a comprehensive overview of the OctoMesh platform architecture, designed to help developers understand the system components, data flows, and integration patterns.
A Stream Data Archive is the unit of configuration and storage for time-series data in OctoMesh. Each archive is a versioned, typed, per-tenant CrateDB table that captures a curated set of attribute paths from a Construction Kit type. Archives have a strict lifecycle (Created → Activated → Disabled / Failed), a schema that is frozen once activated (the one exception is adding a declared column, see Conflict precedence), and a three-tier activation gate (instance → tenant → archive) that determines whether the data plane is open.
Stream data is always stored in UTC. Many questions, however, are asked in civil (wall-clock) time for a specific place: "what were the values **yesterday**? this week? last month?" — meaning the local day / week / month boundaries of a chosen time zone, not a UTC day that is shifted against the local one.
CK model versions follow SemVer, and dependencies are declared as version ranges — but which concrete version a range resolves to depends on where the resolution happens. Getting this wrong is the most common cause of ResolveFailed models and failed blueprint installs, so the rules are spelled out here in one place.
A type can restrict who may write its runtime entities. With a writeAccess block, only the listed principal kinds and trusted service channels may create, update, replace or delete entities of the type, or change associations that have such an entity at either end. Everyone else is refused with message 144, and nothing is written.