Skip to content
RUMLRUML

Open Format for Digital Law

1.3 Terminology

1.3 Terminology

This section defines the terms used in this specification. Each term is summarized here; the normative definition is in the chapter cited.

Roles

TermDefinitionDefined in
ParserSoftware that reads a RUML file.1.4
ProducerSoftware that writes a RUML file.1.4
EvaluatorSoftware that determines the result of a rulemap.1.4
Validation toolA parser that checks every schema and semantic rule.1.4
Tool, implementationSoftware in any of these roles.1.4

Identifiers

TermDefinitionDefined in
LexIDIdentifier of a node within a RUML file: a positive integer encoded as a string.2.5
UUIDGlobally unique identifier (UUID v4) of a RUML file (metadata.id) and of each node.2.5

Structural Elements

TermDefinitionDefined in
NodeElement of the RUML hierarchy.3.5
Root NodeThe topmost node, with LexID 1.3.5.1
Parent NodeNode with children.3.5.1
Leaf NodeNode without children.3.5.1
Modular NodeA reusable Node6.2

Normative Text Anchoring

TermDefinitionDefined in
AnchorLink from a node to a text of the same RUML file, or one of its elements: the norm the node represents, or a text it refers-to.4.12
documentTypeKind of text a RUML file encodes, such as "law" or "regulation".3.3.6

Operators

TermDefinitionDefined in
ANDConjunction - all children MUST be true.3.6.1
ORDisjunction - at least one child MUST be true.3.6.2
XORDisjunction over children constructed so that at most one can be true.3.6.3
NOT_AND, NOT_OR, NOT_XORNegations of the corresponding operators.
DELEGATEDCombination defined by a capability carried in the node.3.6.4
undefinedPlaceholder operator; permitted only in draft.3.6.5

Capabilities

TermDefinitionDefined in
CapabilityDeclared extension that adds functionality without changing the core structure.4.1
Capability roleFunction that a capability fulfills in a rulemap, such as decision or data.4.1
Capability namespaceId prefix that determines ownership: ruml: (reserved), ruml:draft/ (experimental), or reverse-domain (third party).4.4

Status

TermDefinitionDefined in
Document statusValidity state of a RUML file, such as draft or inForce.3.3.3
Node statusEvaluation state of a node, such as true or false; not stored in the RUML file.5.0

File Formats and Integrity

TermDefinitionDefined in
RUML filePrimary content file (.ruml).2.2
RUML-EXTSidecar file (.ruml-ext) carrying capability data separately.4.5
RUML Result fileFile (.ruml-result) holding evaluation results.5
ContainerZIP package providing integrity, signatures, and encryption.7
HashIntegrity check value of the form {algorithm}:{value}.7.3