Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 9.2
edited by Helena
on 2025/05/23 12:58
Change comment: There is no comment for this version
To version 3.1
edited by Helena
on 2025/05/21 15:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -SDMX 2.1 Standards. Section 5. Registry Specification – Logical Interfaces
1 +SDMX 2.1 Standards. Section. 5. Registry Specification – Logical Interfaces
Content
... ... @@ -4,11 +4,10 @@
4 4  
5 5  **Revision History**
6 6  
7 -(% style="width:833.294px" %)
8 -|(% style="width:122px" %)**Revision**|(% style="width:126px" %)**Date**|(% style="width:581px" %)**Contents**
9 -|(% style="width:122px" %) |(% style="width:126px" %)April 2011|(% style="width:581px" %)Initial release
10 -|(% style="width:122px" %)1.0|(% style="width:126px" %)July 2011|(% style="width:581px" %)Rectification of problems of the specifications dated April 2011
11 -|(% style="width:122px" %)2.0|(% style="width:126px" %)July 2020|(% style="width:581px" %)Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
7 +|**Revision**|**Date**|**Contents**
8 +| |April 2011|Initial release
9 +|1.0|July 2011|Rectification of problems of the specifications dated April 2011
10 +|2.0|July 2020|Addition of VTL (Validation and Transformation Language) package, maintainable artefacts, nameable artefacts to 5.2.3, 6.2.2, 6.2.3, 6.2.4, 7.1.1
12 12  
13 13  **Corrigendum**
14 14  
... ... @@ -289,22 +289,27 @@
289 289  * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
290 290  * that a simple data source exists (i.e. a file accessible at a URL)
291 291  * that the correct Data Structure Definition or Metadata Structure Definition is used by the registered data that the components (Dimensions, Attributes, Measures, Identifier Components etc.) are consistent with the Data Structure Definition or Metadata Structure Definition
292 -* that the valid representations of the concepts to which these components correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
291 +* that the valid representations of the concepts to which these components 382 correspond conform to the definition in the Data Structure Definition or Metadata Structure Definition
293 293  
294 -The Registration has an action attribute which takes one of the following values:
293 +3The Registration has an action attribute which takes one of the following values:
295 295  
296 -|(% style="width:219px" %)**Action Attribute Value**|(% style="width:1652px" %)**Behaviour**
297 -|(% style="width:219px" %)Append|(% style="width:1652px" %)Add this registration to the registry
298 -|(% style="width:219px" %)Replace|(% style="width:1652px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
299 -|(% style="width:219px" %)Delete|(% style="width:1652px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
295 +|(% style="width:249px" %)(((
296 +**Action Attribute Value**
297 +)))|(% style="width:1622px" %)**Behaviour**
298 +|(% style="width:249px" %)Append|(% style="width:1622px" %)Add this registration to the registry
299 +|(% style="width:249px" %)Replace|(% style="width:1622px" %)Replace the existing Registration with this Registration identified by the id in the Registration of the Submit Registration Request
300 +|(% style="width:249px" %)Delete|(% style="width:1622px" %)Delete the existing Registration identified by the id in the Registration of the Submit Registration Request
300 300  
301 301  The Registration has three Boolean attributes which may be present to determine how an SDMX compliant Dataset or Metadata Set indexing application must index the Datasets or Metadata Set upon registration. The indexing application behaviour is as follows:
302 302  
303 -|(% style="width:228px" %)**Boolean Attribute**|(% style="width:1644px" %)**Behaviour if Value is “true”**
304 -|(% style="width:228px" %)indexTimeSeries|(% style="width:1644px" %)A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
305 -|(% style="width:228px" %)indexDataSet|(% style="width:1644px" %)A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
304 +|**Boolean Attribute**|**Behaviour if Value is “true”**
305 +|indexTimeSeries|A compliant indexing application must index all the time series keys (for a Dataset registration) or metadata target values (for a Metadata Set registration)
306 +|indexDataSet|(((
307 +A compliant indexing application must index the range of actual (present) values for each dimension of the Dataset (for a Dataset registration) or the range of actual (present) values for each Metadata Attribute which takes an enumerated value.
308 +
306 306  Note that for data this requires much less storage than full key indexing, but this method cannot guarantee that a specific combination of Dimension values (the Key) is actually present in the Dataset
307 -|(% style="width:228px" %)indexReportingPeriod|(% style="width:1644px" %)A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
310 +)))
311 +|indexReportingPeriod|A compliant indexing application must index the time period range(s) for which data are present in the Dataset or Metadata Set
308 308  
309 309  === 5.2.5 Data and Reference Metadata Discovery ===
310 310  
... ... @@ -326,7 +326,7 @@
326 326  Subscription management involves a user submitting a subscription request which contains:
327 327  
328 328  * a query or 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, or for a domain category, or changes to a Data Structure Definition).
329 -* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto : ) and HTTP POST (a normal http:~/~/ address)
333 +* a list of URIs or end-points to which an XML notification message can be sent. Supported end-point types will be email (mailto~:) and HTTP POST (a normal http:~/~/ address)
330 330  * request for a list of submitted subscriptions
331 331  * deletion of a subscription
332 332  
... ... @@ -336,8 +336,8 @@
336 336  
337 337  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
338 338  
339 -|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340 -|(% style="width:227px" %)All|(% style="width:1644px" %)(((
343 +|(% style="width:244px" %)**Interface**|**Behaviour**
344 +|(% style="width:244px" %)All|(((
341 341  1) If the action is set to “replace” then the entire contents of the existing maintainable object in the Registry MUST be replaced by the object submitted, unless the final attribute is set to “true” in which case the only changes that are allowed are to the following constructs:
342 342  
343 343  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
... ... @@ -351,6 +351,7 @@
351 351  * isExternalReference
352 352  
353 353  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.
358 +
354 354  3) If the action is set to “delete” then the Registry MUST verify that the object can deleted. In order to qualify for deletion the object must:
355 355  
356 356  а) Not have the final attribute set to “true”
... ... @@ -357,11 +357,12 @@
357 357  b) Not be referenced from any other object in the Registry.
358 358  
359 359  4) The version rules in the SDMX Schema documentation MUST be obeyed.
365 +
360 360  5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
361 361  )))
362 -|(% style="width:227px" %)SubmitStructureRequest|(% style="width:1644px" %)Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
363 -|(% style="width:227px" %)SubmitProvisioningRequest|(% style="width:1644px" %)No additional behaviour.
364 -|(% style="width:227px" %)Submit Registration Request|(% style="width:1644px" %)(((
368 +|(% style="width:244px" %)SubmitStructureRequest|Structures are submitted at the level of the Maintainable Artefact and the behaviour in “All” above is therefore at the level of the Maintainable Artefact.
369 +|(% style="width:244px" %)SubmitProvisioningRequest|No additional behaviour.
370 +|(% style="width:244px" %)Submit Registration Request|(((
365 365  If the datasource is a file (simple datasource) then the file MAY be retrieved and indexed according to the Boolean attributes set in the Registration.
366 366  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
367 367  )))
... ... @@ -427,8 +427,6 @@
427 427  
428 428  The Maintenance Agency in SDMX is maintained in an Agency Scheme which itself is a sub class of Organisation Scheme – this is shown in the class diagram below.
429 429  
430 -[[image:1747994320263-112.png]]
431 -
432 432  **Figure 6: Agency Scheme Model**
433 433  
434 434  The Agency in SDMX is extremely important. The Agency Id system used in SDMX is an n-level structure. The top level of this structure is maintained by SDMX. Any Agency in this top level can declare sub agencies and any sub agency can also declare sub agencies. The Agency Scheme has a fixed id and version and is never declared explicitly in the SDMX object identification mechanism.
... ... @@ -450,8 +450,7 @@
450 450  
451 451  [[image:1747824123012-527.jpeg]]
452 452  
453 -*
454 -** Figure 7: Example of Hierarchic Structure of Agencies
457 +==== Figure 7: Example of Hierarchic Structure of Agencies ====
455 455  
456 456  The following organizations maintain an Agency Scheme.
457 457  
... ... @@ -466,8 +466,9 @@
466 466  
467 467  An example of this is shown in the XML snippet below.
468 468  
469 -[[image:1747832400104-286.png]]
472 +[[image:1747824123013-196.jpeg||height="309" width="446"]]
470 470  
474 +(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
471 471  **Figure 8: Example Showing Use of Agency Identifiers**
472 472  
473 473  Each of these maintenance agencies has an identical Code list with the Id CL_BOP. However, each is uniquely identified by means of the hierarchic agency structure.
... ... @@ -480,14 +480,13 @@
480 480  
481 481  ==== 6.2.2.2 URN Structure ====
482 482  
483 -(% class="wikigeneratedid" id="HCaseRulesforURN" %)
484 -//Case Rules for URN//
487 +===== //Case Rules for URN// =====
485 485  
486 486  For the URN, all parts of the string are case sensitive. The Id of any object must be UPPER CASE. Therefore, CRED_ext_Debt is invalid and it should be CRED_EXT_DEBT.
487 487  
488 488  The generic structure of the URN is as follows:
489 489  
490 ->SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
493 +SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
491 491  
492 492  ~* this can repeat and may not be present (see explanation below)
493 493  
... ... @@ -499,7 +499,7 @@
499 499  
500 500  In the explanation below the actual object that is the target of the URN is called the **//actual object//**.
501 501  
502 -**SDMXPrefix:** urn:sdmx:org.
505 +**SDMXPrefix:** urn:sdmx:org.                                     
503 503  
504 504  **SDMX-IM package name:** sdmx.infomodel.package=
505 505  
... ... @@ -707,6 +707,8 @@
707 707  hierarchicalcodelistId(version).Hierarchy.Level
708 708  )))|(% style="width:396px" %)(((
709 709  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
713 +
714 +
710 710  )))
711 711  |(% style="width:250px" %)HierarchicalCode|(% style="width:444px" %)hierachicalCodeListAgencyId: hierarchicalcodelistId(version).hierarchy.hierarc hicalCode|(% style="width:396px" %)UNESCO:CL_EXP_SOURCE(1.0). H-C-GOV.GOV_CODE1
712 712  |(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
... ... @@ -811,11 +811,15 @@
811 811  
812 812  |(% style="width:251px" %)(((
813 813  ReportStructure
819 +
820 +
814 814  )))|(% style="width:442px" %)(((
815 815  MSDAgencyId: MSDId(version).reportStructureId
816 816  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
817 817  |(% style="width:251px" %)(((
818 -Metadata Attribute
825 +Metadata
826 +
827 +Attribute
819 819  )))|(% style="width:442px" %)(((
820 820  MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
821 821  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
... ... @@ -826,10 +826,14 @@
826 826  TFFS:CRED_EXT_DEBT_AB(1.0)
827 827  )))
828 828  |(% style="width:251px" %)(((
829 -*Content Constraint
838 +*Content
839 +
840 +Constraint
830 830  )))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
831 831  |(% style="width:251px" %)(((
832 -*Attachment Constraint
843 +*Attachment
844 +
845 +Constraint
833 833  )))|(% style="width:442px" %)(((
834 834  constraintAgencyId:
835 835  
... ... @@ -852,7 +852,9 @@
852 852  codeMapId
853 853  )))|
854 854  |(((
855 -CategorySchemeMap
868 +Category
869 +
870 +SchemeMap
856 856  )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
857 857  |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
858 858  |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
... ... @@ -866,53 +866,71 @@
866 866  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
867 867  
868 868  conceptMapId
884 +
869 869  
870 870  )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
871 871  |(((
872 -ReportingTaxonomyMap
888 +Reporting
889 +
890 +TaxonomyMap
873 873  )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
874 874  |(((
875 -ReportingCategoryMap
893 +Reporting
894 +
895 +CategoryMap
876 876  )))|(((
877 877  structureSetAgencyId: structureSetId(version).
898 +
878 878  reportngCategoryId
879 879  )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
880 880  
902 +
903 +
881 881  |(((
882 -HybridCodelistMap
883 -)))|structureSetAgencyId: structureSetId(version).
884 -hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
905 +HybridCodelist
906 +
907 +Map
908 +)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
885 885  |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
886 886  |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
887 887  |ProcessStep|(((
888 888  processAgencyId: processId(version).
913 +
889 889  processStepId
890 890  )))|BIS:PROCESS1(1.0).STEP1
891 891  |Transition|(((
892 892  processAgencyId: processId(version).
918 +
893 893  processStepId transitionId
894 894  )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
895 895  |Subscription|The Subscription is not itself an Identifiable Artefact and therefore it does not follow the rules for URN structure, The name of the URN is registryURN There is no pre-determined format.|This cannot be generated by a common mechanism as subscriptions, although maintainable in the sense that they can be submitted and deleted, are not mandated to be created by a maintenance agency, and have no versioning mechanism. It is therefore the responsibility of the target registry to generate a unique Id for the Subscription, and for the application creating the subscription to store the registryURN that is returned from the registry in the subscription response message.
896 896  |(((
897 -*Transformation Scheme
923 +*Transformation
924 +
925 +Scheme
898 898  )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
899 899  |Transformation|(((
900 900  transformationSchemeAgencyId transformationSchemeId(version)
929 +
901 901  transformationId
902 902  )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
903 903  |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
904 904  
934 +
935 +
905 905  |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
906 906  |(((
907 907  Name
939 +
908 908  Personalisation
941 +
909 909  Scheme
910 910  )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
911 911  |(((
912 912  Name
946 +
913 913  Personalisation
914 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
915 -namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
948 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
916 916  |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
917 917  |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
918 918  |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
... ... @@ -925,11 +925,13 @@
925 925  |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
926 926  |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
927 927  |(((
928 -UserDefinedOperatorScheme
961 +UserDefined
962 +
963 +OperatorScheme
929 929  )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
930 930  |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
931 931  
932 -**Table 3: Table of identification components for SDMX Identifiable Artefacts**
967 +7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
933 933  
934 934  = 7 Implementation Notes =
935 935  
... ... @@ -1139,7 +1139,7 @@
1139 1139  
1140 1140  [[image:1747824123025-411.jpeg]]
1141 1141  
1142 -**Figure 16: Schematic of the Objects Concerned with Registration**
1177 + **Figure 16: Schematic of the Objects Concerned with Registration**
1143 1143  
1144 1144  ==== 7.4.2.2 Registration Request Model ====
1145 1145  
... ... @@ -1215,7 +1215,7 @@
1215 1215  
1216 1216  When a registry/repository artefact is modified, any subscriptions which are observing the object are activated, and either an email or HTTP POST is instigated to report details of the changes to the user specified in the subscription. This is called a “notification”.
1217 1217  
1218 -=== 7.5.1Subscription Logical Class Diagram ===
1253 +=== 7.5.1Subscription Logical Class Diagram ===
1219 1219  
1220 1220  [[image:1747829554603-150.png]]
1221 1221  
... ... @@ -1230,11 +1230,11 @@
1230 1230  1. A validity period which defines both when the subscription becomes active and expires. The subscriber may be sent a notification on expiration of the subscription.
1231 1231  1. A selector which specifies which type of events are of interest. The set of event types is:
1232 1232  
1233 -|(% style="width:319px" %)**Event Type**|(% style="width:1553px" %)**Comment**
1234 -|(% style="width:319px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1553px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1235 -|(% style="width:319px" %)DATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1236 -|(% style="width:319px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1553px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1237 -|(% style="width:319px" %)ALL_EVENTS|(% style="width:1553px" %)All events of the specified EventType
1268 +|(% style="width:327px" %)**Event Type**|(% style="width:1545px" %)**Comment**
1269 +|(% style="width:327px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:1545px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository.
1270 +|(% style="width:327px" %)DATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database.
1271 +|(% style="width:327px" %)METADATA_REGISTRATION_EVENTS|(% style="width:1545px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database.
1272 +|(% style="width:327px" %)ALL_EVENTS|(% style="width:1545px" %)All events of the specified EventType
1238 1238  
1239 1239  === 7.5.3 Wildcard Facility ===
1240 1240  
1747832400104-286.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -172.3 KB
Content
1747994320263-112.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.helena
Size
... ... @@ -1,1 +1,0 @@
1 -13.9 KB
Content