4 General Notes for Implementers
- Contents
- 4.1 Representations
- 4.2 Time and Time Format
- 4.2.1 Introduction
- 4.2.2 Observational Time Period
- 4.2.3 Standard Time Period
- 4.2.4 Gregorian Time Period
- 4.2.5 Date Time
- 4.2.6 Standard Reporting Period
- 4.2.7 Distinct Range
- 4.2.8 Time Format
- 4.2.9 Transformation between SDMX-ML and SDMX-EDI
- 4.2.10 Time Zones
- 4.2.11 Representing Time Spans Elsewhere
- 4.2.12 Notes on Formats
- 4.2.13 Effect on Time Ranges
- 4.2.14 Time in Query Messages
- 4.3 Structural Metadata Querying Best Practices
- 4.4 Versioning and External Referencing
This section discusses a number of topics other than the exchange of data sets in SDMX-ML and SDMX-EDI. Supported only in SDMX-ML, these topics include the use of the reference metadata mechanism in SDMX, the use of Structure Sets and Reporting Taxonomies, the use of Processes, a discussion of time and data-typing, and some of the conventional mechanisms within the SDMX-ML Structure message regarding versioning and external referencing.
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.
4.1 Representations
There are several different representations in SDMX-ML, taken from XML Schemas and common programming languages. The table below describes the various representations which are found in SDMX-ML, and their equivalents.
SDMX-ML Data Type XML Schema Data Type .NET Framework Type Java Data Type
String xsd:string System.String java.lang.String Big Integer xsd:integer System.Decimal java.math.BigInteg er Integer xsd:int System.Int32 int Long xsd.long System.Int64 long Short xsd:short System.Int16 short Decimal xsd:decimal System.Decimal java.math.BigDecim al Float xsd:float System.Single float Double xsd:double System.Double double Boolean xsd:boolean System.Boolean boolean URI xsd:anyURI System.Uri Java.net.URI or java.lang.String DateTime xsd:dateTime System.DateTime javax.xml.datatype .XMLGregorianCalen dar Time xsd:time System.DateTime javax.xml.datatype .XMLGregorianCalen dar GregorianYear xsd:gYear System.DateTime javax.xml.datatype .XMLGregorianCalen dar GregorianMonth xsd:gYearMonth System.DateTime javax.xml.datatype .XMLGregorianCalen dar GregorianDay xsd:date System.DateTime javax.xml.datatype .XMLGregorianCalen dar Day, MonthDay, Month
xsd:g* System.DateTime javax.xml.datatype .XMLGregorianCalen dar Duration xsd:duration System.TimeSpa javax.xml.datatype n .Duration There are also a number of SDMX-ML data types which do not have these direct correspondences, often because they are composite representations or restrictions of a broader data type. For most of these, there are simple types which can be referenced from the SDMX schemas, for others a derived simple type will be necessary:
- AlphaNumeric (common:AlphaNumericType, string which only allows A-z and 0-9)
- Alpha (common:AlphaType, string which only allows A-z)
- Numeric (common:NumericType, string which only allows 0-9, but is not numeric so that is can having leading zeros)
- Count (xs:integer, a sequence with an interval of “1”)
- InclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
- ExclusiveValueRange (xs:decimal with the minValue and maxValue facets supplying the bounds)
- Incremental (xs:decimal with a specified interval; the interval is typically enforced outside of the XML validation)
- TimeRange (common:TimeRangeType, start DateTime + Duration,)
- ObservationalTimePeriod (common: ObservationalTimePeriodType, a union of StandardTimePeriod and TimeRange).
- StandardTimePeriod (common: StandardTimePeriodType, a union of BasicTimePeriod and TimeRange).
- BasicTimePeriod (common: BasicTimePeriodType, a union of GregorianTimePeriod and DateTime)
- GregorianTimePeriod (common:GregorianTimePeriodType, a union of GregorianYear, GregorianMonth, and GregorianDay)
- ReportingTimePeriod (common:ReportingTimePeriodType, a union of ReportingYear, ReportingSemester, ReportingTrimester, ReportingQuarter, ReportingMonth, ReportingWeek, and ReportingDay). ReportingYear (common:ReportingYearType)
- ReportingSemester (common:ReportingSemesterType)
- ReportingTrimester (common:ReportingTrimesterType)
- ReportingQuarter (common:ReportingQuarterType)
- ReportingMonth (common:ReportingMonthType)
- ReportingWeek (common:ReportingWeekType)
- ReportingDay (common:ReportingDayType)
- XHTML (common:StructuredText, allows for multi-lingual text content that has XHTML markup)
- KeyValues (common:DataKeyType)
- IdentifiableReference (types for each identifiable object)
- DataSetReference (common:DataSetReferenceType)
- AttachmentConstraintReference (common:AttachmentConstraintReferenceType)
Data types also have a set of facets:
- isSequence = true | false (indicates a sequentially increasing value)
- minLength = positive integer (# of characters/digits)
- maxLength = positive integer (# of characters/digits)
- startValue = decimal (for numeric sequence)
- endValue = decimal (for numeric sequence)
- interval = decimal (for numeric sequence)
- timeInterval = duration
- startTime = BasicTimePeriod (for time range)
- endTime = BasicTimePeriod (for time range)
- minValue = decimal (for numeric range)
- maxValue = decimal (for numeric range)
- decimal = Integer (# of digits to right of decimal point)
- pattern = (a regular expression, as per W3C XML Schema)
- isMultiLingual = boolean (for specifying text can occur in more than one language)
Note that code lists may also have textual representations assigned to them, in addition to their enumeration of codes.s
4.2 Time and Time Format
4.2.1 Introduction
First, it is important to recognize that most observation times are a period. SDMX specifies precisely how Time is handled.
The representation of time is broken into a hierarchical collection of representations. A data structure definition can use of any of the representations in the hierarchy as the representation of time. This allows for the time dimension of a particular data structure definition allow for only a subset of the default representation.
The hierarchy of time formats is as follows (bold indicates a category which is made up of multiple formats, italic indicates a distinct format):
- Observational Time Period
- Standard Time Period
- Basic Time Period
- Gregorian Time Period
- Date Time
- Reporting Time Period
- Basic Time Period
- Time Range
- Standard Time Period
The details of these time period categories and of the distinct formats which make them up are detailed in the sections to follow.
4.2.2 Observational Time Period
This is the superset of all time representations in SDMX. This allows for time to be expressed as any of the allowable formats.
4.2.3 Standard Time Period
This is the superset of any predefined time period or a distinct point in time. A time period 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).
4.2.4 Gregorian Time Period
A Gregorian time period is always represented by a Gregorian year, year-month, or day. These are all based on ISO 8601 dates. The representation in SDMX-ML messages and the period covered by each of the Gregorian time periods are as follows:
Gregorian Year:
Representation: xs:gYear (YYYY)
Period: the start of January 1 to the end of December 31Gregorian Year Month:
Representation: xs:gYearMonth (YYYY-MM)
Period: the start of the first day of the month to end of the last day of the monthGregorian Day:
Representation: xs:date (YYYY-MM-DD)
Period: the start of the day (00:00:00) to the end of the day (23:59:59)4.2.5 Date Time
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 for data which is measured at a distinct point in time rather than being reported over a period, the date-time representation can be used.
Representation: xs:dateTime (YYYY-MM-DDThh:mm:ss)1
4.2.6 Standard Reporting Period
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:
[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
PERIOD_VALUE indicates the actual period within the yearThe following section details each of the standard reporting periods defined in SDMX:
Reporting Year:
Period Indicator: A
Period Duration: P1Y (one year)
Limit per year: 1
Representation: common:ReportingYearType (YYYY-A1, e.g. 2000-A1)Reporting Semester:
Period Indicator: S
Period Duration: P6M (six months)
Limit per year: 2
Representation: common:ReportingSemesterType (YYYY-Ss, e.g. 2000-S2)Reporting Trimester:
Period Indicator: T
Period Duration: P4M (four months)
Limit per year: 3
Representation: common:ReportingTrimesterType (YYYY-Tt, e.g. 2000-T3)Reporting Quarter:
Period Indicator: Q
Period Duration: P3M (three months)
Limit per year: 4
Representation: common:ReportingQuarterType (YYYY-Qq, e.g. 2000-Q4)Reporting Month:
Period Indicator: M
Period Duration: P1M (one month)
Limit per year: 1
Representation: 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.Reporting Week:
Period Indicator: W
Period Duration: P7D (seven days)
Limit per year: 53
Representation: common:ReportingWeekType (YYYY-Www, e.g. 2000-W53)
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.2 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.Reporting Day:
Period Indicator: D
Period Duration: P1D (one day)
Limit per year: 366
Representation: 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.
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.
A specialized attribute (reporting year start day) exists for the purpose of communicating the reporting year start day. This attribute has a fixed identifier (REPORTING_YEAR_START_DAY) and a fixed representation (xs:gMonthDay) so that it can always be easily identified and processed in a data message. Although this attribute exists in specialized sub-class, it functions the same as any other attribute outside of its identification and representation. It must takes its identity from a concept and state its relationship with other components of the data structure definition. The ability to state this relationship allows this reporting year start day attribute to exist at the appropriate levels of a data message. In the absence of this attribute, the reporting year start date is assumed to be January 1; therefore if the reporting year coincides with the calendar year, this Attribute is not necessary.
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]):
1. Determine [REPORTING_YEAR_BASE]:
Combine [REPORTING_YEAR] of the reporting period value (YYYY) with [REPORTING_YEAR_START_DAY] (MM-DD) to get a date (YYYY-MM-DD).
This is the [REPORTING_YEAR_START_DATE]
a) If the [PERIOD_INDICATOR] is W:
1. If [REPORTING_YEAR_START_DATE] is a Friday, Saturday, or Sunday:
Add3 (P3D, P2D, or P1D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].2. If [REPORTING_YEAR_START_DATE] is a Monday, Tuesday, Wednesday, or Thursday:
Add3 (P0D, -P1D, -P2D, or -P3D respectively) to the [REPORTING_YEAR_START_DATE]. The result is the [REPORTING_YEAR_BASE].
b) Else:
The [REPORTING_YEAR_START_DATE] is the [REPORTING_YEAR_BASE]2. Determine [PERIOD_DURATION]:
a) If the [PERIOD_INDICATOR] is A, the [PERIOD_DURATION] is P1Y.
b) If the [PERIOD_INDICATOR] is S, the [PERIOD_DURATION] is P6M.
c) If the [PERIOD_INDICATOR] is T, the [PERIOD_DURATION] is P4M.
d) If the [PERIOD_INDICATOR] is Q, the [PERIOD_DURATION] is P3M.
e) If the [PERIOD_INDICATOR] is M, the [PERIOD_DURATION] is P1M.
f) If the [PERIOD_INDICATOR] is W, the [PERIOD_DURATION] is P7D.
g) If the [PERIOD_INDICATOR] is D, the [PERIOD_DURATION] is P1D.3. Determine [PERIOD_START]:
Subtract one from the [PERIOD_VALUE] and multiply this by the [PERIOD_DURATION]. Add3 this to the [REPORTING_YEAR_BASE]. The result is the [PERIOD_START].
4. Determine the [PERIOD_END]:
Multiply the [PERIOD_VALUE] by the [PERIOD_DURATION]. Add4 this to the [REPORTING_YEAR_BASE] add5 -P1D. The result is the [PERIOD_END].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)
1. [REPORTING_YEAR_START_DATE] = 2010-07-01
b) [REPORTING_YEAR_BASE] = 2010-07-01
[PERIOD_DURATION] = P3M
(2-1) * P3M = P3M
2010-07-01 + P3M = 2010-10-01
[PERIOD_START] = 2010-10-01
4. 2 * P3M = P6M
2010-07-01 + P6M = 2010-13-01 = 2011-01-01
2011-01-01 + -P1D = 2010-12-31
[PERIOD_END] = 2011-12-31The 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
2011-W36, REPORTING_YEAR_START_DAY = --07-01 (July 1)
1. [REPORTING_YEAR_START_DATE] = 2010-07-01
a) 2011-07-01 = Friday
2011-07-01 + P3D = 2011-07-04
[REPORTING_YEAR_BASE] = 2011-07-04
2. [PERIOD_DURATION] = P7D
3. (36-1) * P7D = P245D
2011-07-04 + P245D = 2012-03-05
[PERIOD_START] = 2012-03-05
4. 36 * P7D = P252D
2011-07-04 + P252D =2012-03-12
2012-03-12 + -P1D = 2012-03-11
[PERIOD_END] = 2012-03-11The 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
4.2.7 Distinct Range
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 postive.
4.2.8 Time Format
In version 2.0 of SDMX there is a recommendation to use the time format attribute 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 attribute in SDMX-ML.
Code Format OTP Observational Time Period: Superset of all SDMX time formats (Gregorian Time Period, Reporting Time Period, and Time Range) STP Standard Time Period: Superset of Gregorian and Reporting Time Periods GTP Superset of all Gregorian Time Periods and date-time RTP Superset of all Reporting Time Periods TR Time Range: Start time and duration (YYYY-MMDD(Thh:mm:ss)?/) GY Gregorian Year (YYYY) GTM Gregorian Year Month (YYYY-MM) GD Gregorian Day (YYYY-MM-DD) DT Distinct Point: date-time (YYYY-MM-DDThh:mm:ss) RY Reporting Year (YYYY-A1) RS Reporting Semester (YYYY-Ss) RT Reporting Trimester (YYYY-Tt) RQ Reporting Quarter (YYYY-Qq) RM Reporting Month (YYYY-Mmm) Code Format RW Reporting Week (YYYY-Www) RD Reporting Day (YYYY-Dddd) Table 1: SDMX-ML Time Format Codes
4.2.9 Transformation between SDMX-ML and SDMX-EDI
When converting SDMX-ML data structure definitions to SDMX-EDI data structure definitions, only the identifier of the time format attribute will be retained. The representation of the attribute will be converted from the SDMX-ML format to the fixed SDMX-EDI code list. If the SDMX-ML data structure definition does not define a time format attribute, then one will be automatically created with the identifier "TIME_FORMAT".
When converting SDMX-ML data to SDMX-EDI, the source time format attribute will be irrelevant. Since the SDMX-ML time representation types are not ambiguous, the target time format can be determined from the source time value directly. For example, if the SDMX-ML time is 2000-Q2 the SDMX-EDI format will always be 608/708 (depending on whether the target series contains one observation or a range of observations).
When converting a data structure definition originating in SDMX-EDI, the time format attribute should be ignored, as it serves no purpose in SDMX-ML.
When converting data from SDMX-EDI to SDMX-ML, the source time format is only necessary to determine the format of the target time value. For example, a source time format of will result in a target time in the format YYYY-Ss whereas a source format of will result in a target time value in the format YYYY-Qq.
4.2.10 Time Zones
In alignment with ISO 8601, SDMX allows the specification of a time zone on all time periods 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. 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):
- Time Range (start date): 2006-06-05-05:00/P5D
- Time Range (start date-time): 2006-06-05T00:00:00-05:00/P5D
- Gregorian Year: 2006-05:00
- Gregorian Month: 2006-06-05:00
- Gregorian Day: 2006-06-05-05:00
- Distinct Point: 2006-06-05T00:00:00-05:00
- Reporting Year: 2006-A1-05:00
- Reporting Semester: 2006-S2-05:00
- Reporting Trimester: 2006-T2-05:00
- Reporting Quarter: 2006-Q3-05:00
- Reporting Month: 2006-M06-05:00
- Reporting Week: 2006-W23-05:00
- Reporting Day: 2006-D156-05:00
- Reporting Year Start Day: 07-01-05:00
According to ISO 8601, a date without a time-zone is considered "local time". SDMX assumes that local time is that of the sender of the message. In this version of SDMX, 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.
4.2.11 Representing Time Spans Elsewhere
It has been possible since SDMX 2.0 for a Component to specify a representation of a time span. Depending on the format of the data message, this resulted in either an element with 2 XML attributes for holding the start time and the duration or two separate XML attributes based on the underlying Component identifier. For example if REF_PERIOD were given a representation of time span, then in the Compact data format, it would be represented by two XML attributes; REF_PERIODStartTime (holding the start) and REF_PERIOD (holding the duration). If a new simple type is introduced in the SDMX schemas that can hold ISO 8601 time intervals, then this will no longer be necessary. What was represented as this:
<Series REF_PERIODStartTime="2000-01-01T00:00:00" REF_PERIOD="P2M"/>
can now be represented with this:
<Series REF_PERIOD="2000-01-01T00:00:00/P2M"/>
4.2.12 Notes on Formats
There is no ambiguity in these formats so that for any given value of time, the category of the period (and thus the intended time period 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.
4.2.13 Effect on Time Ranges
All SDMX-ML data messages are capable of functioning in a manner similar to SDMX-EDI if the Dimension at the observation level is time: the time period 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.
4.2.14 Time in Query Messages
When querying for time values, the value of a time parameter can be provided as any of the Observational Time Period formats and must be paired with an operator. In addition, an explicit value for the reporting year start day can be provided, or this can be set to "Any". This section will detail how systems processing query messages should interpret these parameters.
Fundamental to processing a time value parameter in a query message is understanding that all time periods should be handled as a distinct range of time. Since the time parameter in the query is paired with an operator, this is also effectively represents a distinct range of time. Therefore, a system processing the query must simply match the data where the time period for requested parameter is encompassed by the time period resulting from value of the query parameter. The following table details how the operators should be interpreted for any time period provided as a parameter.
Operator Rule Greater Than Any data after the last moment of the period Less Than Any data before the first moment of the period Greater Than or Equal To Any data on or after the first moment of the period
Less Than or Equal To Any data on or before the last moment of the period Equal To Any data which falls on or after the first moment of the period and before or on the last moment of the period Reporting Time Periods as query parameters are handled based on whether the value of the reportingYearStartDay XML attribute is an explicit month and day or "Any":
If the time parameter provides an explicit month and day value for the reportingYearStartDay XML attribute, then the parameter value is converted to a distinct range and processed as any other time period would be processed.
If the reportingYeartStartDay XML attribute has a value of "Any", then 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 to compare weeks and days to higher order report periods. This will be demonstrated in the examples to follow.
Note that the reportingYearStartDay XML attribute on the time value parameter is only used to qualify a reporting period value for the given time value parameter. The usage of this is different than using the attribute value parameter for the actual reporting year start day attribute. In the case that the attribute value parameters is used for the reporting year start day data structure attribute, it will be treated as any other attribute value parameter; data will be filtered to that which matches the values specified for the given attribute. For example, if the attribute value parameter references the reporting year start day attribute and specifies a value of "07-01", then only data which has this attribute with the value "07-01" will be returned. In terms of processing any time value parameters, the value supplied in the attribute value parameter will be irrelevant.
Examples:
Gregorian Period
Query Parameter: Greater than 2010
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
- 2011-01-01/P[Any Duration] or any later start date
- 2011-[Any reporting period] (any reporting year start day)
- 2010-S2 (reporting year start day --07-01 or later)
- 2010-T3 (reporting year start day --07-01 or later)
- 2010-Q3 or later (reporting year start day --07-01 or later)
- 2010-M07 or later (reporting year start day --07-01 or later)
- 2010-W28 or later (reporting year start day --07-01 or later)
- 2010-D185 or later (reporting year start day --07-01 or later)
Reporting Period with explicit start day
Query Parameter: Greater than or equal to 2009-Q3, reporting year start day = "-07-01"
Literal Interpretation: Any data where the start period occurs on after 2010-0101T00:00:00 (Note that in this case 2009-Q3 is converted to the explicit date range of 2010-01-01/2010-03-31 because of the reporting year start day value). Example Matches: Same as previous exampleReporting Period with "Any" start day
Query Parameter: Greater than or equal to 2010-Q3, reporting year start day = "Any"
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
- 2010-07-01/P[Any Duration] or any later start date
- 2011-[Any reporting period] (any reporting year start day)
- 2010-S2 (any reporting year start day)
- 2010-T3 (any reporting year start day)
- 2010-Q3 or later (any reporting year start day)
- 2010-M07 or later (any reporting year start day)
- 2010-W27 or later (reporting year start day --01-01)6
- 2010-D182 or later (reporting year start day --01-01)
- 2010-W28 or later (reporting year start day --07-01)7
- 2010-D185 or later (reporting year start day --07-01)
4.3 Structural Metadata Querying Best Practices
When querying for structural metadata, 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.
Any structural metadata object which contains a reference to an object can be queried based on that reference. For example, a categorisation references both a category 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 or category scheme. This mechanism should be used when the referenced object is known.
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 and the related categorisations for a given maintenance agency. In this case, one could query for the category scheme by the maintenance agency and specify that parent and sibling references should be resolved. This would result in the categorisations which reference the categories in the matched schemes to be returned, as well as the object which they categorise.
4.4 Versioning and External Referencing
Within the SDMX-ML Structure Message, there is a pattern for versioning and external referencing which should be pointed out. The identifiers are qualified by their version numbers – that is, an object with an Agency of “A”, and ID of “X” and a version of “1.0” is a different object than one with an Agency of “A’, an ID of “X”, and a version of “1.1”.
The production versions of identifiable objects/resources are assumed to be static – that is, they have their isFinal attribute set to ‘true”. Once in production, and object cannot change in any way, or it must be versioned. For cases where an object is not static, the isFinal attribute must have a value of “false”, but non-final objects should not be used outside of a specific system designed to accommodate them. For most purposes, all objects should be declared final before use in production.
This mechanism is an “early binding” one – everything with a versioned identity is a known quantity, and will not change. It is worth pointing out that in some cases relationships are essentially one-way references: an illustrative case is that of Categories. While a Category may be referenced by many dataflows and metadata flows, the addition of more references from flow objects does not version the Category. This is because the flows are not properties of the Categories – they merely make references to it. If the name of a Category changed, or its subCategories changed, then versioning would be necessary.
Versioning operates at the level of versionable and maintainable objects in the SDMX information model. If any of the children of objects at these levels change, then the objects themselves are versioned.
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, it is useful to have a scheme for external referencing. This is done at the level of maintainable objects (DSDs, code lists, concept schemes, etc.) In an SDMX-ML Structure Message, whenever an “isExternalReference” attribute is set to true, then the application must resolve the address provided in the associated “uri” attribute and use the SDMX-ML Structure Message stored at that location for the full definition of the object in question. Alternately, if a registry “urn” attribute has been provided, the registry can be used to supply the full details of the object.
Because the version number is part of the identifier for an object, versions are a necessary part of determining that a given resource is the one which was called for. It should be noted that whenever a version number is not supplied, it is assumed to be “1.0”. (The “x.x” versioning notation is conventional in practice with SDMX, but not required.)
- ^ The seconds can be reported fractionally
- ^ 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 relation to the reporting year start day.
- ^ 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-to-dateTimes for further details.
- ^ 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-to-dateTimes for further details.
- ^ 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-to-dateTimes for further details.
- ^ 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. - ^ 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.