Return to use-cases.tex CVS log

Up to [Repository] / storage / software

First version of tool description added.

\documentclass[a4paper]{article}

\usepackage[latin1]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{ae}
\usepackage{ngerman}

\begin{document}


\section{Use cases}
\label{sec:use-cases}

\subsection{Archive (cvs import) }
\label{sec:archive-cvs-import}

Archivierung eines ganzen Verzeichnisses mit Unterverzeichnissen.

\begin{enumerate}
\item Der Benutzer kopiert das Verzeichnis mit Datenfiles und
  beschreibenden Metadatenfiles an die passende Stelle in der
  Verzeichnishierarchie des Servers.

\item Der Benutzer ruft ein Webinterface auf, das alle zuletzt auf den
  Server kopierten Verzeichnisse anzeigt und wählt das Verzeichnis
  aus, das er angelegt hat.

\item Der Server überprüft die Gültigkeit und Vollständigkeit der
  Metadaten.
  
\item Falls das entsprechende Verzeichnis, identifiziert über seine
  Lage in Verzeichnisbaum, bereits archiviert worden ist, wird eine
  Warnung ausgegeben.\footnote{Dieser Fall sollte nicht vorkommen weil
    Metadaten auf der Platte vorhanden sein sollten.}

\item Die Datenfiles werden auf Band archiviert und (im Erfolgsfall)
  von der Festplatte gelöscht. Die Metadatenfiles werden gesichert
  aber nicht von der Platte gelöscht.

\item Der Benutzer wird (wenn gewünscht) nach der erfolgreichen
  Archivierung benachrichtigt.
\end{enumerate}


\subsection{Recall (cvs checkout)}
\label{sec:recall-cvs-checkout}

Wiederherstellung eines ganzen Verzeichnisses mit Unterverzeichnissen.

\begin{enumerate}
\item Der Benutzer ruft ein Webinterface auf, das alle archivierten
  Verzeichnisse anzeigt und wählt ein Verzeichnis aus.\footnote{Der Server
  kann die Übersicht anhand der vorhandenen Metadatenfiles herstellen.}

\item Der Server holt die Daten vom Band und stellt sie wieder in das
  Verzeichnis auf der Festplatte.
  
\item Der Benutzer wird nach der erfolgreichen Wiederherstellung
  benachrichtigt und kann die benötigten Dateien von der Festplatte
  des Servers herunterkopieren.

\item Die Datenfiles werden nach einer bestimmten Zeit wieder von der
  Platte gelöscht.
\end{enumerate}


\subsection{Archive single files}
\label{sec:archive-single-files}

Einzelne Dateien sollen einem existierenden Archiv hinzugefügt werden
oder Dateien im Archiv ersetzen.

\begin{enumerate}
\item Der Benutzer kopiert einzelne Dateien in das existierende
  (nur Metadaten enthaltende) Verzeichnis auf dem Server und
  aktualisiert die entsprechenden Metadatenfiles.

\item Der Benutzer ruft ein Webinterface auf, das alle zuletzt auf den
  Server kopierten Dateien anzeigt und wählt das passende Verzeichnis
  aus.

\item Der Server überprüft die Gültigkeit und Vollständigkeit der
  Metadaten.
  
\item Falls die entsprechende Datei\footnote{identifiziert über ihren
  Dateinamen innerhalb des Verzeichnisses} bereits archiviert worden
  ist, wird gefragt ob die Datei im Archiv ersetzt werden soll. Wenn
  die Datei nicht vorhanden ist, wird gefragt ob sie dem Archiv
  hinzugefügt werden soll.

\item Die Datenfiles werden auf Band archiviert und (im Erfolgsfall)
  von der Festplatte gelöscht. Die Metadatenfiles werden gesichert
  aber nicht von der Platte gelöscht.

\item Der Benutzer wird (wenn gewünscht) nach der erfolgreichen
  Archivierung benachrichtigt.
\end{enumerate}


\subsection{Recall single files}
\label{sec:recall-single-files}

Einzelne Dateien aus einem Archiv sollen wiederhergestellt werden.

