Suggest minor changes to the current DB Schema

[dyuliu]

Event (the current version)

Each one of the anomalies detected by the pipelines is stored as an Event, which
contains the details about the start time, the stop time and the severity score.

Fields

• _id (ObjectID): Unique Identifier of this Event object
• signalrun_id (ObjectID - Foreign Key): Unique Identifier of the Signalrun during which this
  Event was detected.
• signal_id (ObjectID - Foreign Key): Unique Identifier of the Signal to which this Event relates
• start_time (Integer): Timestamp where the anomalous interval starts
• stop_time (Integer): Timestamp where the anomalous interval ends
• severity (Float): Severity score given by the pipeline to this Event
• source (String): ORION, SHAPE_MATCHING, or MANUALLY_CREATED
• num_annotations (int): Number of Annotation associated to this Event.
• insert_time (DateTime): Time when this Event Object was inserted

Event (the suggested version)

The previous version is not user friendly to read or track the latest tag information.

Fields

• _id (ObjectID): Unique Identifier of this Event object
• signalrun_id (ObjectID - Foreign Key): Unique Identifier of the Signalrun during which this
  Event was detected.
• signal_id (ObjectID - Foreign Key): Unique Identifier of the Signal to which this Event relates
• start_time (Integer): Timestamp where the anomalous interval starts
• stop_time (Integer): Timestamp where the anomalous interval ends
• severity (Float): Severity score given by the pipeline to this Event
• source (String): ORION, SHAPE_MATCHING, or MANUALLY_CREATED
• num_annotations (int): Number of Annotation associated to this Event.
• latest_tag (ObjectID - Foreign Key): Unique Identifier of the most recent Annotation with tag.
• insert_time (DateTime): Time when this Event Object was inserted

Event Interaction (the current version)

The Event Interaction collection records all the interaction history related to events.

Fields

• _id (ObjectID): Unique Identifier of this Interaction object
• event_id (ObjectID): Unique Identifier of the Event to which this event relates
• action (String): Action type performed on this event, such as delete, split, and adjust
• start_time (Integer): Timestamp where the anomalous interval starts
• stop_time (Integer): Timestamp where the anomalous interval ends
• created_by (String): Identifier of the user who interacted with the target Object
• insert_time (DateTime): Time when this Event Interaction Object was inserted

Event Interaction (the suggested version)

The previous version is not good for maintaining histories of annotations. Annotation can be created, deleted, or updated. So the interaction also needs to maintain this history.

Fields

• _id (ObjectID): Unique Identifier of this Interaction object
• event_id (ObjectID): Unique Identifier of the Event to which this event relates
• action (String): Action type performed on this event, such as delete, split, merge, adjust, and annotate (tag || comment)
• start_time (Integer): Timestamp where the anomalous interval starts
• stop_time (Integer): Timestamp where the anomalous interval ends
• annotation (ObjectID - Foreign Key): Unique Identifier of the newly created Annotation from this interaction action.
• created_by (String): Identifier of the user who interacted with the target Object
• insert_time (DateTime): Time when this Event Interaction Object was inserted