Add non-localised "Value" and localised "URL"s to "Annotation" object

[dosse]

As has been discussed in the recent Guidelines on the use of SDMX Annotations, there are frequent use cases for a non-localised annotation "text" (value) and localised URLs"in Annotations. The "Annotation" object should be enhanced to allow for these use cases. It seems important enough for the inclusion in SDMX 3.0.0.

[sdmx3mdt]

16 June 2021 TWG / SWG public consultation public review meeting Decision: merit in revising various aspects of annotations, but this is not within the planned SDMX 3.0 scope. Action: TF2 to examine the requirement and make a recommendation to TWG.

[sdmx3mdt]

27 July 2021 SDMX TWG approved the enhancement to add non-localised "Value" and localised "URL" to the annotations model. Details are set out in the attached paper. SDMX TWG TF2 - public review issue #34 - Enhancing SDMX artefact annotations.docx

Outstanding actions:

TF2 - update the information model and Section 2 SDMX-ML team - update the XML schemas to reflect the revised model for annotations

[dosse]

Hi @jgager, @sdmx3mdt the SDMX-TWG approved today the conversion of non-localised annotation properties from XML elements to XML attributes and shortening of their names. The following annotation properties are concerned:

• AnnotationTitle --> title
• AnnotationType --> type
• AnnotationURL --> url
• AnnotationValue --> value ------- only shorting of names: ---------
• AnnotationURLs --> URLs
• AnnotationText --> Text

Example:

Change from:

<com:Annotation id="ID">
    <com:AnnotationTitle>TITLE</com:AnnotationTitle>
    <com:AnnotationType>TYPE</com:AnnotationType>
    <com:AnnotationURL>URL</com:AnnotationURL>
    <com:AnnotationURL xml:lang="en">URL-EN</com:AnnotationURL>
    <com:AnnotationText xml:lang="en">TEXT-EN</com:AnnotationText>
    <com:AnnotationValue>VALUE</com:AnnotationValue>
</com:Annotation>

to:

<com:Annotation id="ID" title="TITLE" type="TYPE" value="VALUE">
    <com:URL>URL</com:URL>
    <com:URL xml:lang="en">URL-EN</com:URL>
    <com:Text xml:lang="en">TEXT-EN</com:Text>
</com:Annotation>

Could you please make this change in the SDMX-ML schema files?

Note that the shorter property names were already originally applied in SDMX-JSON: https://github.com/sdmx-twg/sdmx-json/blob/sdmx3.0.0/structure-message/docs/1-sdmx-json-field-guide.md#annotation, thus there is no change necessary in SDMX-JSON.

[sdmx3mdt]

@dosse the change mentioned to modify annotations from XML elements to XML attributes has not been made in the XML schemas because it deviates from the solution described in the Change Request paper and I have no record of it being explicitly approved by the TWG. While issue #34 was discussed at the 02 September 2021 TWG meeting, the minutes only record an action on you to check with J Gager to confirm that the XML schemas had been modified as originally specified - not a decision to alter the solution. A copy of the minutes is attached which have been circulated with no objections or comments received. SDMX 3.0 Release Candidate Approval Meeting 02Sept21 - Outcome.pdf

I recommend that you secure an explicit decision from the TWG to make this change and issue and update to the XML schemas after the SDMX 3.0 release.

[dosse]

@sdmx3mdt That's really a pity. I entered the above comment just after the TWG meeting because my own notes indicated that the move of these annotation properties to XML attributes was agreed but needed only to be checked by me for technical feasibility with J. This is what I did. You have specifically been addressed in this post, and you should have had 2 options:

• include this topic into your meeting notes, because you missed to write it down
• poke me immediately to indicate that I miss-understood and that this wasn't agreed or not even discussed, or whatever you feel is appropriate.

I think that it is incorrect that the comment made in this public consultation channel has not been followed up.