Skip to Content
Last modified by Helena on 2025/09/10 11:19
From version 3.2
edited by Helena
on 2025/05/21 15:15
Change comment: There is no comment for this version
To version 3.7
edited by Helena
on 2025/05/21 15:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,10 +4,11 @@
4 4  
5 5  **Revision History**
6 6  
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
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
11 11  
12 12  **Corrigendum**
13 13  
... ... @@ -288,27 +288,22 @@
288 288  * that a queryable data source exists - this would necessitate the registration service querying the service to determine its existence
289 289  * that a simple data source exists (i.e. a file accessible at a URL)
290 290  * 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
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
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
292 292  
293 -3The Registration has an action attribute which takes one of the following values:
294 +The Registration has an action attribute which takes one of the following values:
294 294  
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
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
301 301  
302 302  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:
303 303  
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 -
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.
309 309  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
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
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
312 312  
313 313  === 5.2.5 Data and Reference Metadata Discovery ===
314 314  
... ... @@ -340,8 +340,8 @@
340 340  
341 341  The following table defines the behaviour of the SDMX Registry for the various Registry Interface messages.
342 342  
343 -|(% style="width:244px" %)**Interface**|**Behaviour**
344 -|(% style="width:244px" %)All|(((
339 +|(% style="width:227px" %)**Interface**|(% style="width:1644px" %)**Behaviour**
340 +|(% style="width:227px" %)All|(% style="width:1644px" %)(((
345 345  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:
346 346  
347 347  * Name – this applies to the Maintainable object and its contained elements, such a Code in a Code list.
... ... @@ -355,7 +355,6 @@
355 355  * isExternalReference
356 356  
357 357  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 -
359 359  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:
360 360  
361 361  а) Not have the final attribute set to “true”
... ... @@ -362,12 +362,11 @@
362 362  b) Not be referenced from any other object in the Registry.
363 363  
364 364  4) The version rules in the SDMX Schema documentation MUST be obeyed.
365 -
366 366  5) The specific rules for the elements and attributes documented in the SDMX Schema MUST be obeyed.
367 367  )))
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|(((
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" %)(((
371 371  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.
372 372  For a queryable datasource the Registry MAY validate that the source exists and can accept an SDMX-ML data query.
373 373  )))
... ... @@ -454,7 +454,8 @@
454 454  
455 455  [[image:1747824123012-527.jpeg]]
456 456  
457 -==== Figure 7: Example of Hierarchic Structure of Agencies ====
451 +*
452 +** Figure 7: Example of Hierarchic Structure of Agencies
458 458  
459 459  The following organizations maintain an Agency Scheme.
460 460  
... ... @@ -471,7 +471,6 @@
471 471  
472 472  [[image:1747824123013-196.jpeg||height="309" width="446"]]
473 473  
474 -(% class="wikigeneratedid" id="HFigure8:ExampleShowingUseofAgencyIdentifiers" %)
475 475  **Figure 8: Example Showing Use of Agency Identifiers**
476 476  
477 477  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.
... ... @@ -490,7 +490,7 @@
490 490  
491 491  The generic structure of the URN is as follows:
492 492  
493 -SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
487 +>SDMXprefix.SDMX-IM-package-name.class-name=agencyid:maintainedobject-id(maintainedobject-version).*containerobject-id.object-id
494 494  
495 495  ~* this can repeat and may not be present (see explanation below)
496 496  
... ... @@ -710,8 +710,6 @@
710 710  hierarchicalcodelistId(version).Hierarchy.Level
711 711  )))|(% style="width:396px" %)(((
712 712  ESTAT:HCL_REGION(1.0).H_1.COUNTRY
713 -
714 -
715 715  )))
716 716  |(% 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
717 717  |(% style="width:250px" %)*DataStructure|(% style="width:444px" %)dataStructureDefintitionAgencyId: dataStructureDefintitionId(version)|(% style="width:396px" %)TFFS:EXT_DEBT(1.0)
... ... @@ -816,15 +816,11 @@
816 816  
817 817  |(% style="width:251px" %)(((
818 818  ReportStructure
819 -
820 -
821 821  )))|(% style="width:442px" %)(((
822 822  MSDAgencyId: MSDId(version).reportStructureId
823 823  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT
824 824  |(% style="width:251px" %)(((
825 -Metadata
826 -
827 -Attribute
815 +Metadata Attribute
828 828  )))|(% style="width:442px" %)(((
829 829  MSDAgencyId: MSDId(version).reportStructureId.metadataattri buteID
830 830  )))|(% style="width:1178px" %)IMF:SDDS_MSD(1.0).AGENCY_REPORT.COMPILATION
... ... @@ -835,14 +835,10 @@
835 835  TFFS:CRED_EXT_DEBT_AB(1.0)
836 836  )))
837 837  |(% style="width:251px" %)(((
838 -*Content
839 -
840 -Constraint
826 +*Content Constraint
841 841  )))|(% style="width:442px" %)constraintAgencyId:ContentConstraintId(versio n)|(% style="width:1178px" %)TFFS:CREDITOR_DATA_CONTENT(1.0)
842 842  |(% style="width:251px" %)(((
843 -*Attachment
844 -
845 -Constraint
829 +*Attachment Constraint
846 846  )))|(% style="width:442px" %)(((
847 847  constraintAgencyId:
848 848  
... ... @@ -865,9 +865,7 @@
865 865  codeMapId
866 866  )))|
867 867  |(((
868 -Category
869 -
870 -SchemeMap
852 +CategorySchemeMap
871 871  )))|structureSetAgencyId: structureSetId(version). categorySchemeMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT
872 872  |CategoryMap|structureSetAgencyId: structureSetId(version). categorySchemeMapId. categoryMapId|SDMX:BOP_STRUCTURES(1.0).SDMX_EUROSTAT.TOURISM_M AP
873 873  |Organisation SchemeMap|structureSetAgencyId: structureSetId(version). organisationSchemeMapId|SDMX:BOP_STRUCTURES(1.0).DATA_PROVIDER_MAP
... ... @@ -881,71 +881,53 @@
881 881  structureSetAgencyId: structureSetId(version). conceptSchemeMapId.
882 882  
883 883  conceptMapId
884 -
885 885  
886 886  )))|SDMX:BOP_STRUCTURES(1.0).SDMX_OECD.COVERAGE_AVAI LABILITY
887 887  |(((
888 -Reporting
889 -
890 -TaxonomyMap
869 +ReportingTaxonomyMap
891 891  )))|structureSetAgencyId: structureSetId(version). reportingTaxonomyMapId|SDMX:BOP_STRUCTURES(1.0).TAXMAP
892 892  |(((
893 -Reporting
894 -
895 -CategoryMap
872 +ReportingCategoryMap
896 896  )))|(((
897 897  structureSetAgencyId: structureSetId(version).
898 -
899 899  reportngCategoryId
900 900  )))|SDMX:BOP_STRUCTURES(1.0).TAXMAP.TOPCAT
901 901  
902 -
903 -
904 904  |(((
905 -HybridCodelist
906 -
907 -Map
908 -)))|structureSetAgencyId: structureSetId(version). hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
879 +HybridCodelistMap
880 +)))|structureSetAgencyId: structureSetId(version).
881 +hybridCodelistMapId.|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP
909 909  |HybridCodeMap|structureSetAgencyId: structureSetId(version). hybridCodelistMapId. hybridCodeMapId|SDMX:BOP_STRUCTURES(1.0).COUNTRY_HIERARCHYMAP.CO DEMAP1
910 910  |*Process|processAgencyId: processId{version]|BIS:PROCESS1(1.0)
911 911  |ProcessStep|(((
912 912  processAgencyId: processId(version).
913 -
914 914  processStepId
915 915  )))|BIS:PROCESS1(1.0).STEP1
916 916  |Transition|(((
917 917  processAgencyId: processId(version).
918 -
919 919  processStepId transitionId
920 920  )))|BIS:PROCESS1(1.0).STEP1.TRANSITION1
921 921  |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.
922 922  |(((
923 -*Transformation
924 -
925 -Scheme
894 +*Transformation Scheme
926 926  )))|transformationSchemeAgencyId transformationSchemeId(version)|ECB: TRANSFORMATION_SCHEME(1.0)
927 927  |Transformation|(((
928 928  transformationSchemeAgencyId transformationSchemeId(version)
929 -
930 930  transformationId
931 931  )))|ECB:TRANSFORMATION_SCHEME(1.0).TRANS_1
932 932  |CustomType Scheme|customTypeSchemeAgencyId customTypeSchemeId(version)|ECB:CUSTOM_TYPE_SCHEME(1.0)
933 933  
934 -
935 -
936 936  |CustomType|customTypeSchemeAgencyId customTypeSchemeId(version) customTypeId|ECB: CUSTOM_TYPE_SCHEME(1.0).CUSTOM_TYPE_1
937 937  |(((
938 938  Name
939 -
940 940  Personalisation
941 -
942 942  Scheme
943 943  )))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)|ECB:PSN_SCHEME(1.0)
944 944  |(((
945 945  Name
946 -
947 947  Personalisation
948 -)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version) namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
911 +)))|namePersonalisationSchemeAgencyId namePersonalisationSchemeId(version)
912 +namePersonalisationId|ECB:PSN_SCHEME(1.0).PSN1234
949 949  |VtlMapping Scheme|vtlMappingSchemeAgencyId VtlMappingSchemeId(version)|ECB:CLIST_MP(2.0)
950 950  |VtlCodelist Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlCodelistMappingId|ECB:CLIST_MP(2.0).ABZ
951 951  |VtlConcept Mapping|vtlMappingSchemeAgencyId vtlMappingSchemeId(version) vtlConceptMappingId|ECB:CLIST_MP(1.0).XYA
... ... @@ -958,13 +958,11 @@
958 958  |RulesetScheme|rulesetSchemeAgencyId rulesetSchemeId(version)|ECB:RULESET_23(1.0)
959 959  |Ruleset|rulesetSchemeAgencyId rulesetSchemeId(version) rulesetId|ECB:RULESET_23(1.0).SET111
960 960  |(((
961 -UserDefined
962 -
963 -OperatorScheme
925 +UserDefinedOperatorScheme
964 964  )))|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version)|ECB:OS_CALC(1.2)
965 965  |UserDefined Operator|userDefinedOperatorSchemeAgencyId userDefinedOperatorSchemeId(version) usserDefinedOperatorId|ECB:OS_CALC(1.2).OS267
966 966  
967 -7**Table 3: Table of identification components for SDMX Identifiable Artefacts**
929 +**Table 3: Table of identification components for SDMX Identifiable Artefacts**
968 968  
969 969  = 7 Implementation Notes =
970 970  
... ... @@ -1174,7 +1174,7 @@
1174 1174  
1175 1175  [[image:1747824123025-411.jpeg]]
1176 1176  
1177 - **Figure 16: Schematic of the Objects Concerned with Registration**
1139 +**Figure 16: Schematic of the Objects Concerned with Registration**
1178 1178  
1179 1179  ==== 7.4.2.2 Registration Request Model ====
1180 1180