TimeScope - Marker Module

Objective

The ability to delete markers, marker groups, and linkage groups in TimeScope

Markers Module

User Interface Specifications:

For the markers tab, the right (content) panel will contain:

1. Filtering controls:

   1. marker_id (range, ex: 100-210)

      1. OR marker.names list (text area: line-separated list)

   2. Platform

2. A submit button to query the database

3. A clear button to clear the current filters and result set

4. A table listing the data resulting from the filters

   • This table will provide pagination for optimal performance

   • This table will provide a capability to select rows individually

   • And a select all button to select all rows

5. A delete button to delete the rows selected

6. For the result table: All the columns wherein an ID is displayed should have a column next to it displaying the names. Columns should be sortable.

Functional Specifications:

Upon selecting a set of markers from the result table and clicking the delete button, the system will:

1. Prompt the user to confirm what will be deleted (basic yes-no prompt window with a list of all the datasets that will be deleted)

2. PREREQUISITE CHECK: We only allow markers deletion IF the markers are not being used in any dataset AND any marker_groups. If there are datasets or marker_groups using those markers:

   1. Provide a window/prompt/page that displays the list of dataset references for the markers, and do not allow deletion if there are references. Basically, you have to delete the datasets first.

      1. A message that essentially displays: "Marker 1 is being used on dataset A, B, and C. Marker 2 is being used on dataset D and E. Please delete those datasets first."

      2. Presentation of this message and list of datasets is up to the developer. If it's more performant and user-friendly to have a separate page with a table in it (in case the list is big) then do it that way.

   2. Provide a window/prompt/page that displays the list of marker_groups references for the markers, and do not allow deletion if there are references. Basically, you have to update the marker_groups first.

      1. A message that essentially displays: "Marker 1 is being used on marker_group A, B, and C. Marker 2 is being used on marker_group D and E. Please update those marker groups first using the loaderUI."

      2. Presentation of this message and list of marker_groups is up to the developer. If it's more performant and user-friendly to have a separate page with a table in it (in case the list is big) then do it that way.

3. If the user clicks yes, the system then will delete the following, in this order (details on how to delete them are detailed below)

   • Marker_linkage_group rows for the list of markers being deleted

   • Marker rows

4. If the user clicks no, the operation will simply abort.

Everytime a deletion is being made, show:

Prompt Messages:

A warning message box will be shown that clearly indicates that the operation is final and the data will be deleted, providing a quick statistics on how many rows there are (ex. Are you sure you want to delete 102321 markers?). The user is then provided with the ability to cancel or go through with the operation.

Result Report Page:

Upon completion of deletion, a summary page of what was deleted will be displayed. This will contain:

• Total number of rows deleted

• Filtering criteria

• Deletion duration

Add a Footer: This should show one or two sentences that warns the user to do regular backups or at least one backup before using this tool to allow for recoverability in case of user mistakes.

Logging:

Log a detailed list of what gets deleted per operation. The developer has the flexibility to use whatever library (or stay with basic stdout) s/he wants. The only requirement is that the following gets logged:

1. For every deletion, log the actual SQL (or the JOOQ equivalent) that ran.

2. The username of the user who ran the deletion operation

3. Timestamp of deletion

4. Result of deletion

   1. Total number of rows deleted

   2. Filtering criteria

   3. Deletion duration

Requirements

User interaction and design

Open Questions

Out of Scope