Name Personalisation Scheme¶
A Name Personalisation Scheme is a VTL scheme holding Name Personalisations, each of which replaces the default name
VTL uses for an artefact (for example a measure or attribute) with a personalised one. Documents start
ref: "NamePersonalisationScheme=AGENCY:ID(1.0)".
Simple form¶
The smallest complete Name Personalisation Scheme has a VTL version and one Name Personalisation. A Name
Personalisation is never written in the ID: "name" short form, every Name Personalisation is written as an object.
format: "fusion-yaml(1.0.0)"
ref: "NamePersonalisationScheme=SDMX:CUSTOM_NAMES(1.0)"
name: "CUSTOM_NAMES Name"
vtlVersion: "1.0"
items:
- NP1:
name: "N1"
vtlArtefact: "va1"
vtlDefaultName: "dn1"
personalisedName: "pn1"
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 Name Personalisations, in scheme order, each keyed by its id (see items).name– the localised name of the Name Personalisation.vtlArtefact– the kind of VTL artefact whose name is personalised. Required.vtlDefaultName– the default VTL name. Required.personalisedName– the name used in its place. Required.
Complete example¶
Every Name Personalisation field is required, and the scheme has no references to other structures, so there is no further complex form. The only optional content is the common item content (description, URI, annotations, links) shown in the field reference.
format: "fusion-yaml(1.0.0)"
ref: "NamePersonalisationScheme=SDMX:CUSTOM_NAMES(1.0)"
name: "CUSTOM_NAMES Name"
vtlVersion: "1.0"
items:
- NP1:
name: "N1"
vtlArtefact: "va1"
vtlDefaultName: "dn1"
personalisedName: "pn1"
- NP2:
name: "N2"
vtlArtefact: "va2"
vtlDefaultName: "dn2"
personalisedName: "pn2"
Field reference¶
Scheme fields, written after the common header:
| Field | Value | Written when |
|---|---|---|
partial |
true |
The scheme is a partial item scheme |
vtlVersion |
String | The VTL version is set (always, unless a stub) |
items |
Array of Name Personalisations | The scheme has at least one Name Personalisation |
Name Personalisation 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 Name Personalisation has a description |
uri |
String | The Name Personalisation has a URI |
vtlArtefact |
String | Always (required) |
vtlDefaultName |
String | Always (required) |
personalisedName |
String | Always (required) |
annotations |
Array, see annotations | The Name Personalisation has annotations |
links |
Array, see links | The Name Personalisation has links |
Name Personalisations never use the - ID: "name" simple item form, as the Name
Personalisation bean reports itself as never simple.