Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -26,7 +26,7 @@ 26 26 27 27 Standard formats for the exchange of aggregated statistical data and metadata as prescribed in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] v3.0 are envisaged to bring benefits to the statistical community because data reporting and dissemination processes can be made more efficient. 28 28 29 -As organisations migrate to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML, JSON (and conventional) [[artefacts>>doc:Glossary.Artefact.WebHome]] will be produced (e.g., Data Structure, Metadata Structure, [[Code List>>doc:Glossary.Code list.WebHome]] and (% style="color:# 2ecc71" %)Concept(%%) definitions – often collectively called [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] – XML schemas generated from [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these [[artefacts>>doc:Glossary.Artefact.WebHome]] between parties in a controlled and organized way.29 +As organisations migrate to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] enabled systems, many XML, JSON (and conventional) [[artefacts>>doc:Glossary.Artefact.WebHome]] will be produced (e.g., Data Structure, Metadata Structure, [[Code List>>doc:Glossary.Code list.WebHome]] and (% style="color:#e74c3c" %)Concept(%%) definitions – often collectively called [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] – XML schemas generated from [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], XSLT stylesheets for transformation and display of data and metadata, terminology references, etc.). The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] model supports interoperability, and it is important to be able to discover and share these [[artefacts>>doc:Glossary.Artefact.WebHome]] between parties in a controlled and organized way. 30 30 31 31 This is the role of the registry. 32 32 ... ... @@ -141,7 +141,7 @@ 141 141 * Registration of data and metadata sources 142 142 * [[Subscription>>doc:Glossary.Subscription.WebHome]] and [[Notification>>doc:Glossary.Notification.WebHome]] 143 143 144 -As of the initial (% style="color:# 2ecc71" %)version(%%) of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 no messages are defined to support these [[artefacts>>doc:Glossary.Artefact.WebHome]]; hence, users may need to use [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Registry Interface messages, instead.144 +As of the initial (% style="color:#e74c3c" %)version(%%) of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 no messages are defined to support these [[artefacts>>doc:Glossary.Artefact.WebHome]]; hence, users may need to use [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 2.1 Registry Interface messages, instead. 145 145 146 146 == {{id name="_Toc93842"/}}4.3 Provisioning Metadata Repository == 147 147 ... ... @@ -184,7 +184,7 @@ 184 184 185 185 === {{id name="_Toc93847"/}}5.2.2 Structure Submission Service === 186 186 187 -The registry must support a mechanism for submitting [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-rest). In order for the architecture to be scalable, the finest-grained piece of [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] that can be processed by the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact, with the exception of [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], where changes at an Item (% style="color:# 2ecc71" %)level(%%) is also possible (see next section on the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]]).187 +The registry must support a mechanism for submitting [[structural metadata>>doc:Glossary.Structural metadata.WebHome]]. This mechanism can be the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST interface for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] (this is defined in the corresponding GitHub project, dedicated to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] REST API: [[__https:~~/~~/github.com/__>>https://https:github.comsdmx-twgsdmx-rest]][[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-twg/[[sdmx>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-rest). In order for the architecture to be scalable, the finest-grained piece of [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] that can be processed by the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR is a MaintainableArtefact, with the exception of [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], where changes at an Item (% style="color:#e74c3c" %)level(%%) is also possible (see next section on the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]]). 188 188 189 189 === {{id name="_Toc93848"/}}5.2.3 Structure Query Service === 190 190 ... ... @@ -198,18 +198,18 @@ 198 198 * [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]] and [[metadata structure definitions>>doc:Glossary.Metadata structure definition.WebHome]] 199 199 * [[code>>doc:Glossary.Code.WebHome]] lists 200 200 * value lists 201 -* (% style="color:# 2ecc71" %)concept(%%) schemes201 +* (% style="color:#e74c3c" %)concept(%%) schemes 202 202 * reporting taxonomies 203 203 * [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] and metadata [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] 204 204 * structure maps 205 205 * [[representation>>doc:Glossary.Representation.WebHome]] map 206 206 * organisation scheme map 207 -* (% style="color:# 2ecc71" %)concept(%%) scheme map207 +* (% style="color:#e74c3c" %)concept(%%) scheme map 208 208 * [[category>>doc:Glossary.Category.WebHome]] scheme map 209 209 * reporting taxonomy map 210 210 * processes 211 211 * hierarchies 212 -* (% style="color:# 2ecc71" %)constraints212 +* (% style="color:#e74c3c" %)constraints 213 213 * [[category>>doc:Glossary.Category.WebHome]] schemes 214 214 * categorisations and categorised objects (examples are categorised [[data flows>>doc:Glossary.Dataflow.WebHome]] and [[metadata flows>>doc:Glossary.Metadataflow.WebHome]], [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], [[metadata structure definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[provision agreements>>doc:Glossary.Provision agreement.WebHome]] registered [[data sources>>doc:Glossary.Data source.WebHome]] and metadata sources) 215 215 * organisation schemes ([[agency scheme>>doc:Glossary.Agency scheme.WebHome]], [[data provider scheme>>doc:Glossary.Data provider scheme.WebHome]], [[data consumer scheme>>doc:Glossary.Data consumer scheme.WebHome]], organisation unit scheme) ... ... @@ -232,17 +232,17 @@ 232 232 * QueryRegistrationRequest 233 233 * QueryRegistrationResponse 234 234 235 -The Data and Metadata Registration Service allows [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and webaccessible databases containing published data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:Glossary.Data set.WebHome]] or metadatasets, and MAY extract a concise [[representation>>doc:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:# 2ecc71" %)concept(%%) values (e.g., values of the data [[attribute>>doc:Glossary.Attribute.WebHome]], [[dimension>>doc:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#2ecc71" %)Constraints(%%) in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-IM.235 +The Data and Metadata Registration Service allows [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] conformant files and webaccessible databases containing published data and [[reference metadata>>doc:Glossary.Reference metadata.WebHome]] to be registered in the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]. The registration process MAY validate the content of the [[datasets>>doc:Glossary.Data set.WebHome]] or metadatasets, and MAY extract a concise [[representation>>doc:Glossary.Representation.WebHome]] of the contents in terms of (% style="color:#e74c3c" %)concept(%%) values (e.g., values of the data [[attribute>>doc:Glossary.Attribute.WebHome]], [[dimension>>doc:Glossary.Dimension.WebHome]], metadata [[attribute>>doc:Glossary.Attribute.WebHome]]), or entire keys, and storing this as a record in the registry to enable discovery of the original [[dataset>>doc:Glossary.Data set.WebHome]] or metadata-set. These are called (% style="color:#e74c3c" %)Constraints(%%) in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-IM. 236 236 237 237 The Data and Metadata Registration Service MAY validate the following, subject to the access control mechanism implemented in the Registry: 238 238 239 239 * that the data/metadata provider is allowed to register the [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset; 240 -* that the content of the [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:# 2ecc71" %)constraints(%%). This is dependent upon such (% style="color:#2ecc71" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]];240 +* that the content of the [[dataset>>doc:Glossary.Data set.WebHome]] or metadataset meets the validation (% style="color:#e74c3c" %)constraints(%%). This is dependent upon such (% style="color:#e74c3c" %)constraints(%%) being defined in the structural repository and which reference the relevant [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]; 241 241 * that a queryable [[data source>>doc:Glossary.Data source.WebHome]] exists – this would necessitate the registration service querying the service to determine its existence; 242 242 * that a simple [[data source>>doc:Glossary.Data source.WebHome]] exists (i.e., a file accessible at a URL); 243 243 * that the correct [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]] is used by the registered data; 244 244 * that the [[components>>doc:Glossary.Component.WebHome]] ([[Dimensions>>doc:Glossary.Dimension.WebHome]], [[Attributes>>doc:Glossary.Attribute.WebHome]], [[Measures>>doc:Glossary.Measure.WebHome]], Metadata [[Attributes>>doc:Glossary.Attribute.WebHome]], etc.) are consistent with the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]; 245 -* that the valid [[representations>>doc:Glossary.Representation.WebHome]] of the (% style="color:# 2ecc71" %)concepts(%%) to which these [[components>>doc:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]. The Registration has an action [[attribute>>doc:Glossary.Attribute.WebHome]] which takes one of the following values:245 +* that the valid [[representations>>doc:Glossary.Representation.WebHome]] of the (% style="color:#e74c3c" %)concepts(%%) to which these [[components>>doc:Glossary.Component.WebHome]] correspond conform to the definition in the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]. The Registration has an action [[attribute>>doc:Glossary.Attribute.WebHome]] which takes one of the following values: 246 246 247 247 (% style="width:755.294px" %) 248 248 |(% style="width:187px" %)**Action Attribute Value**|(% style="width:566px" %)**Behaviour** ... ... @@ -280,7 +280,7 @@ 280 280 281 281 [[Subscription>>doc:Glossary.Subscription.WebHome]] management involves a user submitting a [[subscription>>doc:Glossary.Subscription.WebHome]] request which contains: 282 282 283 -* a query or (% style="color:# 2ecc71" %)constraint(%%) expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific [[dataflow>>doc:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]).283 +* a query or (% style="color:#e74c3c" %)constraint(%%) expression in terms of a filter which defines the events for which the user is interested (e.g., new data for a specific [[dataflow>>doc:Glossary.Dataflow.WebHome]], or for a domain [[category>>doc:Glossary.Category.WebHome]], or changes to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]). 284 284 * a list of URIs or endpoints to which an XML [[notification>>doc:Glossary.Notification.WebHome]] message can be sent. Supported endpoint types will be email (mailto~: ) and HTTP POST (a normal http:~/~/ address); 285 285 * request for a list of submitted subscriptions; 286 286 * deletion of a [[subscription>>doc:Glossary.Subscription.WebHome]]; ... ... @@ -289,24 +289,22 @@ 289 289 290 290 === {{id name="_Toc93852"/}}5.2.7 Registry Behaviour === 291 291 292 -The following table defines the behaviour of the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:# 2ecc71" %)version(%%) of a Maintainable, unless semantic versioning is used.292 +The following table defines the behaviour of the [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] for the various Registry Interface messages. It should be noted, though, that as of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, an extended versioning scheme newly including semantic versioning is foreseen for all [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]. Moreover, while the old versioning scheme is allowed, given there is no more a "final" flag, there is no way guaranteeing the consistency across (% style="color:#e74c3c" %)version(%%) of a Maintainable, unless semantic versioning is used. 293 293 294 -Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:# 2ecc71" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#2ecc71" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#2ecc71" %)version(%%) of an [[Artefact>>doc:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules.294 +Given the above, the behaviour described in the following table concerns either draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] using semantic versioning or any [[Artefacts>>doc:Glossary.Artefact.WebHome]] using the old versioning scheme. Nevertheless, in the case of semantic versioning the registry must respect the versioning rules when performing the actions below. For example, it is not possible to replace a non-draft [[Artefact>>doc:Glossary.Artefact.WebHome]] that follows semantic versioning, unless a newer (% style="color:#e74c3c" %)version(%%) is introduced according to the semantic versioning rules. Furthermore, even when draft [[Artefacts>>doc:Glossary.Artefact.WebHome]] are submitted, the registry has to verify semantic versioning is respected against the previous non-draft (% style="color:#e74c3c" %)versions(%%). It is worth noting that the rules for semantic versioning and replacing or maintaining semantically versioned [[Artefacts>>doc:Glossary.Artefact.WebHome]] applies to externally shared [[Artefacts>>doc:Glossary.Artefact.WebHome]]. This means that any system may internally perform any change within a (% style="color:#e74c3c" %)version(%%) of an [[Artefact>>doc:Glossary.Artefact.WebHome]], until the latter is shared outside of that system or becomes public. Then (as also explained in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”) the [[Artefacts>>doc:Glossary.Artefact.WebHome]] must adhere to the Semantic Versioning rules. 295 295 296 296 (% style="width:757.294px" %) 297 297 |(% style="width:188px" %)**Interface**|(% style="width:542px" %)**Behaviour** 298 298 |(% style="width:188px" %)All|(% style="width:542px" %)((( 299 -1. If the action is set to “replace” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 300 -1. Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 301 -1. If the action is set to “delete” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 302 - 303 -a) Be a draft (% style="color:#2ecc71" %)version(%%). 304 -))) 305 -|(% style="width:188px" %) |(% style="width:542px" %)((( 299 +1) If the action is set to “replace” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is PUT or POSTed) then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted. 300 +2) Cross referenced structures MUST exist in either the submitted document (in Structures or Structure Location) or in the registry to which the request is submitted. 301 +3) If the action is set to “delete” (or a [[maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] is DELETEd) then the Registry MUST verify that the object can be deleted. In order to qualify for deletion, the object must: 302 +a) Be a draft (% style="color:#e74c3c" %)version(%%). 306 306 b) Not be explicitly{{footnote}}With semantic versioning, it is allowed to reference a range of artefacts, e.g., a DSD referencing a Codelist with version 1.2.3+ means all patch versions greater than 1.2.3. This means that deleting 1.2.4-draft does not break integrity of the aforementioned DSD.{{/footnote}} referenced from any other object in the Registry. 304 + 307 307 4) The semantic versioning rules in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] documentation MUST be obeyed. 308 308 ))) 309 -|(% style="width:188px" %)Structure submission|(% style="width:542px" %)Structures are submitted at the (% style="color:# 2ecc71" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#2ecc71" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]].307 +|(% style="width:188px" %)Structure submission|(% style="width:542px" %)Structures are submitted at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]] and the behaviour in “All” above is therefore at the (% style="color:#e74c3c" %)level(%%) of the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. 310 310 |(% style="width:188px" %)SubmitRegistrationRequest|(% style="width:542px" %)If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean [[attributes>>doc:Glossary.Attribute.WebHome]] set in the Registration. For a queryable datasource the Registry MAY validate that the source exists and can accept an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] data query. 311 311 312 312 = {{id name="_Toc93853"/}}6 Identification of SDMX Objects = ... ... @@ -317,7 +317,7 @@ 317 317 318 318 * //**IdentifiableArtefact**// – this gives an object the ability to be uniquely identified (see following section on identification), to have a user-defined URI, and to have multi-lingual annotations. 319 319 * //**NameableArtefact**// – this has all of the features of //IdentifiableArtefact// plus the ability to have a multi-lingual name and description. 320 -* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:# 2ecc71" %)version(%%) number, according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period.318 +* //**VersionableArtefact**// – this has all of the above features plus a (% style="color:#e74c3c" %)version(%%) number, according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning”, and a validity period. 321 321 * //**MaintainableArtefact**// – this has all of the above features, plus registry and structure URIs, and an association to the maintenance organisation of the object. 322 322 323 323 === {{id name="_Toc93855"/}}6.1.1 Identification, Naming, Versioning, and Maintenance Model === ... ... @@ -349,7 +349,7 @@ 349 349 |(% style="width:241px" %)Name in the form of InternationalString|(% style="width:156px" %)M|string|(% style="width:457px" %)This can have language specific variants. 350 350 |(% style="width:241px" %)Description in the form of InternationalString|(% style="width:156px" %)C|string|(% style="width:457px" %)This can have language specific variants. 351 351 |(% rowspan="4" %)//Versionable//|(% style="width:241px" %)All content as for //Identifiable// plus|(% style="width:156px" %) | |(% style="width:457px" %) 352 -|(% style="width:241px" %)(% style="color:# 2ecc71" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the (% style="color:#2ecc71" %)version(%%) number according to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules.350 +|(% style="width:241px" %)(% style="color:#e74c3c" %)version|(% style="width:156px" %)M|string|(% style="width:457px" %)This is the (% style="color:#e74c3c" %)version(%%) number according to [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules. 353 353 |(% style="width:241px" %)validFrom|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 354 354 |(% style="width:241px" %)validTo|(% style="width:156px" %)C|Date/time|(% style="width:457px" %) 355 355 |//Maintainable//|(% style="width:241px" %)All content as for //Versionable// plus|(% style="width:156px" %) | |(% style="width:457px" %) ... ... @@ -371,20 +371,20 @@ 371 371 372 372 **Figure 6: Agency Scheme Model** 373 373 374 -The Agency in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:# 2ecc71" %)level(%%) of this structure is maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#2ecc71" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#2ecc71" %)version(%%) ((% style="color:#2ecc71" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism.372 +The Agency in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is extremely important. The Agency Id system used in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is an nlevel structure. The top (% style="color:#e74c3c" %)level(%%) of this structure is maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]. Any Agency in this top (% style="color:#e74c3c" %)level(%%) can declare sub agencies and any sub agency can also declare sub agencies. The [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] has a fixed id and (% style="color:#e74c3c" %)version(%%) ((% style="color:#e74c3c" %)version(%%) ‘1.0’) and is never declared explicitly in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] object identification mechanism. 375 375 376 376 In order to achieve this [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] adopts the following rules: 377 377 378 378 * Agencies are maintained in an [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] (which is a sub class of Organisation Scheme). 379 379 * The agency of the [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] must also be declared in a (different) [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 380 -* The “top-(% style="color:# 2ecc71" %)level(%%)” agency is [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#2ecc71" %)level(%%)” [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]].381 -* Agencies registered in the top-(% style="color:# 2ecc71" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] and so on.382 -* The AgencyScheme has a fixed (% style="color:# 2ecc71" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:Glossary.Artefact.WebHome]] follow.378 +* The “top-(% style="color:#e74c3c" %)level(%%)” agency is [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] and maintains the “top-(% style="color:#e74c3c" %)level(%%)” [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 379 +* Agencies registered in the top-(% style="color:#e74c3c" %)level(%%) scheme can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. Agencies in these second-tier schemes can themselves maintain a single [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] and so on. 380 +* The AgencyScheme has a fixed (% style="color:#e74c3c" %)version(%%), i.e., ‘1.0’, hence it is an exception from the Semantic Versioning that other [[Artefacts>>doc:Glossary.Artefact.WebHome]] follow. 383 383 * There can be only one AgencyScheme maintained by any one Agency. It has a fixed id of AGENCIES. 384 384 * The /hierarchy of Organisation is not inherited by [[Maintenance Agency>>doc:Glossary.Maintenance agency.WebHome]] – thus each [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]] is a flat list of Maintenance Agencies. 385 -* The format of the agency identifier is agencyID.agencyID etc. The top-(% style="color:# 2ecc71" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:Glossary.Agency scheme.WebHome]].383 +* The format of the agency identifier is agencyID.agencyID etc. The top-(% style="color:#e74c3c" %)level(%%) agency in this identification mechanism is the agency registered in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[agency scheme>>doc:Glossary.Agency scheme.WebHome]]. 386 386 387 -In other words, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:# 2ecc71" %)level(%%) [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]].385 +In other words, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is not a part of the hierarchical ID structure for agencies. However, [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] is, itself, a [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] and is contained in the top-(% style="color:#e74c3c" %)level(%%) [[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]. 388 388 389 389 This supports a hierarchical structure of agencyID. 390 390 ... ... @@ -419,21 +419,22 @@ 419 419 420 420 ==== 6.2.2.1 Introduction ==== 421 421 422 -To provide interoperability between [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:Glossary.Component.WebHome]] in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:# 2ecc71" %)version(%%) etc.).420 +To provide interoperability between [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]]/Repositories in a distributed network environment, it is important to have a scheme for uniquely identifying (and thus accessing) all first-class (Identifiable) [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]] objects. Most of these unique identifiers are composite (containing [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]], or parent object identifiers), and there is a need to be able to construct a unique reference as a single string. This is achieved by having a globally unique identifier called a universal resource name (URN) which is generated from the actual identification [[components>>doc:Glossary.Component.WebHome]] in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR APIs. In other words, the URN for any [[Identifiable Artefact>>doc:Glossary.Identifiable artefact.WebHome]] is constructed from its [[component>>doc:Glossary.Component.WebHome]] identifiers (agency, id, (% style="color:#e74c3c" %)version(%%) etc.). 423 423 424 424 ==== 6.2.2.2 URN Structure ==== 425 425 426 -===== **//__Case Rules for URN__//** ===== 424 +(% class="wikigeneratedid" id="HCaseRulesforURN" %) 425 +**//__Case Rules for URN__//** 427 427 428 428 For the URN, all parts of the string are case sensitive. The generic structure of the URN is as follows: 429 429 430 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject- (% style="color:#2ecc71" %)version(%%)).*containerobject-id.object-id429 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobjectid(maintainedobject-version).*containerobject-id.object-id 431 431 432 432 ~* this can repeat and may not be present (see explanation below) 433 433 434 -Note that in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:# 2ecc71" %)version(%%) information that is allowed is for the maintainable object.433 +Note that in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] there are no concrete [[Versionable Artefacts>>doc:Glossary.Versionable artefact.WebHome]] that are not a [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. For this reason, the only (% style="color:#e74c3c" %)version(%%) information that is allowed is for the maintainable object. 435 435 436 -The [[Maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:# 2ecc71" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning.435 +The [[Maintenance agency>>doc:Glossary.Maintenance agency.WebHome]] identifier is separated from the [[maintainable artefact>>doc:Glossary.Maintainable artefact.WebHome]] identifier by a colon ‘:’. All other identifiers in the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] URN syntax are separated by a period ‘.’. The (% style="color:#e74c3c" %)version(%%) information is encapsulated in parentheses ‘()’ and adheres to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, as explained in [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards Section 6 “Technical Notes”, paragraph “4.3 Versioning. 437 437 438 438 ==== 6.2.2.3 Explanation of the generic structure ==== 439 439 ... ... @@ -458,61 +458,63 @@ 458 458 459 459 **maintainable-object-id** is the identifier of the maintainable object. This will always be present as all identifiable objects are either a maintainable object or contained in a maintainable object. 460 460 461 -**maintainable-object- (% style="color:#2ecc71" %)version(%%)** is the (% style="color:#2ecc71" %)version(%%), according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present.460 +**maintainable-object-version** is the (% style="color:#e74c3c" %)version(%%), according to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] versioning rules, of the maintainable object and is enclosed in parentheses ‘()’, which are always present. 462 462 463 -**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:Glossary.Code.WebHome]] is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:# 2ecc71" %)level(%%) in its [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure.462 +**container-object-id** is the identifier of an intermediary object that contains the actual object which the URN is identifying. It is not mandatory as many actual objects do not have an intermediary container object. For instance, a [[Code>>doc:Glossary.Code.WebHome]] is in a maintained object (Codelist) and has no intermediary container object, whereas a MetadataAttribute has an intermediary container object (MetadataAttributeDescriptor) and may have an intermediary container object, which is its parent MetadataAttribute. For this reason, the container object id may repeat, with each repetition identifying the object at the next-lower (% style="color:#e74c3c" %)level(%%) in its [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]. Note that if there is only a single containing object in the model then it is NOT included in the URN structure. This applies to AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor where there can be only one such object and this object has a fixed id. Therefore, whilst each of these has a URN, the id of the AttributeDescriptor, DimensionDescriptor, and MeasureDescriptor is not included when the actual object is a DataAttribute or a Dimension/ TimeDimension, or a Measure. 464 464 465 -Note that although a [[Code>>doc:Glossary.Code.WebHome]] can have a parent [[Code>>doc:Glossary.Code.WebHome]] and a (% style="color:# 2ecc71" %)Concept(%%) can have a parent (% style="color:#2ecc71" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id.464 +Note that although a [[Code>>doc:Glossary.Code.WebHome]] can have a parent [[Code>>doc:Glossary.Code.WebHome]] and a (% style="color:#e74c3c" %)Concept(%%) can have a parent (% style="color:#e74c3c" %)Concept(%%) these are maintained in a flat structure and therefore do not have a containerobject-id. 466 466 467 -For example, the sequence is agency:DSDid( (% style="color:#2ecc71" %)version(%%)).DimensionId and not agency:DSDid((% style="color:#2ecc71" %)version(%%)).DimensionDescriptorId.DimensionId.466 +For example, the sequence is agency:DSDid(version).DimensionId and not agency:DSDid(version).DimensionDescriptorId.DimensionId. 468 468 469 469 object-id is the identifier of the actual object unless the actual object is a //Maintainable// object. If present it is always the last id and is not followed by any other character. 470 470 471 -===== //__**Generic Examples of the URN Structure**__// ===== 470 +(% class="wikigeneratedid" id="HGenericExamplesoftheURNStructure" %) 471 +//__**Generic Examples of the URN Structure**__// 472 472 473 473 __Actual object is a maintainable__ 474 474 475 -SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid( (% style="color:#2ecc71" %)version(%%))475 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid(version) 476 476 477 477 __Actual object is contained in a maintained object with no intermediate containing object__ 478 478 479 -SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid( (% style="color:#2ecc71" %)version(%%)).object-id479 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid(version).object-id 480 480 481 481 __Actual object is contained in a maintained object with an intermediate containing object__ 482 482 483 -SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid( (% style="color:#2ecc71" %)version(%%)).contained-object-id.object-id483 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 484 484 485 485 __Actual object is contained in a maintained object with no intermediate containing__ __object but__ __the object type itself is hierarchical__ 486 486 487 487 In this case the object id may not be unique in itself but only within the context of the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]]. In the general syntax of the URN all intermediary objects in the structure (with the exception, of course, of the maintained object) are shown as a contained object. An example here would be a [[Category>>doc:Glossary.Category.WebHome]] in a CategoryScheme. The [[Category>>doc:Glossary.Category.WebHome]] is hierarchical, and all intermediate [[Categories>>doc:Glossary.Category.WebHome]] are shown as a contained object. The example below shows the generic structure for CategoryScheme/ [[Category>>doc:Glossary.Category.WebHome]]/ [[Category>>doc:Glossary.Category.WebHome]]. 488 488 489 -SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid( (% style="color:#2ecc71" %)version(%%)).contained-object-id.object-id489 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.object-id 490 490 491 491 Actual object is contained in a maintained object with an intermediate containing object and the object type itself is hierarchical 492 492 493 493 In this case the generic syntax is the same as for the example above as the parent object is regarded as a containing object, even if it is of the same type. An example here is a MetadataAttribute where the contained objects are MetadataAttributeDescriptor (first contained object id) and MetadataAttribute (subsequent contained object ids). The example below shows the generic structure for [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]/ MetadataAttributeDescriptor/ MetadataAttribute/ MetadataAttribute 494 494 495 -SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid( (% style="color:#2ecc71" %)version(%%)).contained-object-id.contained-object-id contained-objectid.object-id495 +SDMXPrefix.[[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]-package-name.classname=agencyid:maintained-objectid(version).contained-object-id.contained-object-id contained-objectid.object-id 496 496 497 -===== //__**Concrete Examples of the URN Structure**__// ===== 497 +(% class="wikigeneratedid" id="HConcreteExamplesoftheURNStructure" %) 498 +//__**Concrete Examples of the URN Structure**__// 498 498 499 -The [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:# 2ecc71" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN:500 +The [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] CRED_EXT_DEBT of legacy (% style="color:#e74c3c" %)version(%%) 2.1 maintained by the toplevel Agency TFFS would have the URN: 500 500 501 501 urn:sdmx:org.sdmx.infomodel.datastructure.DataStucture=TFFS:CRED_EXT_ DEBT(2.1) 502 502 503 -The URN for a [[code>>doc:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:# 2ecc71" %)version(%%) 1.0.0 would be:504 +The URN for a [[code>>doc:Glossary.Code.WebHome]] for Argentina maintained by ISO in the [[code list>>doc:Glossary.Code list.WebHome]] CL_3166A2 of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be: 504 504 505 505 urn:sdmx:org.sdmx.infomodel.codelist.Code=ISO:CL_3166A2(1.0.0).AR 506 506 507 -The URN for a [[category>>doc:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:# 2ecc71" %)version(%%) 1.0.0draft would be:508 +The URN for a [[category>>doc:Glossary.Category.WebHome]] (id of 1) which has parent [[category>>doc:Glossary.Category.WebHome]] (id of 2) maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[category scheme>>doc:Glossary.Category scheme.WebHome]] SUBJECT_MATTER_DOMAINS of the semantic extended (% style="color:#e74c3c" %)version(%%) 1.0.0draft would be: 508 508 509 509 urn:sdmx:org.sdmx.infomodel.categoryscheme.Category=SDMX:SUBJECT_MATT ER_DOMAINS(1.0.0-draft).1.2 510 510 511 -The URN for a Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:# 2ecc71" %)version(%%) 1.0.0 where the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be:512 +The URN for a Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] maintained by [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] in the [[MSD>>doc:Glossary.Metadata structure definition.WebHome]] CONTACT_METADATA of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 where the [[hierarchy>>doc:Glossary.Hierarchy.WebHome]] of the Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] is CONTACT_DETAILS/CONTACT_NAME would be: 512 512 513 513 urn:sdmx:org.sdmx.infomodel.metadatastructure.MetadataAttribute=SDMX: CONTACT_METADATA(1.0.0).CONTACT_DETAILS.CONTACT_NAME 514 514 515 -The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:# 2ecc71" %)version(%%) 1.0.0 would be:516 +The TFFS defines ABC as a sub-Agency of TFFS then the URN of a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] maintained by ABC and identified as EXTERNAL_DEBT of semantic (% style="color:#e74c3c" %)version(%%) 1.0.0 would be: 516 516 517 517 urn:sdmx:org.sdmx.infomodel.datastructure.Dataflow=TFFS.ABC:EXTERNAL_ DEBT(1.0.0) 518 518 ... ... @@ -519,7 +519,7 @@ 519 519 The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST support this globally unique identification scheme. The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to create the URN from the individual identification [[attributes>>doc:Glossary.Attribute.WebHome]] submitted and to transform the URN to these identification [[attributes>>doc:Glossary.Attribute.WebHome]]. The identification [[attributes>>doc:Glossary.Attribute.WebHome]] are: 520 520 521 521 * **Identifiable and [[Nameable Artefacts>>doc:Glossary.Nameable artefact.WebHome]]**: id (in some cases this id may be hierarchic) 522 -* **[[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:# 2ecc71" %)version(%%), agencyId523 +* **[[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]**: id, (% style="color:#e74c3c" %)version(%%), agencyId 523 523 524 524 The [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-RR MUST be able to resolve the unique identifier of an [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:Glossary.Artefact.WebHome]] and to produce an [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] rendering of that [[artefact>>doc:Glossary.Artefact.WebHome]] if it is located in the Registry. 525 525 ... ... @@ -725,7 +725,7 @@ 725 725 726 726 === {{id name="_Toc93863"/}}7.1.1 Introduction === 727 727 728 -The [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], [[code lists>>doc:Glossary.Code list.WebHome]], (% style="color:# 2ecc71" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:Glossary.Concept scheme.WebHome]], etc.)729 +The [[SDMX Registry>>doc:Glossary.SDMX Registry.WebHome]] must have the ability to support agencies in their role of defining and disseminating [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] [[artefacts>>doc:Glossary.Artefact.WebHome]]. These [[artefacts>>doc:Glossary.Artefact.WebHome]] include [[data structure definitions>>doc:Glossary.Data structure definition.WebHome]], [[code lists>>doc:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) etc. and are fully defined in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. An authenticated agency may submit valid [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] definitions which must be stored in the registry. Note that the term “[[structural metadata>>doc:Glossary.Structural metadata.WebHome]]” refers as a general term to all structural [[components>>doc:Glossary.Component.WebHome]] ([[Data Structure Definitions>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definitions>>doc:Glossary.Metadata structure definition.WebHome]], [[Code Lists>>doc:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:Glossary.Concept scheme.WebHome]], etc.) 729 729 730 730 At a minimum, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] definitions may be submitted to and queried from the registry via an HTTP/HTTPS POST in the form of one of the [[SDMX-ML>>doc:Glossary.SDMX-ML.WebHome]] messages for [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] and the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] RESTful API for structure queries. The message may contain all [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items for the whole registry, [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items for one [[maintenance agency>>doc:Glossary.Maintenance agency.WebHome]], or individual [[structural metadata>>doc:Glossary.Structural metadata.WebHome]] items. 731 731 ... ... @@ -735,7 +735,7 @@ 735 735 * may only be deleted by the agency which created them; 736 736 * may not be deleted if they are referenced from other constructs in the Registry. 737 737 738 -The (% style="color:# 2ecc71" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#2ecc71" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items.739 +The (% style="color:#e74c3c" %)level(%%) of granularity for the maintenance of [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] [[Structural Metadata>>doc:Glossary.Structural metadata.WebHome]] objects in the registry is the [[Maintainable Artefact>>doc:Glossary.Maintainable artefact.WebHome]]. Especially for [[Item Schemes>>doc:Glossary.Item scheme.WebHome]], though, partial maintenance may be performed, i.e., at the (% style="color:#e74c3c" %)level(%%) of the Item, by submitting an [[Item Scheme>>doc:Glossary.Item scheme.WebHome]] with the 'isPartial' flag set and a reduced set of Items. 739 739 740 740 The following table lists the [[Maintainable Artefacts>>doc:Glossary.Maintainable artefact.WebHome]]. 741 741 ... ... @@ -743,7 +743,7 @@ 743 743 |(% colspan="2" style="width:522px" %)**Maintainable Artefacts**|(% style="width:490px" %)**Content** 744 744 |(% style="width:198px" %)**Abstract Class**|(% style="width:324px" %)**Concrete Class**|(% style="width:490px" %) 745 745 |(% style="width:198px" %)[[Item Scheme>>doc:Glossary.Item scheme.WebHome]]|(% style="width:324px" %)Codelist|(% style="width:490px" %)[[Code>>doc:Glossary.Code.WebHome]] 746 -|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]]|(% style="width:490px" %)(% style="color:# 2ecc71" %)Concept747 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]]|(% style="width:490px" %)(% style="color:#e74c3c" %)Concept 747 747 |(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:Glossary.Category scheme.WebHome]]|(% style="width:490px" %)[[Category>>doc:Glossary.Category.WebHome]] 748 748 |(% style="width:198px" %) |(% style="width:324px" %)[[Organisation Unit Scheme>>doc:Glossary.Organisation unit scheme.WebHome]]|(% style="width:490px" %)Organisation Unit 749 749 |(% style="width:198px" %) |(% style="width:324px" %)[[Agency Scheme>>doc:Glossary.Agency scheme.WebHome]]|(% style="width:490px" %)Agency ... ... @@ -754,7 +754,7 @@ 754 754 |(% style="width:198px" %) |(% style="width:324px" %)Transformation Scheme|(% style="width:490px" %)Transformation 755 755 |(% style="width:198px" %) |(% style="width:324px" %)Custom Type Scheme|(% style="width:490px" %)Custom Type 756 756 |(% style="width:198px" %) |(% style="width:324px" %)Name Personalisation Scheme|(% style="width:490px" %)Name Personalisation 757 -|(% style="width:198px" %) |(% style="width:324px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:490px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] (% style="color:# 2ecc71" %)Concept(%%) Mapping758 +|(% style="width:198px" %) |(% style="width:324px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Mapping Scheme|(% style="width:490px" %)[[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] Codelist Mapping [[Vtl>>doc:Glossary.Validation and transformation language.WebHome]] (% style="color:#e74c3c" %)Concept(%%) Mapping 758 758 |(% style="width:198px" %) |(% style="width:324px" %)Ruleset Scheme|(% style="width:490px" %)Ruleset 759 759 |(% style="width:198px" %) |(% style="width:324px" %)User Defined Operator Scheme|(% style="width:490px" %)User Defined Operator 760 760 |(% style="width:198px" %)Enumerated List|(% style="width:324px" %)ValueList|(% style="width:490px" %)Value Item ... ... @@ -772,16 +772,16 @@ 772 772 |(% style="width:198px" %)Structure Usage|(% style="width:324px" %)[[Dataflow>>doc:Glossary.Dataflow.WebHome]]|(% style="width:490px" %) 773 773 |(% style="width:198px" %) |(% style="width:324px" %)[[Metadataflow>>doc:Glossary.Metadataflow.WebHome]]|(% style="width:490px" %) 774 774 |(% style="width:198px" %)None|(% style="width:324px" %)Process|(% style="width:490px" %)Process Step 775 -|(% style="width:198px" %)None|(% style="width:324px" %)Structure (% style="color:# 2ecc71" %)Map|(% style="width:490px" %)(((776 -[[Component>>doc:Glossary.Component.WebHome]] (% style="color:# 2ecc71" %)Map(%%)777 -Epoch (% style="color:# 2ecc71" %)Map(%%)778 -Date Pattern (% style="color:# 2ecc71" %)Map776 +|(% style="width:198px" %)None|(% style="width:324px" %)Structure (% style="color:#e74c3c" %)Map|(% style="width:490px" %)((( 777 +[[Component>>doc:Glossary.Component.WebHome]] (% style="color:#e74c3c" %)Map(%%) 778 +Epoch (% style="color:#e74c3c" %)Map(%%) 779 +Date Pattern (% style="color:#e74c3c" %)Map 779 779 ))) 780 -|(% style="width:198px" %)None|(% style="width:324px" %)[[Representation>>doc:Glossary.Representation.WebHome]] (% style="color:# 2ecc71" %)Map|(% style="width:490px" %)[[Representation>>doc:Glossary.Representation.WebHome]] Mapping781 -|(% style="width:198px" %)[[Item Scheme>>doc:Glossary.Item scheme.WebHome]] (% style="color:# 2ecc71" %)Map|(% style="width:324px" %)Organisation Scheme (% style="color:#2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map782 -|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]] (% style="color:# 2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map783 -|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:Glossary.Category scheme.WebHome]] (% style="color:# 2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map784 -|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy (% style="color:# 2ecc71" %)Map|(% style="width:490px" %)Item (% style="color:#2ecc71" %)Map781 +|(% style="width:198px" %)None|(% style="width:324px" %)[[Representation>>doc:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)[[Representation>>doc:Glossary.Representation.WebHome]] Mapping 782 +|(% style="width:198px" %)[[Item Scheme>>doc:Glossary.Item scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:324px" %)Organisation Scheme (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 783 +|(% style="width:198px" %) |(% style="width:324px" %)[[Concept Scheme>>doc:Glossary.Concept scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 784 +|(% style="width:198px" %) |(% style="width:324px" %)[[Category Scheme>>doc:Glossary.Category scheme.WebHome]] (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 785 +|(% style="width:198px" %) |(% style="width:324px" %)Reporting Taxonomy (% style="color:#e74c3c" %)Map|(% style="width:490px" %)Item (% style="color:#e74c3c" %)Map 785 785 |(% style="width:198px" %)None|(% style="width:324px" %)[[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 786 786 |(% style="width:198px" %)None|(% style="width:324px" %)Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]]|(% style="width:490px" %) 787 787 |(% style="width:198px" %)None|(% style="width:324px" %)[[Hierarchy>>doc:Glossary.Hierarchy.WebHome]]|(% style="width:490px" %)Hierarchical [[Code>>doc:Glossary.Code.WebHome]] ... ... @@ -831,7 +831,7 @@ 831 831 832 832 === {{id name="_Toc93867"/}}7.2.1 Provisioning Agreement: Basic concepts === 833 833 834 -Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service (% style="color:# 2ecc71" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring.835 +Data/Metadata provisioning defines a framework in which the provision of different types of statistical data and metadata by various data/metadata providers can be specified and controlled. This framework is the basis on which the existence of data can be made known to the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]]-enabled community and hence the basis on which data can subsequently be discovered. Such a framework can be used to regulate the data content to facilitate the building of intelligent applications. It can also be used to facilitate the processing implied by service (% style="color:#e74c3c" %)level(%%) agreements, or other provisioning agreements in those scenarios that are based on legal directives. Additionally, quality and [[timeliness>>doc:Glossary.Timeliness.WebHome]] metadata can be supported by this framework which makes it practical to implement information supply chain monitoring. 835 835 836 836 Note that the term “data provisioning” here includes both the provisioning of data and metadata. 837 837 ... ... @@ -863,17 +863,17 @@ 863 863 864 864 === {{id name="_Toc93870"/}}7.3.1 Data and Metadata Constraints: Basic Concepts === 865 865 866 -(% style="color:# 2ecc71" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#2ecc71" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:Glossary.Data set.WebHome]] or [[metadata set>>doc:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#2ecc71" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:Glossary.Code.WebHome]] values) of a specific [[component>>doc:Glossary.Component.WebHome]] such as a [[dimension>>doc:Glossary.Dimension.WebHome]] or [[attribute>>doc:Glossary.Attribute.WebHome]].867 +(% style="color:#e74c3c" %)Constraints(%%) are, effectively, lists of the valid or actual content of data and metadata. (% style="color:#e74c3c" %)Constraints(%%) can be used to specify a subset of the theoretical content of [[data set>>doc:Glossary.Data set.WebHome]] or [[metadata set>>doc:Glossary.Metadata set.WebHome]] which can be derived from the specification of the [[DSD>>doc:Glossary.Data structure definition.WebHome]] or [[MSD>>doc:Glossary.Metadata structure definition.WebHome]]. A (% style="color:#e74c3c" %)Constraint(%%) can comprise a list of keys or a list of content (usually [[code>>doc:Glossary.Code.WebHome]] values) of a specific [[component>>doc:Glossary.Component.WebHome]] such as a [[dimension>>doc:Glossary.Dimension.WebHome]] or [[attribute>>doc:Glossary.Attribute.WebHome]]. 867 867 868 -(% style="color:# 2ecc71" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:Glossary.Attribute.WebHome]] values that are contained in a [[data source>>doc:Glossary.Data source.WebHome]], or is to be provided for a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] (e.g., the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:Glossary.Dimension.WebHome]]) is often more than is actually present in any specific [[data source>>doc:Glossary.Data source.WebHome]], or more than is intended to be supplied according to a specific [[Dataflow>>doc:Glossary.Dataflow.WebHome]].869 +(% style="color:#e74c3c" %)Constraints(%%) comprise the specification of subsets of key or [[attribute>>doc:Glossary.Attribute.WebHome]] values that are contained in a [[data source>>doc:Glossary.Data source.WebHome]], or is to be provided for a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] or [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], or directly attached to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] or [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]]. This is important metadata because, for example, the full range of possibilities which is implied by the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] (e.g., the complete set of valid keys is the Cartesian product of all the values in the [[code lists>>doc:Glossary.Code list.WebHome]] for each of the [[Dimensions>>doc:Glossary.Dimension.WebHome]]) is often more than is actually present in any specific [[data source>>doc:Glossary.Data source.WebHome]], or more than is intended to be supplied according to a specific [[Dataflow>>doc:Glossary.Dataflow.WebHome]]. 869 869 870 -Often a [[Data Provider>>doc:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:Glossary.Data source.WebHome]] (at the (% style="color:# 2ecc71" %)level(%%) of the [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a (% style="color:#2ecc71" %)Constraint(%%). The (% style="color:#2ecc71" %)Constraint(%%) is also used to define a [[code list>>doc:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:Glossary.Code list.WebHome]].871 +Often a [[Data Provider>>doc:Glossary.Data provider.WebHome]] will not be able to provide data for all key combinations, either because the combination itself is not meaningful, or simply because the provider does not have the data for that combination. In this case the [[Data Provider>>doc:Glossary.Data provider.WebHome]] could constrain the [[data source>>doc:Glossary.Data source.WebHome]] (at the (% style="color:#e74c3c" %)level(%%) of the [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]] or the [[Data Provider>>doc:Glossary.Data provider.WebHome]]) by supplying metadata that defines the key combinations or cube regions that are available. This is done by means of a (% style="color:#e74c3c" %)Constraint(%%). The (% style="color:#e74c3c" %)Constraint(%%) is also used to define a [[code list>>doc:Glossary.Code list.WebHome]] subset which is used to populate a partial [[code list>>doc:Glossary.Code list.WebHome]]. 871 871 872 872 Furthermore, it is often useful to define subsets or views of the [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]] which restrict values in some [[code lists>>doc:Glossary.Code list.WebHome]], especially where many such subsets restrict the same [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. Such a view is called a [[Dataflow>>doc:Glossary.Dataflow.WebHome]], and there can be one or more defined for any [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]. 873 873 874 874 Whenever data is published or made available by a [[Data Provider>>doc:Glossary.Data provider.WebHome]], it must conform to a [[Dataflow>>doc:Glossary.Dataflow.WebHome]] (and hence to a [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]]). The [[Dataflow>>doc:Glossary.Dataflow.WebHome]] is thus a means of enabling content based processing. 875 875 876 -In addition, (% style="color:# 2ecc71" %)Constraints(%%) can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:Glossary.Dimension.WebHome]] [[codes>>doc:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to guide the user to select only those [[Dimension>>doc:Glossary.Dimension.WebHome]] [[code>>doc:Glossary.Code.WebHome]] values that will return data based on the [[Dimension>>doc:Glossary.Dimension.WebHome]] values already selected).877 +In addition, (% style="color:#e74c3c" %)Constraints(%%) can be extremely useful in a data visualisation system, such as dissemination of statistics on a website. In such a system a Cube Region can be used to specify the [[Dimension>>doc:Glossary.Dimension.WebHome]] [[codes>>doc:Glossary.Code.WebHome]] that actually exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to build relevant selection tables), and the Key Set can be used to specify the keys that exist in a [[data source>>doc:Glossary.Data source.WebHome]] (these can be used to guide the user to select only those [[Dimension>>doc:Glossary.Dimension.WebHome]] [[code>>doc:Glossary.Code.WebHome]] values that will return data based on the [[Dimension>>doc:Glossary.Dimension.WebHome]] values already selected). 877 877 878 878 === {{id name="_Toc93871"/}}7.3.2 Data and Metadata Constraints: Schematic === 879 879 ... ... @@ -889,9 +889,9 @@ 889 889 890 890 Logical class diagram showing inheritance between and reference to constrainable artefacts 891 891 892 -The class diagram above shows that [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], Simple Datasource and REST Datasource (via the abstract Query Datasource) are all concrete sub-classes of Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] and can therefore have (% style="color:# 2ecc71" %)Constraints(%%) specified. Note that the actual (% style="color:#2ecc71" %)Constraint(%%) as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the (% style="color:#2ecc71" %)Constraint(%%) applies.893 +The class diagram above shows that [[Data Provider>>doc:Glossary.Data provider.WebHome]], Metadata Provider, [[Dataflow>>doc:Glossary.Dataflow.WebHome]], [[Metadataflow>>doc:Glossary.Metadataflow.WebHome]], [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], Metadata [[Provision Agreement>>doc:Glossary.Provision agreement.WebHome]], [[Data Structure Definition>>doc:Glossary.Data structure definition.WebHome]], [[Metadata Structure Definition>>doc:Glossary.Metadata structure definition.WebHome]], Simple Datasource and REST Datasource (via the abstract Query Datasource) are all concrete sub-classes of Constrainable [[Artefact>>doc:Glossary.Artefact.WebHome]] and can therefore have (% style="color:#e74c3c" %)Constraints(%%) specified. Note that the actual (% style="color:#e74c3c" %)Constraint(%%) as submitted is associated to the reference classes which inherit from ConstrainableRef: these are used to refer to the classes to which the (% style="color:#e74c3c" %)Constraint(%%) applies. 893 893 894 -The content of the (% style="color:# 2ecc71" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] document.895 +The content of the (% style="color:#e74c3c" %)Constraint(%%) can be found in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] document. 895 895 896 896 == {{id name="_Toc93873"/}}7.4 Data and Metadata Registration == 897 897 ... ... @@ -947,27 +947,27 @@ 947 947 948 948 The Registration includes [[attributes>>doc:Glossary.Attribute.WebHome]] that state how a SimpleDatasource is to be indexed when registered. The Registry registration process must act as follows: 949 949 950 -Information in the data or [[metadata set>>doc:Glossary.Metadata set.WebHome]] is extracted and placed in one or more (% style="color:# 2ecc71" %)//Constraint//(%%)s (see the (% style="color:#2ecc71" %)//Constraint//(%%) model in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] – Section 2 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below.951 +Information in the data or [[metadata set>>doc:Glossary.Metadata set.WebHome]] is extracted and placed in one or more (% style="color:#e74c3c" %)//Constraint//(%%)s (see the (% style="color:#e74c3c" %)//Constraint//(%%) model in the [[SDMX Information Model>>doc:Glossary.SDMX Information Model.WebHome]] – Section 2 of the [[SDMX>>doc:Glossary.Statistical data and metadata exchange.WebHome]] Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below. 951 951 952 952 ((( 953 953 (% style="width:678.294px" %) 954 954 |**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 955 -|indexTimeSeries|(% style="width:504px" %)Extract all the [[series keys>>doc:Glossary.Series key.WebHome]] and create a KeySet(s) (% style="color:# 2ecc71" %)Constraint(%%).956 -|indexDataSet|(% style="width:504px" %)Extract all the [[codes>>doc:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:Glossary.Series key.WebHome]] in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of [[Dimension>>doc:Glossary.Dimension.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:# 2ecc71" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value.956 +|indexTimeSeries|(% style="width:504px" %)Extract all the [[series keys>>doc:Glossary.Series key.WebHome]] and create a KeySet(s) (% style="color:#e74c3c" %)Constraint(%%). 957 +|indexDataSet|(% style="width:504px" %)Extract all the [[codes>>doc:Glossary.Code.WebHome]] and other content of the Key value of the [[Series Key>>doc:Glossary.Series key.WebHome]] in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of [[Dimension>>doc:Glossary.Dimension.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]], and the associated Selection Value. 957 957 |indexReportingPeriod|(% style="width:504px" %)((( 958 958 This applies only to a registered __[[dataset>>doc:Glossary.Data set.WebHome]]__. 959 -Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:Glossary.Reference period.WebHome]] (% style="color:# 2ecc71" %)constraint(%%).960 +Extract the Reporting Begin and Reporting End from the Header of the Message containing the [[data set>>doc:Glossary.Data set.WebHome]], and create a [[Reference Period>>doc:Glossary.Reference period.WebHome]] (% style="color:#e74c3c" %)constraint(%%). 960 960 ))) 961 961 |**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 962 962 |indexAttributes|(% style="width:504px" %)((( 963 963 **[[Data Set>>doc:Glossary.Data set.WebHome]]** 964 -Extract the content of the [[Attribute>>doc:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:# 2ecc71" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value965 +Extract the content of the [[Attribute>>doc:Glossary.Attribute.WebHome]] Values in a [[Data Set>>doc:Glossary.Data set.WebHome]] and create one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Data [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the SDMXIM, and the associated Selection Value 965 965 **[[Metadata Set>>doc:Glossary.Metadata set.WebHome]]** 966 -Indicate the presence of a Reported [[Attribute>>doc:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:# 2ecc71" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value.967 +Indicate the presence of a Reported [[Attribute>>doc:Glossary.Attribute.WebHome]] by creating one or more Cube Regions containing [[Member Selections>>doc:Glossary.Member selection.WebHome]] of Metadata [[Attribute>>doc:Glossary.Attribute.WebHome]] [[Components>>doc:Glossary.Component.WebHome]] of the (% style="color:#e74c3c" %)Constraints(%%) model in the [[SDMX-IM>>doc:Glossary.SDMX Information Model.WebHome]]. Note that the content is not stored in the Selection Value. 967 967 ))) 968 968 ))) 969 969 970 -(% style="color:# 2ecc71" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API).971 +(% style="color:#e74c3c" %)Constraints(%%) that specify the contents of a //QueryDatasource// are submitted to the Registry via the structure submission service (i.e., the RESTful API). 971 971 972 972 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 973 973 ... ... @@ -1029,35 +1029,35 @@ 1029 1029 Id = * 1030 1030 Version = * 1031 1031 1032 -This subscribes to all Codelists of all (% style="color:# 2ecc71" %)versions(%%) for all agencies.1033 +This subscribes to all Codelists of all (% style="color:#e74c3c" %)versions(%%) for all agencies. 1033 1033 1034 1034 AgencyID = AGENCY1 1035 1035 Id = CODELIST1 1036 1036 Version = * 1037 1037 1038 -This subscribes to all (% style="color:# 2ecc71" %)versions(%%) of Codelist CODELIST1 maintained by the agency AGENCY1.1039 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of Codelist CODELIST1 maintained by the agency AGENCY1. 1039 1039 1040 1040 AgencyID = AGENCY1 1041 1041 Id = * 1042 1042 Version = * 1043 1043 1044 -This subscribes to all (% style="color:# 2ecc71" %)versions(%%) of all Codelist objects maintained by the agency AGENCY1.1045 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of all Codelist objects maintained by the agency AGENCY1. 1045 1045 1046 1046 AgencyID = * 1047 1047 Id = CODELIST1 1048 1048 Version = * 1049 1049 1050 -This subscribes to all (% style="color:# 2ecc71" %)versions(%%) of Codelist CODELIST1 maintained by any agency.1051 +This subscribes to all (% style="color:#e74c3c" %)versions(%%) of Codelist CODELIST1 maintained by any agency. 1051 1051 1052 -Note that if the [[subscription>>doc:Glossary.Subscription.WebHome]] is to the latest stable (% style="color:# 2ecc71" %)version(%%) then this can be achieved by the + character, i.e.:1053 +Note that if the [[subscription>>doc:Glossary.Subscription.WebHome]] is to the latest stable (% style="color:#e74c3c" %)version(%%) then this can be achieved by the + character, i.e.: 1053 1053 1054 1054 Version = + 1055 1055 1056 -A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest (% style="color:# 2ecc71" %)version(%%) (whether stable, draft or non-versioned) can be achieved by the character, i.e.:1057 +A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest (% style="color:#e74c3c" %)version(%%) (whether stable, draft or non-versioned) can be achieved by the character, i.e.: 1057 1057 1058 1058 Version = ~~ 1059 1059 1060 -A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest stable (% style="color:# 2ecc71" %)version(%%) within major (% style="color:#2ecc71" %)version(%%) 2 starting with (% style="color:#2ecc71" %)version(%%) 2.3.1 can be achieved by adding the + character after the minor (% style="color:#2ecc71" %)version(%%) number, i.e.:1061 +A [[subscription>>doc:Glossary.Subscription.WebHome]] to the latest stable (% style="color:#e74c3c" %)version(%%) within major (% style="color:#e74c3c" %)version(%%) 2 starting with (% style="color:#e74c3c" %)version(%%) 2.3.1 can be achieved by adding the + character after the minor (% style="color:#e74c3c" %)version(%%) number, i.e.: 1061 1061 1062 1062 Version = 2.3+.1 1063 1063