5.1 Annotations

The SDMX Constructor is a powerful tool that supports various types of SDMX artefact annotations, similar to what the .Stat Suite offers (see SDMX annotations supported by the .Stat Suite here: https://sis-cc.gitlab.io/dotstatsuite-documentation/using-de/sdmx-annotations/).

Annotations in the SDMX framework are constructs that allow the user or organisation-specific metadata to be included. These annotations can be applied to a wide range of SDMX structural metadata artefacts, offering flexibility and customisation options.

The main advantage of annotation functionality within the SDMX Constructor is its adaptability. This flexibility is highly advantageous, especially for applications such as dissemination tools where custom metadata is crucial.

By leveraging the SDMX Constructor’s support for annotations, users can enrich their data with additional information that goes beyond the standardised SDMX elements. These annotations can include context-specific details, explanations, or additional attributes relevant to the specific use case.

A walkthrough

For instance, an organisation may annotate a dataset with details about the dimensions to be presented in rows and columns of a presentation table or specify the default filters in the user interface of the dissemination interface. These annotations provide valuable context, enhance the understanding and interpretation of the data, and improve the dissemination tool’s efficiency.

Take an example within the ILOSTAT (https://data.ilo.org/), which is built using .Stat Suite. You can choose the following indicator - Labour force by sex, age and education - here. Note that in the resulting display, there are default filters applied (for example, for ‘Frequency’, it is Annual; for ‘Sex’, it is Total; and for ‘Age’, it is Youth and Adults (15+). Also, in the ‘Table’ view, you may notice that the country names (Reference area) and years (Time period) are in the rows and education levels are in the columns of the table. Such a specific display/interface is a result of the annotation settings.

You can use the SDMX Constructor (as a back-end tool for the .Stat Suite) to specify such behaviour of loading and displaying data through its annotation functionality. In the SDMX Constructor, annotations are available through all Editor menu items such as Codelist, ConceptScheme, DSD, Dataflow, ConceptConstraint, AgencyScheme, CategoryScheme and MSD. We will see below how it works for the Dataflow as an example. It works similarly for other artefacts. As shown below, Annotations have three main components: Type, Title and Text (in multiple languages - if applicable).

Click here to enlarge the image

By clicking on ‘Standard Types’ on the pop-up, one can choose from the SDMX annotations supported by the .Stat Suite.

Click here to enlarge the image

Once checked/selected and added (for example, in the below image, Default, Layout_Column and Layout_Row are added), one can save the annotation by clicking the Save button.

Click here to enlarge the image

Once saved, one can see the number of annotations displayed on the annotation button (as shown below).

Click here to enlarge the image

If we load the ILOSTAT registry in the SDMX Constructor and select the Dataflow for the Labour force by sex, age and education, we see in-fact 7 annotations (as shown below).

Click here to enlarge the image

Clicking on the Annotations button will show the preselected Types, Titles and Text (in English) relevant to this Dataflow as shown below.

Click here to enlarge the image

Titles

To manually assign items in the ‘Title’ column of the annotation pop-up window, click on the desired row and click the ‘Select Items’ button. From there, you can choose from the available options, such as EDU for the row: LAYOUT_COLUMN for the ‘Labour force by sex, age, and education’ as shown below.

Click here to enlarge the image

Please be aware that the “Selected Items” button will become active under the circumstance: 1) When a registry is chosen, which permits the potential cross-referencing of artefacts (for example, selecting ILOSTAT), and 2) In the situations listed below:

1. Codelist Editor: The list of code items of the currently selected code list will be provided for selections. For example, in the image below, the first code list CL_ACTIVITY is double-clicked and then Annotations. After choosing items from ‘Standard Types’, one can choose Titles from the ‘Select Items’ button.

Click here to enlarge the image

2. ConceptScheme Editor: When you double-click a concept with a code list. The list of code items of the currently selected concept will be provided for selection. Clicking on the Annotations, as shown below, will offer the opportunity to select ‘Standard Types’ and Titles from the ‘Select Items’ button.

Click here to enlarge the image

3. DSD Editor: The list of Dimensions of the currently selected DSD will be available for selection. Clicking on the Annotations, as shown below, will offer the opportunity to select ‘Standard Types’ and Titles from the ‘Select Items’ button.

Click here to enlarge the image

4. Dataflow Editor: The list of dimensions of the selected dataflow (the implied DSD) will be available for selection. Clicking on the Annotations, as shown below, will offer the opportunity to select ‘Standard Types’ and Titles from the ‘Select Items’ button.

Click here to enlarge the image

Annotations supported by the SDMX Constructor serve as a powerful tool for driving the display of data. By leveraging annotations’ flexibility and customisation options, users can enhance the user experience and improve data interpretation. The SDMX Constructor’s annotation support is valuable for users seeking to make their data more meaningful, informative, and visually engaging.