Use Case:  Store Entity

All subsystems will use the archive as a persistent store for the entities they have under control. Entities will be created, updated retrieved and queried but usually not deleted. All activities have to be permitted. The 'store' activity is used to create a new entity inthe archive.

Goal: Store new entity

Contact Author: A.Wicenec

Role(s)/Actor(s):

Primary: Any ALMA subsystem
Secondary: Executive, UserAdmin

Priority: Critical

Performance: Seconds (depending on the size of the entity).

Frequency: 1 Hz

Preconditions: 

  1. Database is running
  2. User got identified

 Basic Course: 
  1. Subsystem establishes connection to archive, for a human user there is an user interface which acts as a subsystem. The subsystem is required to choose the correct interface, i.e. XMLStore, MonitorStore or BulkStore. This is not critical, because only a fewsubsystems will need to use the MonitorStore and the BulkStore.
    Alternate Course: none
    Exception Course: Connection can't be established: try again until timeout.
    Postcondition: Connection established.
  2. Retrieve UID: Every entity which is stored in the archive needs to get a unique identifier. The identifier can be used by the subsystem as a reference to the newly created entity.
    Alternate Course: none
    Exception Course: can't get UID: This is a fatal exception!
    Postcondition: Subsystem has UID.
  3. Send entity to archive: Use the defined interface to send the entity to the archive.
    Alternate Course: none
    Exception Course: already there: An entity with the same UID already exists. This is a fatal exception!
    Exception Course: not authorized: Subsystem is not authorized to store entities.
    Exception Course: other: try again until timeout.
    Postcondition: Entity stored in archive.
Postconditions: 
  1. Entity stored in archive (Verification by using DB browser).
  2. Entity can be retrieved from archive.

Issues to be Determined or Resolved: 

The communication of the user ID and the associated permissions have to be clarified. The required level of granularity for permissions has to be specified by SSR and operational requirements.

Last modified: Thu Sep 25 15:11:01 CEST 2003