Delete data structures
Table of Content
- Dependencies between artefacts in SDMX
- Delete a single structure artefact
- Delete an artefact and its related structure artefacts
- Delete several similar artefacts
Technical disclaimer / recommendation on Dataflow deletion: For a complete deletion of the mapping set related to a dataflow, it is necessary, when deleting a dataflow, to either use the delete option from the DLM, or manually delete the mapping set using the Transfer Swagger UI first (this process will be improved once we release this change.
In the DLM, data structures can be deleted separately, several similar structure objects at a time, or several of different types according to their dependency(ies).
Note that data structures can also be deleted directly through the SDMX (NSI) web service API, using the DELETE HTTPS verb with the appropriate resource URL. Example of deleting a Codelist:
curl -X DELETE https://nsi-stable-siscc.redpelicans.com/rest/codelist/OECD/COUNTRY/1.0.0
Dependencies between artefacts in SDMX
SDMX artefacts must be deleted in the appropriate order according to their dependency tree. E.g. in order to delete a Dataflow, first any possible Content Constraint that references this Dataflow must be deleted. Before deleting a Codelist, any Data Structure Definitions referencing it must also be deleted.
A parent is an artefact that references another artefact.
A child is an artefact that is being referenced by another artefact.
- Codelist A
- Codelist A
- Codelist B
The same child can be referenced by different parents. More information on the SDMX artefact dependency can be found here: https://github.com/sdmx-twg/sdmx-rest/blob/master/v2_1/ws/rest/docs/4_3_structural_queries.md#applicability-and-meaning-of-references-attribute.
However, in the context of the deletion of artefacts in the DLM and the need to delete referencing artefacts first, the hierarchy tree is inverse.
Delete a single structure artefact
From the DLM list of artefacts, you can select from the left menu, the option to delete a structure artefact without related structures.
Once you click, it automatically triggers the deletion of the object. Once the deletion process is complete, the appropriate notification is returned in a green/ banner, and the deleted artefact (when successful) is automatically removed from the list.
If the deletion fails (e.g. dependency conflict), the appropriate error message is returned through a red bin icon next to the artefact name.
Delete an artefact and its related structure artefacts
Release in March 10, 2021 Release .Stat Suite JS 7.1.0
From the DLM list of artefacts, you can select from the left menu, the option to delete a structure artefact and/or related structures.
Once you click, it displays a popup window with all listed artefacts using a tree control and selectable items. It details the artefact type, name, ID, version, “finality” and agency.
- The original item is pre-selected as well as all below items.
- Non-delete-able artefacts are marked as such with a red forbidden icon. A tooltip explains the reason and solution: “Cannot be deleted since referenced by: XXXX, XXXX. First delete those structures and then try again.”. When there are more than 3 “outside” references, then the number of references is mentioned.
Note that, since July 8, 2021 Release .Stat Suite JS 9.0.0, a check for each of the listed structures is made to determine if the current user is entitled to delete it. If the user is not authorised to delete a specific artefact, then it is also marked as non-delete-able, and the tooltip feature displays: “Cannot be deleted due to an insufficient permission. Contact the owner of the artefact to gain the deletion permission."
- A warning orange icon informs the user of prerequisites awaited for deleting some of the items. For example (see in screenshots below), when a codelist needs also the “above” ConceptScheme deletion, it is mentioned as such: “In order to delete this artefact, you must select conceptscheme XXXXX”.
- Cliking on “Delete” will automatically initiate the deletion of all the selected artefacts structures and in the order that respect the top/down dependencies.
The outcome of each deletion is:
- success: green-coloured bin icon.
- failure: red-coloured icon with the tooltip displaying the corresponding error message.
The “Cancel” button interrupts the deletion process, then changes its text to “Close” and re-activates the “Delete selected structures” button.
Once the deletion actions are completed, the “Delete selected structures” button becomes hidden and the “Cancel” button changes the text back to “Close”.
Note that for dataflow and DSD artefacts, two bins are displayed because a technical/intermediate action is required for automatically cleaning the db objects.
- The “Close” button closes the popup window.
Delete several similar artefacts
From the DLM list of artefacts, if you select several artefacts of the same type, you can select from the left menu, the option to delete structures all at once.
Clicking on “delete structures” will simultaneously initiate the deletion of each artefact. The completion of the deletion will results in a green or red bin icon next to each corresponding selected artefact.