Interoperability Basis Platform

This section discusses a number of topics other than the exchange of [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] formats. Supported only in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] (and some in [[SDMX-JSON>>doc:sdmx:Glossary.SDMX-JSON.WebHome]]), these topics include the use of the [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] mechanism in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], the use of [[Structure Sets>>doc:sdmx:Glossary.Structure set.WebHome]] and [[Reporting Taxonomies>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], the use of Processes, a discussion of time and datatyping, and the conventional mechanisms within the [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message regarding versioning and referencing.

6

7

== 4.1 Representations ==

8

9

This section does not go into great detail on these topics but provides a useful overview of these features to assist implementors in further use of the parts of the specification which are relevant to them.

10

11

There are several different [[representations>>doc:sdmx:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], taken from XML Schemas and common programming languages. The table below describes the various [[representations>>doc:sdmx:Glossary.Representation.WebHome]], which are found in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]], and their equivalents.

12

13

|(% style="width:191px" %)**SDMX-ML Data Type**|(% style="width:232px" %)**XML Schema Data Type**|(% style="width:212px" %)**.NET Framework Type**|(% style="width:980px" %)(((

14

**Java Data Type**

15

)))

16

|(% style="width:191px" %)String|(% style="width:232px" %)xsd:string|(% style="width:212px" %)System.String|(% style="width:980px" %)java.lang.String

17

|(% style="width:191px" %)Big Integer|(% style="width:232px" %)xsd:integer|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigInteger

18

|(% style="width:191px" %)Integer|(% style="width:232px" %)xsd:int|(% style="width:212px" %)System.Int32|(% style="width:980px" %)int

19

|(% style="width:191px" %)Long|(% style="width:232px" %)xsd.long|(% style="width:212px" %)System.Int64|(% style="width:980px" %)long

20

|(% style="width:191px" %)Short|(% style="width:232px" %)xsd:short|(% style="width:212px" %)System.Int16|(% style="width:980px" %)short

21

|(% style="width:191px" %)[[Decimal>>doc:sdmx:Glossary.Decimals.WebHome]]|(% style="width:232px" %)xsd:decimal|(% style="width:212px" %)System.Decimal|(% style="width:980px" %)java.math.BigDecimal

22

|(% style="width:191px" %)Float|(% style="width:232px" %)xsd:float|(% style="width:212px" %)System.Single|(% style="width:980px" %)float

23

|(% style="width:191px" %)Double|(% style="width:232px" %)xsd:double|(% style="width:212px" %)System.Double|(% style="width:980px" %)double

24

|(% style="width:191px" %)Boolean|(% style="width:232px" %)xsd:boolean|(% style="width:212px" %)System.Boolean|(% style="width:980px" %)boolean

25

|(% style="width:191px" %)URI|(% style="width:232px" %)xsd:anyURI|(% style="width:212px" %)System.Uri|(% style="width:980px" %)Java.net.URI or java.lang.String

26

|(% style="width:191px" %)DateTime|(% style="width:232px" %)xsd:dateTime|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

27

|(% style="width:191px" %)Time|(% style="width:232px" %)xsd:time|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

28

|(% style="width:191px" %)GregorianYear|(% style="width:232px" %)xsd:gYear|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

29

|(% style="width:191px" %)GregorianMonth|(% style="width:232px" %)xsd:gYearMonth|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

30

|(% style="width:191px" %)GregorianDay|(% style="width:232px" %)xsd:date|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

31

|(% style="width:191px" %)Day, MonthDay, Month|(% style="width:232px" %)xsd:g*|(% style="width:212px" %)System.DateTime|(% style="width:980px" %)javax.xml.datatype.XMLGregorianCalendar

32

|(% style="width:191px" %)Duration|(% style="width:232px" %)xsd:duration|(% style="width:212px" %)System.TimeSpan|(% style="width:980px" %)javax.xml.datatype.Duration

33

34

There are also a number of [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data types which do not have these direct correspondences, often because they are composite [[representations>>doc:sdmx:Glossary.Representation.WebHome]] or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] schemas, for others a derived simple type will be necessary:

35

36

* **AlphaNumeric** (**common:AlphaNumericType**, string which only allows A-z and 09)

37

* **Alpha** (**common:AlphaType**, string which only allows A-z)

38

* **Numeric** (**common:NumericType**, string which only allows 0-9, but is not numeric so that is can having leading zeros)

39

* **Count** (**xs:integer**, a sequence with an interval of "1")

40

* **InclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)

41

* **ExclusiveValueRange** (**xs:decimal** with the **minValue** and **maxValue** facets supplying the bounds)

42

* **Incremental** (**xs:decimal** with a specified **interval**; the interval is typically enforced outside of the XML validation)

43

* **TimeRange** (**common:TimeRangeType**, **startDateTime** + **Duration**)

44

* **ObservationalTimePeriod** (**common:ObservationalTimePeriodType**, a union of **StandardTimePeriod** and **TimeRange**).

45

* **StandardTimePeriod** (**common:StandardTimePeriodType**, a union of **BasicTimePeriod** and **ReportingTimePeriod**).

46

