Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

2.2 Dateistruktur Übersicht

2.2 Dateistruktur Übersicht

Root-Objekt Struktur

Jede RUML-Datei MUSS ein JSON-Objekt als Root-Element haben (Regel FMT-02FMT-02 Die Datei MUSS gültiges JSON sein (RFC 8259), und ihr Root-Wert MUSS ein Objekt sein.):

{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [/* ... */],
"metadata": {/* ... */},
"rulemap": {/* ... */}
}

Format-Identifikation

  • Das Feld $format MUSS einen der folgenden Werte haben:
    • "RUML" — reguläre Inhaltsdatei (diese Spezifikation)
    • "RUML-Result" — separate Auswertungsergebnisdatei (siehe Kapitel 5.1)
    • "RUML-EXT" — Capability-Erweiterungsoverlay (Sidecar-Datei); hat eine abweichende Root-Struktur ohne metadata und rulemap (siehe Kapitel 4.5)
  • Das Feld $specVersion MUSS die Formatversion angeben (2.3)
  • Diese Felder MÜSSEN die ersten beiden Felder im Root-Objekt sein (Regel FMT-05FMT-05 $format und $specVersion MÜSSEN die ersten beiden Felder des Root-Objekts sein.)
  • Bei "RUML-Result" MUSS zusätzlich ein rumlReference-Objekt vorhanden sein (siehe Kapitel 5.1)

Pflichtfelder im Root-Objekt

FeldTypBeschreibung
$formatStringMUSS "RUML" sein (Regel FMT-03FMT-03 $format MUSS "RUML" sein.)
$specVersionStringMUSS die Formatversion angeben (2.3) (Regel FMT-04FMT-04 $specVersion MUSS eine der Versionen sein, die das enum von $specVersion im Schema aufführt.)
metadataObjectMUSS die in Kapitel 3.3 definierten Metadaten enthalten (Regel FMT-06FMT-06 Das Root-Objekt MUSS metadata und rulemap haben; ein Parser MUSS es mit und ohne capabilities akzeptieren.)
rulemapObjectMUSS die in Kapitel 3.4 definierte Rulemap-Struktur enthalten (Regel FMT-06FMT-06 Das Root-Objekt MUSS metadata und rulemap haben; ein Parser MUSS es mit und ohne capabilities akzeptieren.)

Optionale Felder im Root-Objekt

FeldTypBeschreibung
capabilitiesArrayDARF die Capabilities deklarieren, die diese Datei verwendet, als Liste von Einträgen; ihre Reihenfolge ist nicht signifikant. Jeder Eintrag führt seine Daten in seinem payload (siehe Kapitel 4) (Regel FMT-06FMT-06 Das Root-Objekt MUSS metadata und rulemap haben; ein Parser MUSS es mit und ohne capabilities akzeptieren.)

Das Root-Objekt DARF KEINE anderen Felder als diese haben (Regel FMT-07FMT-07 Das Root-Objekt DARF KEINE anderen Felder als $format, $specVersion, metadata, capabilities und rulemap haben.).

Minimale gültige Datei

{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"label": "Root"
}
}
}
}

Hinweise:

  • Das nodes-Objekt ist das einzige Pflichtfeld in der rulemap
  • Der Root-Node MUSS den Key "1" im nodes-Objekt haben (LexID 1) (Regel FMT-08FMT-08 rulemap.nodes MUSS einen Eintrag mit dem Schlüssel "1" enthalten, den Root-Knoten.)
  • Jeder Node MUSS eine id haben (UUID v4) (Regel NODE-01NODE-01 Ein Knoten MUSS id und label haben.)
  • Integritätssicherung (Hash, Signatur) erfolgt auf Container-Ebene (siehe Kapitel 7)

RUML-Result-Format

Für die separate Speicherung von Auswertungsergebnissen wird das RUML-Result-Format verwendet:

  • Dateiendung: .ruml-result
  • Format-Identifikation: $format MUSS den Wert "RUML-Result" haben
  • Struktur: Siehe Kapitel 5.1

Das RUML-Result-Format ermöglicht die Trennung von Regelstruktur und Auswertungsergebnissen. Dies ist besonders geeignet für Massenverfahren, Aktensysteme und Langzeitarchivierung.

{
"$format": "RUML-Result",
"$specVersion": "1.0",
"rumlReference": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"hash": "sha3-256:4e03657aea45a94fc7d47c89e3f5a2b7c4d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2"
},
"evaluation": {/* ... */}
}

Konformitätstests