Last modified by Helena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -329,12 +329,14 @@ 329 329 330 330 The table below shows the identification and related data attributes to be stored in a registry for objects that are one of: 331 331 332 -* //nnotable// 332 +* //Annotable// 333 333 * //Identifiable// 334 334 * //Nameable// 335 335 * //Versionable// 336 336 * //Maintainable// 337 337 338 +: 339 + 338 338 ((( 339 339 (% style="width:1052.29px" %) 340 340 |**Object Type**|(% style="width:241px" %)**Data Attributes**|(% style="width:156px" %)**Status**|**Data type**|(% style="width:457px" %)**Notes** ... ... @@ -362,9 +362,9 @@ 362 362 363 363 **Table 1: Common Attributes of Object Types** 364 364 365 -== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects == 367 +=== {{id name="_Toc93856"/}}6.2 Unique identification of SDMX objects === 366 366 367 -=== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers === 369 +===== {{id name="_Toc93857"/}}6.2.1 Agencies and Metadata Providers ===== 368 368 369 369 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. 370 370 ... ... @@ -741,7 +741,7 @@ 741 741 742 742 === {{id name="_Toc93862"/}}7.1 Structural Definition Metadata === 743 743 744 -=== {{id name="_Toc93863"/}}7.1.1 Introduction === 746 +===== {{id name="_Toc93863"/}}7.1.1 Introduction ===== 745 745 746 746 The SDMX Registry must have the ability to support agencies in their role of defining and disseminating structural metadata artefacts. These artefacts include data structure definitions, code lists, concepts etc. and are fully defined in the SDMX-IM. An authenticated agency may submit valid structural metadata definitions which must be stored in the registry. Note that the term “structural metadata” refers as a general term to all structural components (Data Structure Definitions, Metadata Structure Definitions, Code Lists, Concept Schemes, etc.) 747 747 ... ... @@ -808,7 +808,7 @@ 808 808 809 809 **Table 4: Table of Maintainable Artefacts for Structural Definition Metadata** 810 810 811 -=== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure === 813 +===== {{id name="_Toc93864"/}}7.1.2 Item Scheme, Structure ===== 812 812 813 813 The artefacts included in the structural definitions are: 814 814 ... ... @@ -819,17 +819,17 @@ 819 819 820 820 ===== {{id name="_Toc93865"/}}7.1.3 Structure Usage ===== 821 821 822 - ====7.1.3.1 Structure Usage: Basic Concepts====824 +**7.1.3.1 Structure Usage: Basic Concepts** 823 823 824 824 The Structure Usage defines, in its concrete classes of Dataflow and Metadataflow, which flows of data and metadata use which specific Structure, and importantly for the support of data and metadata discovery, the Structure Usage can be linked to one or more Category in one or more Category Scheme using the Categorisation mechanism. This gives the ability for an application to discover data and metadata by “drilling down” the Category Schemes. 825 825 826 - ====7.1.3.2 Structure Usage Schematic====828 +**7.1.3.2 Structure Usage Schematic** 827 827 828 828 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_52097ab5.jpg||height="246" width="438"]] 829 829 830 830 **Figure 9: Schematic of Linking the Data and Metadata Flows to Categories and Structure Definitions** 831 831 832 - ====7.1.3.3 Structure Usage Model====834 +**7.1.3.3 Structure Usage Model** 833 833 834 834 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_302cc1a2.jpg||height="548" width="578"]] 835 835 ... ... @@ -944,13 +944,13 @@ 944 944 The Registration has an action attribute which takes one of the following values: 945 945 946 946 ((( 947 -(% style="width: 761.294px" %)948 -|(% style="width:196px" %)**Action Attribute Value**|(% style="width: 561px" %)**Behaviour**949 -|(% style="width:196px" %)Append|(% style="width: 561px" %)Add this Registration to the registry950 -|(% style="width:196px" %)Replace|(% style="width: 561px" %)(((949 +(% style="width:679.294px" %) 950 +|(% style="width:196px" %)**Action Attribute Value**|(% style="width:480px" %)**Behaviour** 951 +|(% style="width:196px" %)Append|(% style="width:480px" %)Add this Registration to the registry 952 +|(% style="width:196px" %)Replace|(% style="width:480px" %)((( 951 951 Replace the existing Registration with identified by the id in the Registration of the SubmitRegistrationRequest 952 952 ))) 953 -|(% style="width:196px" %)Delete|(% style="width: 561px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest955 +|(% style="width:196px" %)Delete|(% style="width:480px" %)Delete the existing Registration identified by the id in the Registration of the SubmitRegistrationRequest 954 954 ))) 955 955 956 956 [[image:SDMX 3-0-0 SECTION 5 FINAL-1.0_en_bc1dcdec.jpg||height="575" width="579"]] ... ... @@ -967,20 +967,27 @@ 967 967 968 968 Information in the data or metadata set is extracted and placed in one or more //Constraint//s (see the //Constraint// model in the SDMX Information Model – Section 2 of the SDMX Standards). The information to be extracted is indicated by the Boolean values set on the ProvisionAgreement or MetadataProvisionAgreement as shown in the table below. 969 969 972 +: 973 + 970 970 ((( 971 -(% style="width:678.294px" %) 972 -|**Indexing Required**|(% style="width:504px" %)**Registration Process Activity** 973 -|indexTimeSeries|(% style="width:504px" %)Extract all the series keys and create a KeySet(s) Constraint. 974 -|indexDataSet|(% style="width:504px" %)Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 975 -|indexReportingPeriod|(% style="width:504px" %)((( 975 +|**Indexing Required**|**Registration Process Activity** 976 +|indexTimeSeries|Extract all the series keys and create a KeySet(s) Constraint. 977 +|indexDataSet|Extract all the codes and other content of the Key value of the Series Key in a Data Set and create one or more Cube Regions containing Member Selections of Dimension Components of the Constraints model in the SDMX-IM, and the associated Selection Value. 978 +|indexReportingPeriod|((( 976 976 This applies only to a registered __dataset__. 980 + 977 977 Extract the Reporting Begin and Reporting End from the Header of the Message containing the data set, and create a Reference Period constraint. 978 978 ))) 979 -|**Indexing Required**| (% style="width:504px" %)**Registration Process Activity**980 -|indexAttributes|( % style="width:504px" %)(((983 +|**Indexing Required**|**Registration Process Activity** 984 +|indexAttributes|((( 981 981 **Data Set** 982 -Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the SDMXIM, and the associated Selection Value 986 + 987 +Extract the content of the Attribute Values in a Data Set and create one or more Cube Regions containing Member Selections of Data Attribute Components of the Constraints model in the 988 + 989 +SDMXIM, and the associated Selection Value 990 + 983 983 **Metadata Set** 992 + 984 984 Indicate the presence of a Reported Attribute by creating one or more Cube Regions containing Member Selections of Metadata Attribute Components of the Constraints model in the SDMX-IM. Note that the content is not stored in the Selection Value. 985 985 ))) 986 986 ))) ... ... @@ -989,7 +989,7 @@ 989 989 990 990 The Registration must reference the ProvisionAgreement or MetadataProvisionAgreement to which it relates. 991 991 992 -=== {{id name="_Toc93876"/}}7.4.3 Registration Response === 1001 +===== {{id name="_Toc93876"/}}7.4.3 Registration Response ===== 993 993 994 994 After a registration request has been submitted to the registry, a response is returned to the submitter indicating success or failure. Given that a registration request can hold many Registrations, then there must be a registration status for each Registration. The SubmitRegistration class has a status field, which is either set to “Success”, “Warning” or “Failure”. 995 995 ... ... @@ -1019,18 +1019,20 @@ 1019 1019 1020 1020 Regardless of the type of registry/repository events being observed, a subscription always contains: 1021 1021 1022 -1. set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1031 +1. A set of URIs describing the end-points to which notifications must be sent if the subscription is activated. The URIs can be either mailto~: or http: protocol. In the former case an email notification is sent; in the latter an HTTP POST notification is sent. 1023 1023 1. A user-defined identifier, which is returned in the response to the subscription request. This helps with asynchronous processing and is NOT stored in the Registry. 1024 1024 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. 1025 1025 1. A selector which specifies which type of events are of interest. The set of event types is: 1026 1026 1036 +: 1037 +:: 1038 + 1027 1027 ((( 1028 -(% style="width:856.294px" %) 1029 -|(% style="width:320px" %)**Event Type**|(% style="width:532px" %)**Comment** 1030 -|(% style="width:320px" %)STRUCTURAL_REPOSITORY_EVENTS|(% style="width:532px" %)Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1031 -|(% style="width:320px" %)DATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1032 -|(% style="width:320px" %)METADATA_REGISTRATION_EVENTS|(% style="width:532px" %)Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1033 -|(% style="width:320px" %)ALL_EVENTS|(% style="width:532px" %)All events of the specified EventType 1040 +|**Event Type**|**Comment** 1041 +|STRUCTURAL_REPOSITORY_EVENTS|Life-cycle changes to Maintainable Artefacts in the structural metadata repository. 1042 +|DATA_REGISTRATION_EVENTS|Whenever a published dataset is registered. This can be either a SDMXML data file or an SDMX conformant database. 1043 +|METADATA_REGISTRATION_EVENTS|Whenever a published metadataset is registered. This can be either a SDMXML reference metadata file or an SDMX conformant database. 1044 +|ALL_EVENTS|All events of the specified EventType 1034 1034 ))) 1035 1035 1036 1036 === {{id name="_Toc93880"/}}7.5.3 Wildcard Facility === ... ... @@ -1097,14 +1097,15 @@ 1097 1097 1098 1098 Whenever a dataset or metadata-set is registered a registration event is created. A subscription may be observing all data or metadata registrations, or it may focus on specific registrations as shown in the table below: 1099 1099 1111 +: 1112 + 1100 1100 ((( 1101 -(% style="width:1126.29px" %) 1102 -|(% style="width:382px" %)**Selector**|(% style="width:740px" %)**Comment** 1103 -|(% style="width:382px" %)DataProvider & MetadataProvider|(% style="width:740px" %)Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1104 -|(% style="width:382px" %)ProvisionAgreement & MetadataProvisionAgreement|(% style="width:740px" %)Any datasets or metadata sets registered for the agreement will activate the notification. 1105 -|(% style="width:382px" %)Dataflow & Metadataflow|(% style="width:740px" %)Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1106 -|(% style="width:382px" %)DataStructureDefinition & MetadataStructureDefinition|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1107 -|(% style="width:382px" %)Category|(% style="width:740px" %)Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1114 +|**Selector**|**Comment** 1115 +|DataProvider & MetadataProvider|Any datasets or metadata sets registered by the specified data or metadata provider will activate the notification. 1116 +|ProvisionAgreement & MetadataProvisionAgreement|Any datasets or metadata sets registered for the agreement will activate the notification. 1117 +|Dataflow & Metadataflow|Any datasets or metadata sets registered for the specified dataflow (or metadataflow) will activate the notification. 1118 +|DataStructureDefinition & MetadataStructureDefinition|Any datasets or metadata sets registered for those dataflows (or metadataflows) that are based on the specified Data Structure Definition will activate the notification 1119 +|Category|Any datasets or metadata sets registered for those dataflows, metadataflows, provision agreements that are categorised by the category. 1108 1108 ))) 1109 1109 1110 1110 The event will also capture the semantic of the registration: deletion or replacement of an existing registration or a new registration. ... ... @@ -1136,6 +1136,12 @@ 1136 1136 1137 1137 The notification will contain the Registration. 1138 1138 1139 - ----1151 +[[1>>path:#sdfootnote1anc||name="sdfootnote1sym"]] 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.4draft does not break integrity of the aforementioned DSD. 1140 1140 1153 +[[2>>path:#sdfootnote2anc||name="sdfootnote2sym"]] The identification of an Agency in the URN structure for the maintainable object is by means of the agencyId. The AgencyScheme is not identified as SDMX has a mechanism for identifying an Agency uniquely by its Id. Note that this Id may be hierarchical. For example, a sub-agency of IMF is referred like this: 1154 + 1155 +IMF.SubAgency1 1156 + 1157 +[[3>>path:#sdfootnote3anc||name="sdfootnote3sym"]] Note that Codelist is also an EnumeratedList. 1158 + 1141 1141 {{putFootnotes/}}