* **BasicTimePeriod** (**common:BasicTimePeriodType**, a union of **GregorianTimePeriod** and **DateTime**)

47

* **GregorianTimePeriod** (**common:GregorianTimePeriodType**, a union of **GregorianYear**, **GregorianMonth**, and **GregorianDay**)

48

* **ReportingTimePeriod** (**common:ReportingTimePeriodType**, a union of **ReportingYear**, **ReportingSemester**, **ReportingTrimester**, **ReportingQuarter**, **ReportingMonth**, **ReportingWeek**, and **ReportingDay**).

49

* **ReportingYear** (**common:ReportingYearType**)

50

* **ReportingSemester** (**common:ReportingSemesterType**)

51

* **ReportingTrimester** (**common:ReportingTrimesterType**)

52

* **ReportingQuarter** (**common:ReportingQuarterType**)

53

* **ReportingMonth** (**common:ReportingMonthType**)

54

* **ReportingWeek** (**common:ReportingWeekType**)

55

* **ReportingDay** (**common:ReportingDayType**)

56

* **XHTML** (**common:StructuredText**, allows for multi-lingual text content that has **XHTML** markup)

57

* **KeyValues** (**common:DataKeyType**)

58

* **IdentifiableReference** (types for each IdentifiableObject)

59

* **GeospatialInformation** (a geo feature set, according to the pattern in section 7.2)

60

61

Data types also have a set of [[facets>>doc:sdmx:Glossary.Facet.WebHome]]:

62

63

* **isSequence = true | false** (indicates a sequentially increasing value)

64

