Topic Convention

umh.v1.<location_path>.<data_contract>[.<virtual_path>].<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. Must not start with underscores.

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).

name

msg.meta.tag_name or auto-derived

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

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

Last updated