Skip to content

Ruleset Scheme

A Ruleset Scheme is a VTL scheme holding Rulesets: datapoint or hierarchical rulesets defined in VTL, which Transformation Schemes can use. Documents start ref: "RulesetScheme=AGENCY:ID(1.0)".

Simple form

The smallest complete Ruleset Scheme has a VTL version and one Ruleset. A Ruleset is never written in the ID: "name" short form, every Ruleset is written as an object.

format: "fusion-yaml(1.0.0)"
ref: "RulesetScheme=SDMX:RULESETS(1.0)"
name: "RULESETS Name"
vtlVersion: "1.0"
items:
- RS1:
    name: "R1"
    rulesetType: "rt1"
    rulesetScope: "rs1"
    rulesetDefinition: "rd1"
Trimmed from rulesetscheme/testComplete.yaml

The document starts with the common header. The body fields are:

  • vtlVersion – the version of VTL the scheme is written in. Required for every VTL scheme that is not a stub.
  • items – the Rulesets, in scheme order, each keyed by its id (see items).
    • name – the localised name of the Ruleset.
    • rulesetType – the type of ruleset (in VTL, datapoint or hierarchical). Required.
    • rulesetScope – what the ruleset is defined on (in VTL, variable or valuedomain). Required.
    • rulesetDefinition – the VTL ruleset definition. Required.

Complex form

The only optional scheme field is a reference to the VTL Mapping Scheme used by the rulesets.

format: "fusion-yaml(1.0.0)"
ref: "RulesetScheme=SDMX:RULESETS(1.0)"
name: "RULESETS Name"
vtlmappingscheme: "SDMX:VMS(1.0.0)"
vtlVersion: "1.0"
items:
- RS1:
    name: "R1"
    rulesetType: "rt1"
    rulesetScope: "rs1"
    rulesetDefinition: "rd1"
- RS2:
    name: "R2"
    rulesetType: "rt2"
    rulesetScope: "rs2"
    rulesetDefinition: "rd2"
Source: rulesetscheme/testComplete.yaml

  • vtlmappingscheme is a reference keyed by the lower case class of the referenced structure with a short URN value. It is written before vtlVersion.
  • A Ruleset may also carry a description, a URI, annotations and links, written in the positions given in the field reference below.

Field reference

Scheme fields, written after the common header:

Field Value Written when
partial true The scheme is a partial item scheme
vtlmappingscheme Short URN of a VTL Mapping Scheme The scheme references a VTL Mapping Scheme
vtlVersion String The VTL version is set (always, unless a stub)
items Array of Rulesets The scheme has at least one Ruleset

Ruleset fields (items[].<ID>):

Field Value Written when
name, name-<lang> String Always (en as name, other locales as name-<lang>)
description, description-<lang> String The Ruleset has a description
uri String The Ruleset has a URI
rulesetType String Always (required)
rulesetScope String Always (required)
rulesetDefinition String Always (required)
annotations Array, see annotations The Ruleset has annotations
links Array, see links The Ruleset has links

Rulesets never use the - ID: "name" simple item form, as the Ruleset bean reports itself as never simple.