* **minLength = positive integer** (# of characters/digits)

65

* **maxLength = positive integer** (# of characters/digits)

66

* **startValue = decimal** (for numeric sequence)

67

* **endValue = decimal** (for numeric sequence)

68

* **interval = decimal** (for numeric sequence) • **timeInterval = duration**

69

* **startTime = BasicTimePeriod** (for time range)

70

* **endTime = BasicTimePeriod** (for time range)

71

* **minValue = decimal** (for numeric range)

72

* **maxValue = decimal** (for numeric range)

73

* **decimal = Integer** (# of digits to right of decimal point)

74

* **pattern =** (a regular expression, as per W3C XML Schema)

75

* **isMultiLingual = boolean** (for specifying text can occur in more than one language)

76

77

Note that [[code lists>>doc:sdmx:Glossary.Code list.WebHome]] may also have textual [[representations>>doc:sdmx:Glossary.Representation.WebHome]] assigned to them, in addition to their enumeration of [[codes>>doc:sdmx:Glossary.Code.WebHome]].

78

79

=== 4.1.1 Data Types ===

80

81

XML and JSON schemas support a variety of data types that, although rich, are not mapped one-to-one in all cases. This section provides an explanation of the mapping performed in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, between such cases.

82

83

For identifiers, text fields and [[Codes>>doc:sdmx:Glossary.Code.WebHome]] there are no restriction from either side, since a generic type (e.g., that of string) accompanied by the proper regular expression works equally well for both XML and JSON.

84

85

For example, for the id type, this is the XML schema definition:

86

87

> <xs:simpleType name="IDType">

88

> <xs:restriction base="NestedIDType">

89

> <xs:pattern value="[A-Za-z0-9_@$\-]+"/>

> </xs:restriction>

> </xs:simpleType>

Where the NestedIDType is also a restriction of string.

94

95

The above looks like this, in JSON schema:

> "idType": {

> "type": "string",

> "pattern": "^[A-Za-z0-9_@$-]+$"

100

> }

101

102

There are also cases, though, that data types cannot be mapped like above. One such case is the array data type, which was introduced in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 as a new [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. In JSON schema an array is already natively foreseen, while in the XML schema, this has to be defined as a complex type, with an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specific definition (i.e., specific element/[[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] names for [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]). Beyond that, the minimum and/or maximum number of items within an array is possible in both cases.

103

104

Further to the above, the mapping between the non-native data types is presented in the table below:

105

106

(% style="width:1005.83px" %)

107

|(% style="width:198px" %)**SDMX Facet**|(% style="width:241px" %)**XML Schema**|(% style="width:563px" %)**JSON schema **"**pattern**"{{footnote}}Regular expressions, as specified in W3C XML Schema Definition Language (XSD) 1.1 Part 2: Datatypes.{{/footnote}} **for "string" type**

108

|(% style="width:198px" %)GregorianYear|(% style="width:241px" %)xsd:gYear|(% style="width:563px" %)(((

109

"^-?([1-9][0-9]{3,}|0[0-9]{3})(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

110

)))

111

|(% style="width:198px" %)GregorianMonth|(% style="width:241px" %)xsd:gYearMonth|(% style="width:563px" %)(((

112

"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

113

)))

114

|(% style="width:198px" %)GregorianDay|(% style="width:241px" %)xsd:date|(% style="width:563px" %)(((

115

"^-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

116

)))

117

|(% style="width:198px" %)Day|(% style="width:241px" %)xsd:gDay|(% style="width:563px" %)(((

118

"^~-~--(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

119

)))

120

|(% style="width:198px" %)MonthDay|(% style="width:241px" %)xsd:gMonthDay|(% style="width:563px" %)(((

121

"^~-~-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

122

)))

123

|(% style="width:198px" %)Month|(% style="width:241px" %)xsd:Month|(% style="width:563px" %)(((

124

"^~-~-(0[1-9]|1[0-2])(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?$"

125

)))

126

|(% style="width:198px" %)Duration|(% style="width:241px" %)xsd:duration|(% style="width:563px" %)(((

127

"^-?P[0-9]+Y?([0-9]+M)?([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+(\.[0-9]+)?S)?)?$"

128

)))

129

130

== 4.2 Time and Time Format ==

131

132

This section does not go into great detail on these topics but provides a useful overview of these features to assist implementors in further use of the parts of the specification which are relevant to them.

133

134

=== 4.2.1 Introduction ===

135

136

First, it is important to recognize that most observation times are a period. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] specifies precisely how Time is handled.

137

138

The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time is broken into a hierarchical collection of [[representations>>doc:sdmx:Glossary.Representation.WebHome]]. A [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] can use of any of the [[representations>>doc:sdmx:Glossary.Representation.WebHome]] in the [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] as the [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time. This allows for the time [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of a particular [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] allow for only a subset of the default [[representation>>doc:sdmx:Glossary.Representation.WebHome]].

139

140

The [[hierarchy>>doc:sdmx:Glossary.Hierarchy.WebHome]] of [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] is as follows (**bold** indicates a [[category>>doc:sdmx:Glossary.Category.WebHome]] which is made up of multiple formats, //italic// indicates a distinct format):

141

142

* **Observational [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**

143

** **Standard [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**

144

*** **Basic [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**

145

**** **Gregorian [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**

146

**** //Date Time//

147

*** **Reporting [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]**

148

** //Time Range//

149

150

The details of these [[time period>>doc:sdmx:Glossary.Time period.WebHome]] [[categories>>doc:sdmx:Glossary.Category.WebHome]] and of the distinct formats which make them up are detailed in the sections to follow.

151

152

=== 4.2.2 Observational Time Period ===

153

154

This is the superset of all time [[representations>>doc:sdmx:Glossary.Representation.WebHome]] in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]. This allows for time to be expressed as any of the allowable formats.

155

156

=== 4.2.3 Standard Time Period ===

157

158

This is the superset of any predefined [[time period>>doc:sdmx:Glossary.Time period.WebHome]] or a distinct point in time. A [[time period>>doc:sdmx:Glossary.Time period.WebHome]] consists of a distinct start and end point. If the start and end of a period are expressed as date instead of a complete date time, then it is implied that the start of the period is the beginning of the start day (i.e. 00:00:00) and the end of the period is the end of the end day (i.e. 23:59:59).

159

160

=== 4.2.4 Gregorian Time Period ===

161

162

A Gregorian [[time period>>doc:sdmx:Glossary.Time period.WebHome]] is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The [[representation>>doc:sdmx:Glossary.Representation.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] messages and the period covered by each of the Gregorian [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] are as follows:

163

164

**Gregorian Year:**

165

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:gYear (YYYY)

166

Period: the start of January 1 to the end of December 31

167

**Gregorian Year Month**:

168

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:gYearMonth (YYYY-MM)

169

Period: the start of the first day of the month to end of the last day of the month

170

**Gregorian Day**:

171

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:date (YYYY-MM-DD)

172

Period: the start of the day (00:00:00) to the end of the day (23:59:59)

173

174

=== 4.2.5 Date Time ===

175

176

This is used to unambiguously state that a date-time represents an observation at a single point in time. Therefore, if one wants to use [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] for data which is measured at a distinct point in time rather than being reported over a period, the date-time [[representation>>doc:sdmx:Glossary.Representation.WebHome]] can be used.

177

178

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: xs:dateTime (YYYY-MM-DDThh:mm:ss){{footnote}}The seconds can be reported fractionally{{/footnote}}

179

180

=== 4.2.6 Standard Reporting Period ===

181

182

Standard reporting periods are periods of time in relation to a reporting year. Each of these standard reporting periods has a duration (based on the ISO 8601 definition) associated with it. The general format of a reporting period is as follows:

183

184

[REPORTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE]

Where:

REPORTING_YEAR represents the reporting year as four digits (YYYY) PERIOD_INDICATOR identifies the type of period which determines the duration of the period

189

PERIOD_VALUE indicates the actual period within the year

190

191

The following section details each of the standard reporting periods defined in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]:

**Reporting Year**:

Period Indicator: A

Period Duration: P1Y (one year)

196

Limit per year: 1

197

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)

198

**Reporting Semester:**

199

Period Indicator: S

200

Period Duration: P6M (six months)

201

Limit per year: 2

202

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)

203

**Reporting Trimester:**

204

Period Indicator: T

205

Period Duration: P4M (four months)

206

Limit per year: 3

207

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)

208

**Reporting Quarter:**

209

Period Indicator: Q

210

Period Duration: P3M (three months)

211

Limit per year: 4

212

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)

213

**Reporting Month**:

214

Period Indicator: M

215

Period Duration: P1M (one month)

216

Limit per year: 1

217

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingMonthType (YYYY-Mmm, e.g. 2000-M12) Notes: The reporting month is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.

218

**Reporting Week**:

219

Period Indicator: W

220

Period Duration: P7D (seven days)

221

Limit per year: 53

222

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)

223

Notes: There are either 52 or 53 weeks in a reporting year. This is based on the ISO 8601 definition of a week (Monday - Saturday), where the first week of a reporting year is defined as the week with the first Thursday on or after the reporting year start day.{{footnote}}ISO 8601 defines alternative definitions for the first week, all of which produce equivalent results. Any of these definitions could be substituted so long as they are in

224

relation to the reporting year start day.{{/footnote}} The reporting week is always represented as two digits, therefore 1-9 are 0 padded (e.g. 01). This allows the values to be sorted chronologically using textual sorting methods.

225

**Reporting Day**:

226

Period Indicator: D

227

Period Duration: P1D (one day)

228

Limit per year: 366

229

[[Representation>>doc:sdmx:Glossary.Representation.WebHome]]: common:ReportingDayType (YYYY-Dddd, e.g. 2000-D366) Notes: There are either 365 or 366 days in a reporting year, depending on whether the reporting year includes leap day (February 29). The reporting day is always represented as three digits, therefore 1-99 are 0 padded (e.g. 001). This allows the values to be sorted chronologically using textual sorting methods.

230

The meaning of a reporting year is always based on the start day of the year and requires that the reporting year is expressed as the year at the start of the period. This start day is always the same for a reporting year, and is expressed as a day and a month (e.g. July 1). Therefore, the reporting year 2000 with a start day of July 1 begins on July 1, 2000.

231

232

A specialized [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] (reporting year start day) exists for the purpose of communicating the reporting year start day. This [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] exists in specialized sub-class, it functions the same as any other [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] outside of its identification and [[representation>>doc:sdmx:Glossary.Representation.WebHome]]. It must takes its identity from a [[concept >>doc:Glossary.Concept.WebHome]]and state its relationship with other [[components>>doc:sdmx:Glossary.Component.WebHome]] of the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The ability to state this relationship allows this reporting year start day [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to exist at the appropriate levels of a data message. In the absence of this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this [[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is not necessary.

233

234

Since the duration and the reporting year start day are known for any reporting period, it is possible to relate any reporting period to a distinct calendar period. The actual Gregorian calendar period covered by the reporting period can be computed as follows (based on the standard format of [REPROTING_YEAR]-[PERIOD_INDICATOR][PERIOD_VALUE] and the reporting year start day as [REPORTING_YEAR_START_DAY]):

235

236

**~1. Determine [REPORTING_YEAR_BASE]:**

237

Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).

238

This is the [REPORTING_YEAR_START_DATE]

239

240

a) **If the [PERIOD_INDICATOR] is W:**

241

242

**~1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:**

243

Add[[(% class="wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink wikiinternallink" %)^^~[4~]^^>>path:#_ftn4]](%%) (P3D, P2D, or P1D respectively) to the

244

[REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].

245

246

2. **If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:**

247

248

Add^^4^^ (P0D, -P1D, -P2D, or -P3D respectively) to the

249

[REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].

**b)** **Else:**

The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE].

254

255

**2. Determine [PERIOD_DURATION]:**

256

257

1. If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.

258

1. If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.

259

1. If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.

260

1. If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.

261

1. If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.

262

1. If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.

263

1. If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.

264

1. **Determine [PERIOD_START]:**

265

266

Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add{{footnote}}The rules for adding durations to a date time are described in the W3C XML Schema specification. See http://www.w3.org/TR/xmlschema-2/#adding-durations-todateTimes for further details.{{/footnote}} this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].

267

268

1. **Determine the [PERIOD_END]:**

269

270

Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add^^4^^ this to the [REPORTING_YEAR_BASE] add^^4^^ -P1D. The result is the [PERIOD_END].

271

272

For all of these ranges, the bounds include the beginning of the [PERIOD_START] (i.e. 00:00:00) and the end of the [PERIOD_END] (i.e. 23:59:59).

**Examples:**

**2010-Q2, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**

277

278

1. [REPORTING_YEAR_START_DATE] = 2010-07-01

279

280

b) [REPORTING_YEAR_BASE] = 2010-07-01

281

282

1. [PERIOD_DURATION] = P3M 3. (2-1) * P3M = P3M

283

284

2010-07-01 + P3M = 2010-10-01

285

286

[PERIOD_START] = 2010-10-01

4. 2 * P3M = P6M

2010-07-01 + P6M = 2010-13-01 = 2011-01-01

291

292

2011-01-01 + -P1D = 2010-12-31

293

294

[PERIOD_END] = 2010-12-31

295

296

The actual calendar range covered by 2010-Q2 (assuming the reporting year begins July 1) is 2010-10-01T00:00:00/2010-12-31T23:59:59

297

298

**2011-W36, REPORTING_YEAR_START_DAY = ~-~-07-01 (July 1)**

299

300

1. [REPORTING_YEAR_START_DATE] = 2010-07-01

301

302

a) 2011-07-01 = Friday

303

304

2011-07-01 + P3D = 2011-07-04

305

306

[REPORTING_YEAR_BASE] = 2011-07-04

307

308

1. [PERIOD_DURATION] = P7D 3. (36-1) * P7D = P245D

309

310

2011-07-04 + P245D = 2012-03-05

311

312

[PERIOD_START] = 2012-03-05

4. 36 * P7D = P252D

2011-07-04 + P252D =2012-03-12

317

318

2012-03-12 + -P1D = 2012-03-11

319

320

[PERIOD_END] = 2012-03-11

321

322

The actual calendar range covered by 2011-W36 (assuming the reporting year begins July 1) is 2012-03-05T00:00:00/2012-03-11T23:59:59

323

324

=== 4.2.7 Distinct Range ===

325

326

In the case that the reporting period does not fit into one of the prescribe periods above, a distinct time range can be used. The value of these ranges is based on the ISO 8601 time interval format of start/duration. Start can be expressed as either an ISO 8601 date or a date-time, and duration is expressed as an ISO 8601 duration. However, the duration can only be positive.

327

328

=== 4.2.8 Time Format ===

329

330

In version 2.0 of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] there is a recommendation to use the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] to gives additional information on the way time is represented in the message. Following an appraisal of its usefulness this is no longer required. However, it is still possible, if required , to include the [[time format>>doc:sdmx:Glossary.Time format.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] in [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]].

331

332

(% style="width:890.835px" %)

333

|(% style="width:95px" %)**Code**|(% style="width:793px" %)**Format**

334

|(% style="width:95px" %)OTP|(% style="width:793px" %)Observational [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]: Superset of all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[time formats>>doc:sdmx:Glossary.Time format.WebHome]] (Gregorian [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], Reporting [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]], and Time Range)

