.Stat Suite documentation

Implicit and explicit orders

localised order in the items of all ItemSchemes

Implicit means the order of items (e.g. codes) as returned within the array of codes. There are thus always naturally given in a structure definition.
Explicit order is the order provided through annotations and is optional. Explicit order prevails implicit order.

In the data definition, the story is a bit different because the order of codes in dimension arrays is considered “random” (because of potential streaming on server side). The original implicit order is thus returned as an additional code property. With the NSI web service, this property should always be returned. However, we cannot guarantee the presence of this property for other SDMX endpoints.
Explicit order is provided through annotations and is optional. Explicit order prevails implicit order, and implicit order prevails the “random” array order.
The syntax for the explicit localised “ORDER” annotation for items in Codelists and CategorySchemes is:

        "annotations": [{
                 "text": {
                          "en": "5",
                          "fr": "7"
                 },
                 "type": "ORDER"
         }]

In case an unambiguous explicit order is not provided then the SDMX standard’s implicit order of the codes is applied. This rule applies also if the same order number was explicitly specified twice: the implicit order should then prevail between those codes.

Before ordering (implicit or “random” order of dimension values from SDMX ItemScheme):

  • Aaa, Explicit order=5
  • Bbb, Explicit order=4
  • Ccc, Explicit order=3
  • Ddd, Explicit order=3
  • Eee, Explicit order=2
  • Fff
  • Ggg, Explicit order=1
  • Hhh
  • Iii, Explicit order=1
  • Jjj

After ordering:

  • Fff, Default explicit order=0
  • Hhh, Default explicit order=0
  • Jjj, Default explicit order=0
  • Ggg, Explicit order=1
  • Iii, Explicit order=1
  • Eee, Explicit order=2
  • Ccc, Explicit order=3
  • Ddd, Explicit order=3
  • Bbb, Explicit order=4
  • Aaa, Explicit order=5

This annotation is to be used to automatically order dimension values in the filters of the visualisations according to the current locale. It should also be used for displaying correctly ordered dimension values in the visualisation’s data table.


localized order in data message for DE table

Explicit order of items in an ItemScheme as described above is also applied to the data table view, once the explicit order of codes is returned in the SDMX-JSON data message.