Table of Content
- Categorise a data view (dataflow)
- (Re-)index a data view (dataflow)
Categorise a data view (dataflow)
Released in April 1, 2021 Release .Stat Suite JS 7.2.0
When using the option “Categorise structure”, DLM users can categorise a data view (SDMX dataflow) in one or several of the categories in any of the available SDMX CategorySchemes of a dedicated data space. Users can thus avoid manually creating and uploading SDMX Categorisation artefacts in .xml files.
Categorising dataflows is required for their index in the Data Explorer search (see related functional specifications of What is indexed in .Stat DE).
- A menu option to “Categorise structure” is available in the contextual menu of dataflows (as well as in the multi-selection menu for dataflows) for an internal data space.
- Clicking on the option opens a popup window that lists all the SDMX CategorySchemes and corresponding category-trees of the related data space (similarly to the content of the “Filter by category” selector).
- The user can select one or several of the categories in any CategoryScheme, and then click on “Categorise”.
This action will immediately generate the corresponding SDMX categorisation(s). The success or failure of the category creation is indicated with the appropriate icon next to the dataflow’s contextual menu.
In addition, the newly categorisation(s) is/are displayed in the detailed information of the corresponding dataflow:
When listing the related structures of a dataflow from the left menu option, the Categorisation(s) is/are also listed as child(ren) of the dataflow:
The SDMX Categorisation is created on the following naming convention:
- Source id="[%DF_ID]"
- Source version="[%DF_VERSION]"
- Source agencyID="[%DF_AGENCY]"
- Target id="[@CAT_ID]"
- Target maintainableParentID="[@CS_ID]"
- Target maintainableParentVersion="[@CS_VERSION]"
- Target agencyID="[@CS_AGENCY]"
- [%DF_ID]: ID of dataflow
- [%DF_AGENCY]: Agency of dataflow
- [@DF_AGENCY_ALTER]: same as [@DF_AGENCY] with dots ‘.’ replaced by underscore ‘_’
- [%DF_VERSION]: Version of dataflow
- [@DF_VERSION_ALTER]: same as [@DF_VERSION] with dots ‘.’ replaced by underscore ‘_’
- [%DF_NAME_XX]: Name of dataflow in language XX
- [@CAT_ID]: ID of category (tree)
- [@CAT_ID_ALTER]: same as [@CAT_ID] with dots ‘.’ replaced by underscore ‘_’
- [@CS_ID]: ID of CategoryScheme
- [@CS_AGENCY]: Agency of CategoryScheme
- [@CS_AGENCY_ALTER]: same as [@CS_AGENCY] with dots ‘.’ replaced by underscore ‘_’
- [@CS_VERSION]: Agency of CategyScheme
- [@CS_VERSION_ALTER]: same as [@CS_VERSION] with dots ‘.’ replaced by underscore ‘_’
Note: If the selected category is a child category, then the IDs of all parent categories involved in the branch are concatenated using ‘.’, e.g. if the category with ID “THIRD” in the following category-tree was selected, then [@CAT_ID] would stand for “TOP.SECOND.THIRD”:
(Re-)index a data view (dataflow)
Users can index or re-index a data view (SDMX dataflow) by using the option (Re-)index dataflow from the contextual hamburger menu from the dataflow list:
Indexing or re-indexing a dataflow is necessary for the searchability and browsability of a specific data view (dataflow) in the .Stat Data Explorer.
Several prerequisites are necessary for a successful indexing:
- The dataflow is in an internal or external dataspace defined as a source to be indexed (see configuration);
- The dataflow is categorised under an SDMX CategoryScheme (see how to categorise a data view) that is defined for indexation (see configuration);
- The dataflow has data associated to it (see upload data and detailed specs of data availability);
- If the underlying structures and data are publically accessible (see the list of basic permissions).
The ‘(Re-)index dataflow’ menu item is shown only for dataflows that are in a dataspace to be indexed. Clicking on ‘(Re-)index dataflow’ for a specific dataflow triggers the request sent to the search service and displays a loading spinner:
Once the request is successfully sent to the search service, a green icon next to the dataflow’s contextual menu appears and displays the following acknowledgement message on mouse-over:
In order to see the outcome of the request (success or failure), the user needs to consult the logs of the search service (see here).
However, if the dataflow is not in a dataspace defined as a source to be indexed, or if the dataflow is not categorised in a CategoryScheme defined for indexation, then a red icon next to the dataflow’s contextual menu appears and displays the following error message on mouse-over:
Note: For a greater user-friendliness it is planned to enhance the DLM by contextualising the appearance of the ‘(Re-)index dataflow’ option depending on fulfilled indexation prerequisites (see ticket data-lifecycle-manager#281), and by including logs from the search service directly into a new DLM menu (see ticket data-lifecycle-manager#233).