335

|(% style="width:95px" %)STP|(% style="width:793px" %)Standard [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]]: Superset of Gregorian and Reporting [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]]

336

|(% style="width:95px" %)GTP|(% style="width:793px" %)Superset of all Gregorian [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]] and date-time

337

|(% style="width:95px" %)RTP|(% style="width:793px" %)Superset of all Reporting [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]]

338

|(% style="width:95px" %)TR|(% style="width:793px" %)(((

339

Time Range: Start time and duration (YYYY-MM-DD(Thh:mm:ss)?/)

340

)))

341

|(% style="width:95px" %)GY|(% style="width:793px" %)Gregorian Year (YYYY)

342

|(% style="width:95px" %)GTM|(% style="width:793px" %)Gregorian Year Month (YYYY-MM)

343

|(% style="width:95px" %)GD|(% style="width:793px" %)Gregorian Day (YYYY-MM-DD)

344

|(% style="width:95px" %)DT|(% style="width:793px" %)Distinct Point: date-time (YYYY-MM-DDThh:mm:ss)

345

|(% style="width:95px" %)RY|(% style="width:793px" %)Reporting Year (YYYY-A1)

346

|(% style="width:95px" %)RS|(% style="width:793px" %)Reporting Semester (YYYY-Ss)

347

|(% style="width:95px" %)RT|(% style="width:793px" %)Reporting Trimester (YYYY-Tt)