\begin{enumerate}
\item Der Benutzer ruft ein Webinterface auf, das alle archivierten
  Verzeichnisse und Dateien anzeigt und wählt eine oder mehrere
  Dateien aus.\footnote{Der Server kann die Übersicht anhand der
    vorhandenen Metadatenfiles herstellen.}

\item Der Server holt die Daten vom Band und stellt sie wieder in das
  Verzeichnis auf der Festplatte.
  
\item Der Benutzer wird nach der erfolgreichen Wiederherstellung
  benachrichtigt und kann die benötigten Dateien von der Festplatte
  des Servers herunterkopieren.

\item Die Datenfiles werden nach einer bestimmten Zeit wieder von der
  Platte gelöscht.
\end{enumerate}


\subsection{Delete and Rename files}
\label{sec:delete-rename-files}

Einzelne Dateien in einem Archiv sollen umbenannt werden oder aus
dem Archiv gelöscht werden.


\section{Tools}
\label{sec:tools}
Zur Umsetzung der Usecases Archive und Recall sind geplant:
\begin{itemize}
\item Checker - Perlscripte zur Überprüfung und Unterstützung der Generierung von Metadaten
\item Web-Archive - Webfrontend zur Archivierung
\item Browser - Browser und Suchumgebung zum Recall
\end{itemize}

\subsection{Checker}
\label{sec:checker}
Der Checker ürberprüft die XML-Metafiles auf formale Richtigkeit und Konsistenz mit den abgelegten Daten. Wenn möglich können Werte für Tags automatisch durch den Checker eingetragen werden. Der Checker archiviert die Daten auf dem Band und versendet eine Bestätigungsemail.

Der Checker soll auch als reines Überprüfungstool der XML-Dokumente einsetzbar sein, d.h. mit entsprechendem Flag kann die Archivierung unterbunden werden.

Für den Checker sind von Features vorgesehen:

Ausgaben von Fehlermeldungen:

\begin{itemize}
\item Überprüfung ob vorgeschriebene Felder ausgefüllt sind
\item Überprüfung ob Directories und Pfade in den Metadaten mit den abgelegten Dokumenten übereinstimmen
\item Validierung des XML File (nice to have)
\item Validierung der Metadaten im Meta-Tag (nice to have)
\end{itemize}

Automatisches Ausfüllen:

\begin{itemize}
\item Falls Pfade und Directories offengelassen wurden
\item Vergabe von DRI
\item Name des Archivierenden
\item Datum des Archivierens
\end{itemize}

Warnungen:

\begin{itemize}
\item Warnung falls Dateien, die in den Metafiles angegeben sind nicht vorhanden sind.
\item Warnung falls Referenzen zu anderen Archivdateien nicht auf existierende Dokumente verweisen
\end{itemize}

Ablage der Dokumente
\begin{itemize}
\item Der Checker schreibt die Dokumente nach Überprüfung der Richtigkeit der Dokumente auf Band und Versendet eine Bestätigungsemail an eine anzugebende Adresse
\end{itemize}


\subsection{Web-Archive}
\label{sec:Web-Archive}

Web-Archive ist ein Web-Frontend zur Archivierung der Dokumente.
\begin{enumerate}

\item Nach Anmelden erhält der Benutzer eine Liste der von auf dem Server abgelegten und nicht-archivierten Dokumente, sortiert nach Ablagedatum.
\item Der Benutzer kann die Dokumente, die archiviert werden sollen, auswählen
\item Der Checker wird aufgerufen, eventuelle Fehler und Warnungen ausgegeben
\item Bei Richtigkeit werden die Dokumente archiviert
\item Der Benutzer erhält vom Checker eine e-mail nach erfolgter Archivierung
\end{enumerate}



\subsection{Browser}
\label{sec:browser}
Der Browser dient zum Navigieren durch den Filebaum von Archiv und Online darstellungen. Entsprechende Metadaten in den Knoten sollten direkt angezeigt werden. (Vorbild IMDI-Browser)

\end{document}