LogoLogo
umh-core
umh-core
  • Introduction
  • Getting Started
  • Usage
    • Unified Namespace
      • Overview
      • Payload Formats
      • Topic Convention
      • Producing Data
      • Consuming Data
    • Data Flows
      • Overview
      • Bridges
      • Stand-alone Flow
      • Stream Processor 🚧
    • Data Modeling 🚧
      • Data Models 🚧
      • Data Contracts 🚧
      • Stream Processors 🚧
  • Production
    • Updating
    • Sizing Guide
    • Corporate Firewalls
    • Metrics
    • Migration from Classic
  • Reference
    • Configuration Reference
    • Container Layout
    • State Machines
    • Environment Variables
  • UMH Core vs UMH Classic
  • UMH Classic
    • Go To Documentation
  • Ressources
    • Website
    • Blog
Powered by GitBook
On this page
  1. Usage
  2. Unified Namespace

Topic Convention

umh.v1.<location_path>.<data_contract>[.<virtual_path>].<tag_name>

Segment

Filled by tag_processor meta field

Description & rules

umh.v1

—

Constant product / schema generation prefix.

location_path

msg.meta.location_path

Hierarchical location path (often based on ISA-95 but adaptable to any naming standard like KKS) – level0 (enterprise) is mandatory, additional levels are optional. Supports generic level0, level1, level2, etc. for flexibility across different organizational standards.

data_contract

msg.meta.data_contract

Needs to start with an underscore. Logical model that the payload conforms to (e.g. _historian, Pump, TemperatureSensor).

virtual_path†

msg.meta.virtual_path (optional)

Zero-to-many sub-segments used by explicit contracts to address sub-models or folders (e.g. motor.diagnostics).

tag_name

msg.meta.tag_name or auto-derived

Leaf field inside the contract (temperature, power, status).

† optional segments – omitted when empty.

With this convention every topic uniquely answers:

  • Where did the data originate? → location_path

  • What does it represent? → data_contract + (virtual_path) + tag_name

  • Version of the infrastructure → umh.v1

PreviousPayload FormatsNextProducing Data

Last updated 3 days ago