348

|(% style="width:95px" %)RQ|(% style="width:793px" %)Reporting Quarter (YYYY-Qq)

349

|(% style="width:95px" %)RM|(% style="width:793px" %)Reporting Month (YYYY-Mmm)

350

|(% style="width:95px" %)RW|(% style="width:793px" %)Reporting Week (YYYY-Www)

351

|(% style="width:95px" %)RD|(% style="width:793px" %)Reporting Day (YYYY-Dddd)

352

353

(% class="wikigeneratedid" id="HTable1:SDMX-MLTimeFormatCodes" %)

354

**Table 1: SDMX-ML Time Format Codes**

355

356

=== 4.2.9 Time Zones ===

357

358

In alignment with ISO 8601, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] allows the specification of a time zone on all [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] and on the reporting year start day. If a time zone is provided on a reporting year start day, then the same time zone (or none) should be reported for each reporting [[time period>>doc:sdmx:Glossary.Time period.WebHome]]. If the reporting year start day and the reporting period time zone differ, the time zone of the reporting period will take precedence. Examples of each format with time zones are as follows (time zone indicated in bold):

359

360

* Time Range (start date): 2006-06-05**-05:00**/P5D

361

* Time Range (start date-time): 2006-06-05T00:00:00**-05:00**/P5D

362

* Gregorian Year: 2006**-05:00**

363

* Gregorian Month: 2006-06**-05:00**

364

* Gregorian Day: 2006-06-05**-05:00**

365

* Distinct Point: 2006-06-05T00:00:00**-05:00**

366

* Reporting Year: 2006-A1**-05:00**

367

* Reporting Semester: 2006-S2**-05:00**

368

* Reporting Trimester: 2006-T2**-05:00**

369

* Reporting Quarter: 2006-Q3**-05:00**

370

* Reporting Month: 2006-M06**-05:00**

371

* Reporting Week: 2006-W23**-05:00**

372

