Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

4.3 Capability Data on Nodes

What a node's capability entries must contain, and which ids a node may carry or repeat.

repeated-decision-id

BeschreibungA leaf node carries `ruml:query` twice with different expressions; a `decision` capability may repeat, and `decisionMode` combines the results.
Erwartungaccept
Ebeneschema
RUML4-3-capabilities-node-field.fixtures/accept-repeated-decision-id.ruml
Abschnitt§4.3§4.1
4-3-capabilities-node-field.fixtures/accept-repeated-decision-id.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "ruml:datapoints",
"required": true,
"payload": {
"data": {
"dp_age": {
"name": "Alter",
"type": "number",
"binding": {
"type": "input"
}
},
"dp_birth_year": {
"name": "Geburtsjahr",
"type": "number",
"binding": {
"type": "input"
}
}
}
}
},
{
"id": "ruml:query",
"required": true
}
],
"metadata": {
"id": "5f0c2d8e-7a41-4b9e-9c3d-2e6f8a1b4c70",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "8c1e4b7a-3d2f-4e6a-9b0c-5d7e1f2a3b4c",
"label": "Volljährigkeit nachgewiesen",
"decisionMode": "fallback",
"capabilities": [
{
"id": "ruml:query",
"payload": {
"expression": "dp_age >= 18"
}
},
{
"id": "ruml:query",
"payload": {
"expression": "2024 - dp_birth_year >= 18"
}
}
]
}
}
}
}

repeated-official-data-id

BeschreibungA node carries `ruml:context` twice; a `data` capability appears at most once.
Erwartungreject
Ebeneschema
RUML4-3-capabilities-node-field.fixtures/reject-repeated-official-data-id.ruml
Abschnitt§4.3§4.1
Erwartete RegelverletzungenCAP-06
Stelle/rulemap/nodes/1/capabilities
4-3-capabilities-node-field.fixtures/reject-repeated-official-data-id.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "ruml:datapoints",
"required": true,
"payload": {
"data": {
"dp_age": {
"name": "Alter",
"type": "number",
"binding": {
"type": "input"
}
},
"dp_birth_year": {
"name": "Geburtsjahr",
"type": "number",
"binding": {
"type": "input"
}
}
}
}
},
{
"id": "ruml:context",
"payload": {
"data": {
"ctx_bgh_2024": {
"title": "BGH zur Volljährigkeit",
"category": "courtDecision",
"timestamp": "2024-01-15T10:00:00Z"
},
"ctx_faq": {
"title": "Häufige Fragen zur Volljährigkeit",
"category": "faq",
"timestamp": "2024-01-15T10:00:00Z"
}
}
}
},
{
"id": "ruml:query",
"required": true
}
],
"metadata": {
"id": "5f0c2d8e-7a41-4b9e-9c3d-2e6f8a1b4c70",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "8c1e4b7a-3d2f-4e6a-9b0c-5d7e1f2a3b4c",
"label": "Volljährigkeit nachgewiesen",
"capabilities": [
{
"id": "ruml:query",
"payload": {
"expression": "dp_age >= 18"
}
},
{
"id": "ruml:context",
"payload": {
"refs": ["ctx_bgh_2024"]
}
},
{
"id": "ruml:context",
"payload": {
"refs": ["ctx_faq"]
}
}
]
}
}
}
}

repeated-custom-data-id

BeschreibungA node carries a third-party capability twice whose root declaration states the `data` role; it appears at most once.
Erwartungreject
Ebenesemantic
RUML4-3-capabilities-node-field.fixtures/reject-repeated-custom-data-id.ruml
Abschnitt§4.3§4.1
Erwartete RegelverletzungenCAP-06
Stelle/rulemap/nodes/1/capabilities/2
4-3-capabilities-node-field.fixtures/reject-repeated-custom-data-id.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "ruml:datapoints",
"required": true,
"payload": {
"data": {
"dp_age": {
"name": "Alter",
"type": "number",
"binding": {
"type": "input"
}
},
"dp_birth_year": {
"name": "Geburtsjahr",
"type": "number",
"binding": {
"type": "input"
}
}
}
}
},
{
"id": "ruml:query",
"required": true
},
{
"id": "org.ruml.test/data",
"role": "data"
}
],
"metadata": {
"id": "5f0c2d8e-7a41-4b9e-9c3d-2e6f8a1b4c70",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "8c1e4b7a-3d2f-4e6a-9b0c-5d7e1f2a3b4c",
"label": "Volljährigkeit nachgewiesen",
"capabilities": [
{
"id": "ruml:query",
"payload": {
"expression": "dp_age >= 18"
}
},
{
"id": "org.ruml.test/data",
"payload": {
"status": "pending"
}
},
{
"id": "org.ruml.test/data",
"payload": {
"status": "approved"
}
}
]
}
}
}
}

undeclared-capability

BeschreibungThe root `capabilities` array declares `org.ruml.test/data`, but node `1` carries `org.ruml.test/decision`, which it does not declare.
Erwartungreject
Ebenesemantic
RUML4-3-capabilities-node-field.fixtures/reject-undeclared-capability.ruml
Abschnitt§4.3
Erwartete RegelverletzungenCAP-15
Stelle/rulemap/nodes/1/capabilities/0
4-3-capabilities-node-field.fixtures/reject-undeclared-capability.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "org.ruml.test/data",
"role": "data"
}
],
"metadata": {
"id": "fa906bd6-24f1-47f3-8ad5-ae3d5c745b56",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"label": "Anspruch auf Schadensersatz",
"capabilities": [
{
"id": "org.ruml.test/decision",
"payload": {
"result": "true"
}
}
]
}
}
}
}

entry-without-payload

BeschreibungNode `1` carries a `ruml:query` entry with `id` only; every node entry contains `payload`.
Erwartungreject
Ebeneschema
RUML4-3-capabilities-node-field.fixtures/reject-entry-without-payload.ruml
Abschnitt§4.3§3.5.3
Erwartete RegelverletzungenCAP-17
Stelle/rulemap/nodes/1/capabilities/0
4-3-capabilities-node-field.fixtures/reject-entry-without-payload.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "ruml:query"
}
],
"metadata": {
"id": "df57ac35-8e11-4d13-b5a1-0ee96d6393cd",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"label": "Anspruch auf Schadensersatz",
"capabilities": [
{
"id": "ruml:query"
}
]
}
}
}
}

protocol-on-node

BeschreibungNode `1` carries a `ruml:protocol` entry; the capability has no node-level data and is declared at root only.
Erwartungreject
Ebeneschema
RUML4-3-capabilities-node-field.fixtures/reject-protocol-on-node.ruml
Abschnitt§4.3§4.13
Erwartete RegelverletzungenCAP-18
Stelle/rulemap/nodes/1/capabilities/0
4-3-capabilities-node-field.fixtures/reject-protocol-on-node.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"capabilities": [
{
"id": "ruml:protocol"
}
],
"metadata": {
"id": "1596a7f6-885b-44b4-a50e-ad3b10356583",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "inForce",
"validFrom": "2024-01-01T00:00:00Z"
},
"rulemap": {
"nodes": {
"1": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"label": "Anspruch auf Schadensersatz",
"capabilities": [
{
"id": "ruml:protocol",
"payload": {}
}
]
}
}
}
}