Zum Hauptinhalt springen

29 docs getaggt mit "Developer"

All documents that are targeted at developers

Alle Tags anzeigen

Adapter Development

Dieses Dokument bietet einen umfassenden Leitfaden zur Entwicklung von Adaptern für OctoMesh und behandelt sowohl Edge- als auch Mesh-Adapter.

API Integration

Dieses Dokument beschreibt, wie Sie sich in die OctoMesh-APIs integrieren, einschließlich Authentifizierung, GraphQL-Operationen und dem Service Client SDK.

Blueprints

Blueprints sind versionierte, deklarative Bündel aus Construction-Kit-(CK-)Modellen und Runtime-Seed-Daten, die einen Tenant initialisieren (bootstrappen) — und ihn über seine gesamte Lebensdauer hinweg weiter verwalten. Ein Blueprint kann installiert, erneut angewendet, aktualisiert, zurückgerollt und deinstalliert werden und kann von anderen Blueprints abhängen. Versionierte Migrationsskripte transformieren die Tenant-Daten, wenn die eigene Version eines Blueprints vorwärts wandert.

Datenmodell-Konzepte

Dieses Dokument erläutert die grundlegenden Datenmodellierungskonzepte in OctoMesh, darunter Construction Kits, Runtime-Entitäten und Streamdaten.

Einführung in das Benutzerhandbuch

OctoMesh hilft Ihnen, Struktur in die Daten Ihrer Organisation zu bringen. Es ist ein leistungsstarkes Werkzeug, das Sie dabei unterstützt, Ihre Daten effizienter zu verwalten.

Einführung in den Developer Guide

Dieser Developer Guide ist der Ausgangspunkt für Entwickler und Systemarchitekten, die auf der OctoMesh-Plattform integrieren und aufbauen möchten. OctoMesh ist eine fortschrittliche, skalierbare Plattform, die für die modernen Anforderungen des Industrial Internet of Things (IIoT), für Multi-Tenant-Umgebungen und komplexe verteilte Systeme konzipiert ist.

Formula Engine

Die Formula Engine wertet kleine numerische Ausdrücke überall dort aus, wo die Plattform eine

Formula Expressions

Mehrere OctoMesh-Funktionen erlauben es Ihnen, eine Formel einzugeben – einen kleinen numerischen Ausdruck, der

How archives work

Diese Seite ist die architektonische Grundlage für Streamdaten: das mentale Modell und das Vokabular, das Sie benötigen, bevor Sie entweder die vollständige Referenz Stream Data Archives oder das Deep-Dive Rollups & recompute lesen. Sie erklärt, wie die Teile zusammenpassen – die Aufteilung auf zwei Stores, die drei Archivtypen, wie Zeilen gespeichert werden, wie ein Archiv seinen Lebenszyklus durchläuft und was auf dem Schreib- und Lesepfad geschieht – und übergibt dann an die Referenz- und Deep-Dive-Seiten für die erschöpfenden Details.

Introduction to API Reference

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.

Konfiguration

Konfigurationsoberfläche für die MCP (Model Context Protocol) Services. Die meisten Einstellungen sind für gehostete Cluster statisch (zum Deploy-Zeitpunkt über Helm-Values gesetzt); diese Seite dokumentiert, was jede einzelne bewirkt, damit Sie sie während der lokalen Entwicklung oder beim Review einer Helm-Änderung sinnvoll überschreiben können.

Lokale Entwicklung

Betrieb der MCP (Model Context Protocol) Services aus dem Quellcode gegen einen lokalen OctoMesh-Stack auf Ihrem eigenen Rechner.

MCP Services – Entwicklung

Dieser Abschnitt richtet sich an Entwickler, die an den MCP (Model Context Protocol) Services selbst arbeiten — die Services aus dem Quellcode bauen, sie gegen einen lokalen OctoMesh-Stack betreiben und die Konfigurationsoberfläche verstehen. Endanwender-Dokumentation (Registrierung der gehosteten Endpunkte bei Claude Code, verfügbare Tools, Fehlerbehebung) finden Sie unter MCP Services im Tech Guide.

Modell-Migrationen

Wenn sich ein Construction-Kit-(CK-)Modell zu einer neuen Version weiterentwickelt, müssen bestehende Runtime-Entitäten in den Tenant-Datenbanken möglicherweise aktualisiert werden, um dem neuen Schema zu entsprechen. CK-Modell-Migrationen automatisieren diesen Prozess, indem sie versionierte Transformationsskripte definieren, die Entitätsdaten während des Modellimports aktualisieren (Typen umbenennen, Attribute ändern usw.).

Rollups & recompute

Diese Seite ist der an Ingenieure gerichtete Begleiter zu Stream Data Archives. Sie erklärt, wie ein RollupArchive seine abgeleiteten Aggregationen korrekt hält, während sich die zugrunde liegenden Daten ändern – das Erkennungskriterium, das Dirty-Windows-Ledger, der Abhängigkeitsgraph, der periodische Orchestrator und der optimistische atomare Swap, der Leser durchgehend auf einem konsistenten Snapshot hält.

Secret-Attribute

Der Attribut-Werttyp Secret speichert Zugangsdaten — Passwörter, Client Secrets, API-Schlüssel, Bot-Tokens, private Schlüssel, Refresh Tokens — verschlüsselt. Die Engine erzwingt das: Ein Secret-Wert wird bei jedem Schreiben verschlüsselt, keine öffentliche API gibt ihn zurück, und Lesende sehen nur, ob ein Wert gesetzt ist.

Stream Data Archives

Ein Stream Data Archive ist die Einheit für Konfiguration und Speicherung von Zeitreihendaten in OctoMesh. Jedes Archiv ist eine versionierte, typisierte CrateDB-Tabelle pro Tenant, die eine kuratierte Menge von Attributpfaden eines Construction-Kit-Typs erfasst. Archive haben einen strengen Lebenszyklus (Created → Activated → Disabled / Failed), ein nach der Aktivierung unveränderliches Schema und ein dreistufiges Aktivierungs-Gate (Instanz → Tenant → Archiv), das bestimmt, ob die Datenebene geöffnet ist.

Timezone-Aware Queries

Streamdaten werden immer in UTC gespeichert. Viele Fragen werden jedoch in ziviler (Wanduhr-)Zeit für einen bestimmten Ort gestellt: „Wie waren die Werte **gestern**? diese Woche? letzten Monat?" – gemeint sind die lokalen Tages-/Wochen-/Monatsgrenzen einer gewählten Zeitzone, nicht ein UTC-Tag, der gegen den lokalen verschoben ist.

Überblick über die Lösungsarchitektur

Dieses Dokument bietet einen umfassenden Überblick über die Architektur der OctoMesh-Plattform und soll Entwicklern helfen, die Systemkomponenten, Datenflüsse und Integrationsmuster zu verstehen.

Versionierungsregeln

CK-Modellversionen folgen SemVer, und Abhängigkeiten werden als Versionsbereiche deklariert – aber welche konkrete Version ein Bereich auflöst, hängt davon ab, wo die Auflösung stattfindet. Dies falsch zu machen ist die häufigste Ursache für ResolveFailed-Modelle und fehlgeschlagene Blueprint-Installationen, weshalb die Regeln hier an einer Stelle ausbuchstabiert werden.