* Reporting Day: 2006-D156**-05:00**

373

* Reporting Year Start Day: 07-01**-05:00**

374

375

According to ISO 8601, a date without a time-zone is considered "local time". [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] assumes that local time is that of the sender of the message. In this version of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], an optional field is added to the sender definition in the header for specifying a time zone. This field has a default value of 'Z' (UTC). This determination of local time applies for all dates in a message.

376

377

=== 4.2.10 Representing Time Spans Elsewhere ===

378

379

It has been possible since [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 2.0 for a [[Component>>doc:sdmx:Glossary.Component.WebHome]] to specify a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] for holding the start time and the duration or two separate XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] based on the underlying [[Component>>doc:sdmx:Glossary.Component.WebHome]] identifier. For example, if REF_PERIOD were given a [[representation>>doc:sdmx:Glossary.Representation.WebHome]] of time span, then in the Compact data format, it would be represented by two XML [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:

380

381

>(% style="font-size:18px" %) <Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>

382

383

can now be represented with this:

384

385

>(% style="font-size:18px" %) <Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>

386

387

=== 4.2.11 Notes on Formats ===

388

389

There is no ambiguity in these formats so that for any given value of time, the [[category>>doc:sdmx:Glossary.Category.WebHome]] of the period (and thus the intended [[time period>>doc:sdmx:Glossary.Time period.WebHome]] range) is always clear. It should also be noted that by utilizing the ISO 8601 format, and a format loosely based on it for the report periods, the values of time can easily be sorted chronologically without additional parsing.

390

391

=== 4.2.12 Effect on Time Ranges ===

392

393

All [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data messages are capable of functioning in a manner similar to SDMXEDI if the [[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] at the observation level is time: the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] for the first observation can be stated and the rest of the observations can omit the time value as it can be derived from the start time and the frequency. Since the frequency can be determined based on the actual format of the time value for everything but distinct points in time and time ranges, this makes is even simpler to process as the interval between time ranges is known directly from the time value.

394

395

=== 4.2.13 Time in Query Messages ===

396

397

When querying for time values, the value of a time parameter can be provided as any of the Observational [[Time Period>>doc:sdmx:Glossary.Time period.WebHome]] formats and must be paired with an operator. This section will detail how systems processing query messages should interpret these parameters.

398

399

Fundamental to processing a time value parameter in a query message is understanding that all [[time periods>>doc:sdmx:Glossary.Time period.WebHome]] should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] for requested parameter is encompassed by the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] resulting from value of the query parameter. The following table details how the operators should be interpreted for any [[time period>>doc:sdmx:Glossary.Time period.WebHome]] provided as a parameter.

400

401

(% style="width:770.835px" %)

402

|(% style="width:220px" %)**Operator**|(% style="width:548px" %)**Rule**

403

|(% style="width:220px" %)Greater Than|(% style="width:548px" %)Any data after the last moment of the period

404

|(% style="width:220px" %)Less Than|(% style="width:548px" %)Any data before the first moment of the period

405

|(% style="width:220px" %)Greater Than or Equal To|(% style="width:548px" %)Any data on or after the first moment of the period

406

|(% style="width:220px" %)Less Than or Equal To|(% style="width:548px" %)Any data on or before the last moment of the period

407

|(% style="width:220px" %)Equal To|(% style="width:548px" %)Any data which falls on or after the first moment of the period and before or on the last moment of the period

408

409

Reporting [[Time Periods>>doc:sdmx:Glossary.Time period.WebHome]] as query parameters are handled like this: any data within the bounds of the reporting period for the year is matched, regardless of the actual start day of the reporting year. In addition, data reported against a normal calendar period is matched if it falls within the bounds of the time parameter based on a reporting year start day of January 1. When determining whether another reporting period falls within the bounds of a report period query parameter, one will have to take into account the actual [[time period>>doc:sdmx:Glossary.Time period.WebHome]] to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.

**Examples:**

**Gregorian Period**

Query Parameter: Greater than 2010

415

Literal Interpretation: Any data where the start period occurs after 2010-1231T23:59:59.

Example Matches:

* 2011 or later

* 2011-01 or later

* 2011-01-01 or later

421

* 2011-01-01/P[Any Duration] or any later start date

422

* 2011-[Any reporting period] (any reporting year start day)

423

* 2010-S2 (reporting year start day ~-~-07-01 or later)

424

* 2010-T3 (reporting year start day ~-~-07-01 or later)

425

* 2010-Q3 or later (reporting year start day ~-~-07-01 or later)

426

* 2010-M07 or later (reporting year start day ~-~-07-01 or later)

427

* 2010-W28 or later (reporting year start day ~-~-07-01 or later)

428

* 2010-D185 or later (reporting year start day ~-~-07-01 or later)

429

430

**Reporting Period**

431

Query Parameter: Greater than or equal to 2010-Q3

432

Literal Interpretation: Any data with a reporting period where the start period is on or after the start period of 2010-Q3 for the same reporting year start day, or and data where the start period is on or after 2010-07-01. Example Matches:

* 2011 or later

* 2010-07 or later

* 2010-07-01 or later

437

