Difference between revisions of "Versioning of structural metadata artefacts"
| Line 1: | Line 1: | ||
| − | + | [[Category:Concepts_Reference]] | |
=Overview= | =Overview= | ||
All [[Maintainable]] structures have a mandatory version number of the form 1.0, 1.1, 2.3. | All [[Maintainable]] structures have a mandatory version number of the form 1.0, 1.1, 2.3. | ||
| Line 7: | Line 7: | ||
The combination of the structure type, Agency ID, structure ID and version are used to uniquely identify any Maintainable structure using its [[URN]]. | The combination of the structure type, Agency ID, structure ID and version are used to uniquely identify any Maintainable structure using its [[URN]]. | ||
| + | Examples of URNs illustrating the use of version numbers:<br> | ||
<code><nowiki>urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_TIME_PER_COLLECT(1.11)</nowiki></code><br> | <code><nowiki>urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_TIME_PER_COLLECT(1.11)</nowiki></code><br> | ||
<code><nowiki>urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=IMF:ECOFIN_CONCEPTS(2.0).INDICATOR</nowiki></code><br> | <code><nowiki>urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=IMF:ECOFIN_CONCEPTS(2.0).INDICATOR</nowiki></code><br> | ||
<code><nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=IMF:ECOFIN_DSD(1.0)</nowiki></code><br> | <code><nowiki>urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=IMF:ECOFIN_DSD(1.0)</nowiki></code><br> | ||
<code><nowiki>urn:sdmx:org.sdmx.infomodel.registry.ProvisionAgreement=WB:WDI_ENVIRONMENT_WB_WB(1.0)</nowiki></code> | <code><nowiki>urn:sdmx:org.sdmx.infomodel.registry.ProvisionAgreement=WB:WDI_ENVIRONMENT_WB_WB(1.0)</nowiki></code> | ||
| + | |||
| + | =Versioning Guidance= | ||
| + | SDMX does not mandate a versioning policy. Organisations maintaining their own structures are therefore free to choose how and when version numbers change. | ||
| + | |||
| + | There are two generally adopted approaches. | ||
| + | ====Keep all structures at version 1.0==== | ||
| + | A simple method is to keep all structures at version 1.0. Changes are made as required but users of structures like DSDs may be surprised to find components have been added or removed unless other metadata governance procedures are in place. | ||
| + | |||
| + | ====Change | ||
Revision as of 04:36, 20 January 2021
Overview
All Maintainable structures have a mandatory version number of the form 1.0, 1.1, 2.3.
The version number defaults to 1.0.
The combination of the structure type, Agency ID, structure ID and version are used to uniquely identify any Maintainable structure using its URN.
Examples of URNs illustrating the use of version numbers:
urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_TIME_PER_COLLECT(1.11)
urn:sdmx:org.sdmx.infomodel.conceptscheme.Concept=IMF:ECOFIN_CONCEPTS(2.0).INDICATOR
urn:sdmx:org.sdmx.infomodel.datastructure.DataStructure=IMF:ECOFIN_DSD(1.0)
urn:sdmx:org.sdmx.infomodel.registry.ProvisionAgreement=WB:WDI_ENVIRONMENT_WB_WB(1.0)
Versioning Guidance
SDMX does not mandate a versioning policy. Organisations maintaining their own structures are therefore free to choose how and when version numbers change.
There are two generally adopted approaches.
Keep all structures at version 1.0
A simple method is to keep all structures at version 1.0. Changes are made as required but users of structures like DSDs may be surprised to find components have been added or removed unless other metadata governance procedures are in place.
====Change