* 2010-07-01/P[Any Duration] or any later start date

438

* 2011-[Any reporting period] (any reporting year start day)

439

* 2010-S2 (any reporting year start day)

440

* 2010-T3 (any reporting year start day)

441

* 2010-Q3 or later (any reporting year start day)

442

* 2010-M07 or later (any reporting year start day)

443

* 2010-W27 or later (reporting year start day ~-~-01-01){{footnote}}2010-Q3 (with a reporting year start day of --01-01) starts on 2010-07-01. This is day 4 of week 26, therefore the first week matched is week 27.{{/footnote}}

444

* 2010-D182 or later (reporting year start day ~-~-01-01)

445

* 2010-W28 or later (reporting year start day ~-~-07-01){{footnote}}2010-Q3 (with a reporting year start day of --07-01) starts on 2011-01-01. This is day 6 of week 27, therefore the first week matched is week 28.{{/footnote}}

446

* 2010-D185 or later (reporting year start day ~-~-07-01)

== 4.3 Versioning ==

Versioning operates at the level of versionable and maintainable objects in the [[SDMX information model>>doc:sdmx:Glossary.SDMX Information Model.WebHome]]. Within the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure and MetadataSet messages, there is a well-defined pattern for [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] versioning and referencing. The [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] identifiers are qualified by their (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers – that is, an object with an Agency of "A", and ID of "X" and a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of "1.0.0" is a different object than one with an Agency of "A", an ID of "X", and a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of "1.1.0".

451

452

As of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0, the versioning rules are extended to allow for truly versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] through the implementation of the rules of the well-known practice called "Semantic Versioning" ([[http:~~/~~/semver.org>>https://http:semver.org]]), in addition to the legacy non-restrictive versioning scheme. In addition, the "isFinal" property is removed from //MaintainableArtefact//. According to the legacy versioning, any [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] defined without a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) is equivalent to following the legacy versioning, thus having (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) ‘1.0’.

453

454

=== 4.3.1 Non-versioned artefacts ===

455

456

Indeed, some use cases do not need or are incompatible with versioning for some or all their structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], such as the Agency, [[Data Providers>>doc:sdmx:Glossary.Data provider.WebHome]], Metadata Providers and [[Data Consumer Schemes>>doc:sdmx:Glossary.Data consumer scheme.WebHome]]. These [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] follow the legacy versioning, with a fixed (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) set to ‘1.0’.

457

458

Many existing organisation’s data management systems work with (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%)-less structures and apply ad-hoc [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] governance processes. The new nonversioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will allow supporting those numerous situations, where organisations do not manage (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers.

459

460

=== 4.3.2 Semantically versioned artefacts ===

461

462

Since the purpose of [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] versioning is to allow communicating the structural [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes to data exchange partners and connected systems, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 offers Semantic Versioning (aka SemVer) with a clear and unambiguous syntax to all semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 structural [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. Semantic versioning will thus better respond to situations where the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard itself is the only structural contract between [[data providers>>doc:sdmx:Glossary.Data provider.WebHome]] and [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]] and where changes in structures can only be communicated through the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number increases.

463

464

The semantic (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number consists of four parts: MAJOR, MINOR, PATCH and EXTENSION, the first three parts being separated by a dot (.), the last two parts being separated by a hyphen : MAJOR.MINOR.PATCH-EXTENSION. All (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) are ordered.

465

466

The detailed rules for semantic versioning are listed in chapter 14 in the annex for “Semantic Versioning”. In short, they define:

467

468

Given a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number MAJOR.MINOR.PATCH (without EXTENSION), when making changes to that semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one must increment the:

469

470

1. MAJOR (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when backwards incompatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] changes are made,

471

1. MINOR (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] elements are added in a backwards compatible manner, or

472

1. PATCH (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) when backwards compatible [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] property changes are made.

473

474

When incrementing a (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) part, the right-hand side parts are 0-ed (reset to ‘0’).

475

476

Extensions can be added, changed or dropped.

477

478

Given an extended (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) number MAJOR.MINOR.PATCH-EXTENSION, when making changes to that versioned [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], then one is not required to increment the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) if those changes are within the allowed scope of the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment from the previous (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) (if that existed); otherwise, the above (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment rules apply. EXTENSIONs can be used e.g., for drafting or a pre-release.

479

480

Semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] will thus be safe to use. Specific (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) patterns allow them to become either immutable, i.e., the maintainer commits to never change their content, or changeable only within a well-defined scope. If any further change is required, a new (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) must be created first. Furthermore, the impact of the further change is communicated using a clear (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) increment. The built-in (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) extension facility allows for eased drafting of new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%).

481

482

The production (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of [[identifiable artefacts>>doc:sdmx:Glossary.Identifiable artefact.WebHome]] are assumed stable, i.e., they do not have an EXTENSION. This is because once in production, an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] cannot change in any way, or it must change the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%). For cases where an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] is not static, like during the drafting, the (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) must indicate this by including an EXTENSION. Draft [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should not be used outside of a specific system designed to accommodate them. For most purposes, all [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] should become stable before being used in production.

483

484

=== 4.3.3 Legacy-versioned artefacts ===

485

486

Organisations wishing to keep a maximum of backwards compatibility with existing implementations can continue using the previous 2-digit convention for (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) numbers (MAJOR.MINOR) as in the past, such as '2.3', but without the ‘isFinal’ property. The new [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 standard does not add any strict rules or guarantees about changes in those [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], since the legacy versioning rules were rather loose and non-binding, including the meaning of the ‘isFinal’ property, and their implementations were varying.

487

488

In order to make [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] immutable or changes truly predictable, a move to the new semantic versioning syntax is required.

489

490

=== 4.3.4 Dependency management and references ===

491

492

New flexible dependency specifications with wildcarding allow for easier data model maintenance and enhancements for semantically versioned [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. This allows implementing a smart referencing mechanism, whereby an [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] may reference:

493

494

* a fixed (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]

495

* the **latest available** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]

496

* the **latest backward compatible** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]], or the **latest backward and forward** **compatible** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]].

497

498

References not representing a strict [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] dependency, such as the target [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] defined in a MetadataProvisionAgreement allow for linking to **all currently available** (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) of another [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]]. Another illustrative case for such loose referencing is that of (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) and flows. A (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%) may reference many [[Dataflows>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[Metadataflows>>doc:sdmx:Glossary.Metadataflow.WebHome]], the addition of more references to flow objects does not (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) the (% style="color:#e74c3c" %)[[Constraint>>doc:sdmx:Glossary.Constraint.WebHome]](%%). This is because the (% style="color:#e74c3c" %)[[Constraints>>doc:sdmx:Glossary.Constraint.WebHome]](%%) are not properties of the flows – they merely make references to them.

499

500

Semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] must only reference other semantically versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]], which may include extended (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%). Non-versioned and legacy-versioned [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]] can reference any other non-versioned or versioned (whether semantic or legacy) [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]]. The scope of wildcards in references adapts correspondingly.

501

502

The mechanism named "early binding" refers to a dependency on a stable versioned [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] – everything with a stable versioned identity is a known quantity and will not change. The "late binding" mechanism is based on a wildcarded reference, and it resolves that reference and determines the currently related [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] at runtime.

503

504

One area which is much impacted by this versioning scheme is the ability to reference external objects. With the many dependencies within the various structural objects in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]], it is useful to have a scheme for external referencing. This is done at the level of maintainable objects ([[DSD>>doc:sdmx:Glossary.Data structure definition.WebHome]]s, [[Codelists>>doc:sdmx:Glossary.Code list.WebHome]], [[Concept Schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], etc.) In an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message, whenever an "[[isExternalReference>>doc:sdmx:Glossary.isExternalReference.WebHome]]" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is set to true, then the application must resolve the address provided in the associated "uri" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and use the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry "urn" [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] has been provided, the registry can be used to supply the full details of the object.

505

506

The detailed rules for dependency management and references are listed in chapter 14 in the annex for “Semantic Versioning”.

507

508

In order to allow resolving the described new forms of dependencies, the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 3.0 Rest API supports retrievals legacy-versioned, wildcarded and extended [[artefact>>doc:sdmx:Glossary.Artefact.WebHome]] (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%):

509

510

* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for a **specific** (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) (X.Y, X.Y.Z or X.Y.Z-EXT).

511

* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **latest available** semantic (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) within the wildcard scope (X+.Y.Z, X.Y+.Z or X.Y.Z+).

512

* Queries for **non-versioned** [[artefacts>>doc:sdmx:Glossary.Artefact.WebHome]].

513

* [[Artefact>>doc:sdmx:Glossary.Artefact.WebHome]] queries for **all available** semantic (% style="color:#e74c3c" %)[[versions>>doc:sdmx:Glossary.Version.WebHome]](%%) within the wildcard scope (*, X.* or X.Y.*), where only the first form is required for resolving wildcarded loose references.

514

515

The combination of wildcarded queries with a specific (% style="color:#e74c3c" %)[[version>>doc:sdmx:Glossary.Version.WebHome]](%%) extension is not permitted.

516

517

Full details can be found in the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] RESTful web services specification.

518

519

== 4.4 Structural Metadata Querying Best Practices ==

520

521

When querying for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]], the ability to state how references should be resolved is quite powerful. However, this mechanism is not always necessary and can create an undue burden on the systems processing the queries if it is not used properly.

522

523

Any [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a [[category>>doc:sdmx:Glossary.Category.WebHome]] and the object is it categorising. As this is the case, one can query for categorisations which categorise a particular object or which categorise against a particular [[category>>doc:sdmx:Glossary.Category.WebHome]] or [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]]. This mechanism should be used when the referenced object is known.

524

525

When the referenced object is not known, then the reference resolution mechanism could be used. For example, suppose one wanted to find all [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]] and the related categorisations for a given [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]]. In this case, one could query for the [[category scheme>>doc:sdmx:Glossary.Category scheme.WebHome]] by the [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the [[categories>>doc:sdmx:Glossary.Category.WebHome]] in the matched schemes to be returned, as well as the object which they categorise.

----

Wiki source code of 4 General Notes for Implementers