Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- oais:sa-editor [2012/10/30 11:12] – [Ablieferungsvereinbarung erstellen/kopieren/löschen] guenter
+++ oais:sa-editor [2012/10/30 17:07] – [Anmeldung] Andreas Nef
@@ Zeile 1: / Zeile 1: @@
-====== Editor für Ablieferungsvereinbarungen (SA)======
+====== Verwaltung der Ablieferungsvereinbarungen (SA)======
-Der Editor für Ablieferungsvereinbarungen ist eine browserbasierte Umgebung, in der Ablieferungsvereinbarungen erstellt, verändert und verwaltet werden. Den Editor haben wir getestet mit Internet Explorer, Firefox und Google Chrome. Die Ablieferungsvereinbarungen (Submission Agreements, SA) werden im Hintergrund als XML-Dateien gespeichert und beinhalten Informationen, die relevant für die Abwicklung des Ablieferungs- und Ingest-Prozesses sind, aber auch für das gesamte Preservation Planning.
+Der Verwaltung der Ablieferungsvereinbarungen ist eine browserbasierte Umgebung, in der Ablieferungsvereinbarungen erstellt, verändert und verwaltet werden. Den Editor haben wir getestet mit Internet Explorer, Firefox und Google Chrome. Die Ablieferungsvereinbarungen (Submission Agreements, SA) werden im Hintergrund als XML-Dateien gespeichert und beinhalten Informationen, die relevant für die Abwicklung des Ablieferungs- und Ingest-Prozesses sind, aber auch für das gesamte Preservation Planning.
-===== Anmeldung an das System =====
+===== Anmeldung =====
-Bei Aufruf der Seite im Browser wird ein Login-Fenster angezeigt. Falls Sie noch kein Login besitzen, klicken Sie auf den Link unter den Eingabefeldern, um einen Zugang zu beantragen. Ein Benutzer mit Administrationsrechten muss Sie anschliessend freischalten.
+Bei Aufruf der Seite im Browser wird ein Login-Fenster angezeigt. Falls Sie noch kein Login besitzen, klicken Sie auf den Link unter den Eingabefeldern, um einen Zugang zu beantragen. Ein Benutzer mit Administrationsrechten muss Sie anschliessend freischalten (siehe [[oais:sa-editor&#Benutzerverwaltung]]).
 {{:oais:sa-ed-01.gif?direct&300}}
@@ Zeile 15: / Zeile 15: @@
 =====SA erstellen/kopieren/löschen=====
-==== Neue Ablieferungsvereinbarung erstellen ====
+==== Neue SA erstellen ====
-Über das Menü links wird eine neue Ablieferungsvereinbarung erstellt:
+Über das Menü links wird eine neue SA erstellt:
 {{:oais:sa-ed-03.gif?direct&300}}
-Der Name der neuen Ablieferungsvereinbarung muss die folgende Struktur aufweisen:
+Der Name der neuen SA muss die folgende Struktur aufweisen:
 	sa_[Organisationskürzel]-[Laufnummer]
 also beispielsweise:
 	sa_DRS2-001
-Die Ablieferungsvereinbarung ist einem Projekt zuzuweisen (in der Regel ist hier das Archiv hinterlegt). Als Konfigurationswahl ist der Eintrag "submAgr" (für Ablieferungsvereinbarung, respektive Submission Agreement) auszuwählen.
+Die SA ist einem Projekt zuzuweisen (in der Regel ist hier das Archiv hinterlegt). Als Konfigurationswahl ist der Eintrag "submAgr" (Submission Agreement) auszuwählen.
-==== Ablieferungsvereinbarung kopieren ====
+==== SA kopieren ====
 {{:oais:sa-ed-12.png?direct&300}}
-==== Ablieferungsvereinbarung löschen ====
+==== SA löschen ====
 :!: Administratoren\\
-Die Ablieferungsvereinbarungen können nur vom Administrator gelöscht werden.\\
+Die SA können nur von Administratoren gelöscht werden. Die SA wird ohne Nachfrage gelöscht. \\
 {{:oais:sa-ed-13.png?direct&300 |}}
-Die Ablieferungsvereinbarung wird ohne Nachfrage gelöscht.\\
-==== Ablieferungsvereinbarung umbenennen ====
+==== SA umbenennen ====
-  - gewünschte Ablieferungsvereinbarung kopieren und entsprechend benennen
+  - gewünschte SA kopieren und entsprechend benennen
-  - alte Ablieferungsvereinbarung löschen
+  - alte SA löschen
 Wenn Sie Gross und Kleinschreibung ändern möchten, müssten Sie folgende Schritte durchführen.
-  - gewünschte Ablieferungsvereinbarung in Dummy kopieren
+  - gewünschte SA in Dummy kopieren
-  - alte Ablieferungsvereinbarung löschen
+  - alte SA löschen
-  - Dummy Ablieferungsvereinbarung kopieren und entsprechend benennen
+  - Dummy SA kopieren und entsprechend benennen
-  - Dummy Ablieferungsvereinbarung löschen
+  - Dummy SA löschen
-==== Ablieferungsvereinbarung importieren ====
+==== SA importieren ====
 :!: Administratoren\\
-Die Ablieferungsvereinbarungen werden als XML - Dateien gespeichert. Für einen Import muss diese XML in einen Ordner mit gleichen Namen kopiert und dann als als ZIP File gespeichert werden.\\
+Die SA werden als XML-Dateien gespeichert. Für einen Import muss diese XML-Datei in einen Ordner mit gleichem Namen kopiert und dieser Ordner dann gezippt werden.\\
-{{:oais:sa-ed-14.png?direct&300}}
+{{:oais:sa-ed-14.png?direct&300}}\\
 Das ZIP kann nun importiert werden.\\
 {{:oais:sa-ed-15.png?direct&300}}
-===== Ablieferungsvereinbarung editieren =====
+===== SA editieren =====
-Um eine Ablieferungsvereinbarung zu editieren klickt man diese in der Liste der Ablieferungsvereinbarungen an und gelangt dann in das Übersichtsfenster:
+Um eine SA zu editieren klickt man diese in der Liste der SA an und gelangt dann in die Bearbeitungsfunktionen:
 {{:oais:sa-ed-04.gif?direct&600}}
 Hier stehen die folgenden Funktionen zur Verfügung:
-  * **Ablieferungsvereinbarung ändern:** Dies ist die zentrale Funktion, über welche die Ablieferungsvereinbarung zur Bearbeitung in einem separaten Fenster (siehe nächsten Abschnitt) geöffnet wird.
+  * **[[oais:sa-editor&#editor|SA ändern]]**: Dies ist die zentrale Funktion, über welche die SA zur Bearbeitung in einem separaten Fenster (siehe nächster Abschnitt) geöffnet wird.
-  * **Web-Ansicht generieren:** Mit dieser Funktion wird der Inhalt der Ablieferungsvereinbarung für die Anzeige im Browser vorbereitet und kann bei Bedarf auch ausgedruckt werden.
+  * **[[oais:sa-editor&#web-ansicht_generieren|Web-Ansicht generieren]]**: Mit dieser Funktion wird der Inhalt der SA für die Anzeige im Browser vorbereitet und kann bei Bedarf auch ausgedruckt werden.
-  * **Ablieferungsvereinbarung exportieren:** Die Ablieferungsvereinbarung wird als XML-Datei in gezippter Form an einen anzugebenden Ort gespeichert.
+  * **[[oais:sa-editor&#sa_exportieren|SA exportieren]]**: Die SA wird als XML-Datei in gezippter Form an einen anzugebenden Ort gespeichert.
 ===== Editor =====
-Das Bearbeitungsfenster, in welchem die Ablieferungsvereinbarungen erstellt und bearbeitet werden, wird über die oben angezeigte Schaltfläche "Ablieferungsvereinbarung ändern" geöffnet. Hierfür ist auf dem eingesetzten Computer die Java-Laufzeitumgebung (JRE) notwendig. Sie kann unter [[http://www.java.com/de/download/]] gratis heruntergeladen werden.
+Das Bearbeitungsfenster, in welchem die SA erstellt und bearbeitet werden, wird über die oben angezeigte Schaltfläche "SA ändern" geöffnet. Hierfür ist auf dem eingesetzten Computer die Java-Laufzeitumgebung (JRE) notwendig. Sie kann unter [[http://www.java.com/de/download/]] gratis heruntergeladen werden.
-Wird eine neu erstellte und noch leere Ablieferungsvereinbarung geöffnet, füllt der Editor die wichtigsten Grundlageninformationen bereits automatisch aus:
+Wird eine neu erstellte und noch leere SA geöffnet, füllt der Editor die wichtigsten Grundlageninformationen bereits automatisch aus:
 {{:oais:sa-ed-05.gif?direct&300}}
@@ Zeile 72: / Zeile 74: @@
 Klickt man die Fragezeichen links von den Feldbezeichnungen an, werden Detailinformationen zu den einzelnen Feldern angezeigt. Hinter den jeweiligen Feldern wird jeweils mit einem Symbol angezeigt, ob der eingetragene Wert gültig ist oder nicht.
-Nach der Bestätigung wird das Hauptfenster geöffnet, wo die weitere Bearbeitung der Ablieferungsvereinbarung erfolgt:
+Nach der Bestätigung wird das Hauptfenster geöffnet, wo die weitere Bearbeitung der SA erfolgt.\\
+==== Darstellung ====
+Es empfiehlt sich, in der linken Fensterhälfte das Register "Einfügen" auszuwählen, wo Elemente angezeigt werden, die an der Position des Cursors eingefügt werden können.\\
 {{:oais:sa-ed-06.gif?direct&300}}
-Es empfiehlt sich, in der linken Fensterhälfte das Register "Einfügen" auszuwählen, wo Elemente angezeigt werden, die an der Position des Cursors eingefügt werden können.
+In der rechten Fensterhälfte wird der Inhalt der SA angezeigt.
-In der rechten Fensterhälfte wird der Inhalt der Ablieferungsvereinbarung angezeigt. Weist ein Element ein Symbol mit grünen Listeneinträgen auf, so sind zu diesem Element Attribute festzulegen. Klicken Sie hierzu auf grüne Listensymbol, um das entsprechende Eingabefenster zu öffnen.
-Auch hier können über die Fragezeichen Detailinformationen zu den einzelnen Elementen der Ablieferungsvereinbarung angezeigt werden:
+==== Zusatzinformationen ====
+Weist ein Element ein Symbol mit grünen Listeneinträgen auf, so sind zu diesem Element Zusatzinformationen (Attribute) festzulegen. Klicken Sie hierzu auf grüne Listensymbol, um das entsprechende Eingabefenster zu öffnen.\\
+{{:oais:sa-ed-16.png?direct&300}}\\
+==== Hilfe (Fragezeichen) ====
+Über die Fragezeichen werden Detailinformationen zu den einzelnen Elementen der SA angezeigt werden:\\
 {{:oais:sa-ed-07.gif?direct&300}}
 Die Beschreibung ist in der Regel auf Englisch und Deutsch vorhanden. Im Register "Kinder-Elemente" wird ersichtlich, welche Unterelemente mindestens einmal (+), genau einmal (keine spezielle Kennzeichnung, oder nicht zwingend (?) vorkommen müssen.
-Ist ein Element rot eingefärbt bedeutet dies, dass es noch nicht allen formellen Anforderungen entspricht. Bevor Sie den Status einer Ablieferungsvereinbarung auf "final" setzen, sollten Sie sicherstellen, dass alle Elemente gelb sind und damit die Ablieferungsvereinbarung alle formellen Vorgaben erfüllt. Sie können (englische) Hinweise über die noch fehlenden Punkte erhalten, indem Sie im Menü auf "Datei" – "Bewertung" klicken:
+==== Elemente einfügen ====
+Neue Elemente können via Reiter „Einfügen“ oder das Menü „Einfügen“ in das SA eingefügt werden. Es werden nur Elemente angezeigt, die an der ausgewählten Position möglich sind.\\
+Bsp: Durch Klick auf Ausgangsdatum, wird das Element in das SA eingefügt und auf der rechten Fensterhälfte dargestellt.\\
+{{:oais:sa-ed-11.png?direct&300}}
+==== Elementinhalte bearbeiten ====
+Mit dem Mauszeiger in das gewünschte Element klicken und den Inhalt bearbeiten.
+==== Element löschen ====
+Der Mauszeiger positionieren und mit der Taste [Del] oder [Backspace] das Element samt Inhalt löschen.
+==== Speichern ====
+Wenn Sie das SA fertig bearbeitet haben, dann speichern Sie es über Datei --> Speichern.
+==== Tipp ====
+Gängige Shortcuts können verwendet werden.
+==== Formelle Anforderungen ====
+Ist ein Element rot eingefärbt bedeutet dies, dass es noch nicht allen formellen Anforderungen entspricht. Bevor Sie den Status einer SA auf "final" setzen, sollten Sie sicherstellen, dass alle Elemente gelb sind und damit die SA alle formellen Vorgaben erfüllt. Sie können (englische) Hinweise über die noch fehlenden Punkte erhalten, indem Sie im Menü auf "Datei" – "Bewertung" klicken:\\
 {{:oais:sa-ed-08.gif?direct&300}}
-Wenn Sie die Ablieferungsvereinbarung fertig editiert haben, dann speichern Sie sie über Datei --> Speichern und schliessen den Editor.
+==== SA Baum ====
-==== Ablieferungsverbeinbarung Baum ====
+Die SA muss einige Mindestdefinitionen enthalten. Diese sind in der folgenden Struktur beschrieben.
-Die Ablieferungsvereinbarung muss einige Mindestdefinitionen enthalten. Diese sind in der folgenden Struktur beschrieben.
 <code>
-Ablieferungsvereinbarung [Liste: Vereinbarungs-ID, Titel, Status]
+Ablieferungsvereinbarung [Zusatzinformationen: Vereinbarungs-ID, Titel, Status]
   Aktenproduzent
     Kontaktinformationen
@@ Zeile 103: / Zeile 124: @@
       Departement
       Kurzform => SIP-Creator -> Organisation
-  Archiv [Liste: ISIL-Code]
+  Archiv [Zusatzinformationen: ISIL-Code]
     Kontaktinformationen
       Kontakt-ID
@@ Zeile 114: / Zeile 135: @@
       Erstellung
     Bewertungsentscheidung
-  Datenlieferung [Liste: dssID]
+  Datenlieferung [Zusatzinformationen: dssID]
     Titel
     Zeitplan
@@ Zeile 122: / Zeile 143: @@
 </code>
-Der Begriff "Liste" verweist auf den Inhalt im Popup.\\
+[[oais:sa-editor&#zusatzinformationen|Zusatzinformation]]
-{{:oais:sa-ed-16.png?direct&300|}}
-SIP-Creator Organisation der ausgewählten Person.\\
+SIP-Creator -> Organisation\\
+Im SIP-Creator sieht ein Benutzer nur die SA die seiner Organisation zugeteilt sind. Damit ein SA einer Organisation zugeteilt wird, muss im Feld Kurzform der Name der Organisation stehen. Die Benutzerverwaltung vom SIP-Creator muss der Administrator vornehmen.\\
+Beispiel: Benutzer = "guenter", Organisation = "Informatik Docuteam"\\
 {{:oais:sa-ed-09.png?direct&300}}
 {{:oais:sa-ed-17.png?direct&300}}
 ====Beispiele====
 ===Zeitplan > Frequenz===
 Beispiel für eine Ablieferung mit Frequenz.\\
 {{:oais:sa-ed-10.png?direct&300}}\\
-Neue Elemente können via Reiter "Einfügen" oder das Menü "Einfügen" in das SA eingefügt werden. Es werden nur Elemente angezeigt, die an der ausgewählten Position möglich sind.\\
-Bsp: Ausgangsdatum bei einem Zeitplan.\\
-{{:oais:sa-ed-11.png?direct&300 |}}
-===== Ablieferungsvereinbarung publizieren =====
-Die Ablieferungsvereinbarung wurde nun im Hintergrund als XML-Datei erstellt. Sie kann von den Werkzeugen SIP-Creator, Docupack und Documill ab sofort verwendet werden. Damit die Ablieferungsvereinbarung in gut lesbarer Form im Browser dargestellt werden kann wählen Sie wiederum den Menüpunkt "Bearbeitung einer Ablieferungsvereinbarung" an. Dort wählen Sie dann "Web-Ansicht generieren" aus.
+===== Web-Ansicht generieren =====
+Damit die Vereinbarung in gut lesbarer Form im Browser dargestellt werden kann wählen Sie wiederum den Menüpunkt "Bearbeitung einer Ablieferungsvereinbarung" an. Dort wählen Sie dann "Web-Ansicht generieren" aus.\\
+{{:oais:sa-ed-20.png?direct&300|}}\\
+Über den Link "Open PDF" ganz oben ist die Vereinbarung auch als druckbare PDF-Datei zugänglich.\\
+===== SA exportieren =====
+Um eine SA zu exportieren wählen Sie den Menüpunkt "Bearbeitung einer Ablieferungsvereinbarung" und dann "Ablieferungsvereinbarung exportieren". Die SA wird als ZIP gespeichert.
+===== SA publizieren =====
+Die SA wurde nun im Hintergrund als XML-Datei erstellt. Sie kann von den Werkzeugen SIP-Creator, Docupack und Documill nach einem definierten Zeitraum von max. 15. Minuten verwendet werden.
 ===== Projektverwaltung =====
+Alle Benutzer können Projekte erstellen. Der entsprechende Benutzer erhält dann auch explizite Rechte um ein SA dem Projekt hinzuzufügen. Ein Administrator kann weitere Teilnehmer einem Projekt zuordnen (siehe [[oais:sa-editor&#benutzerverwaltung|Benutzerverwaltung]])\\
+Ein Projekt kann nur gelöscht werden, wenn es keine SA enthält.\\
+Ein Projekt kann exportiert werden. Es werden alle SA als XML-Dateien im jeweiligen Verzeichnis exportiert. Für den Import wiederum müssen allerdings die SA einzeln als ZIP verpackt werden (siehe [[oais:sa-editor&#sa_importieren|SA importieren]]).
 :!: Administratoren\\
-Projekte werden durch den Administrator verwaltet. Er kann Projekte umbenennen, Ablieferungsvereinbarungen zwischen Projekten verschieben, Teilnehmer (Benutzer) zu Projekten hinzu fügen.\\
+Projekte werden durch den Administrator verwaltet. Er kann Projekte umbenennen, SA zwischen Projekten verschieben und Teilnehmer (Benutzer) zu Projekten hinzufügen.\\
 {{:oais:sa-ed-18.png?direct&300|}}
+===== Benutzerverwaltung =====
-===== Benuzterverwaltung =====
 :!: Administratoren\\
-Unter Benutzerverwaltung sind alle Anmeldungen für Registrierung aufgelistet.\\
+Neue Benutzer werden erstellt, indem sich diese auf der Login-Seite registrieren. Anschliessend sind in der Benutzerverwaltung alle Anmeldungen für neue Benutzer aufgelistet.
-Nach dem autorisieren können Sie die Benutzerdaten anpassen, den Benutzer zu Projekten hinzufügen oder löschen.\\
+Ein Administrator kann nun registrierte Benutzer für den Zugang autorisiren, Benutzerdaten anpassen, den Benutzer zu Projekten hinzufügen oder diesen löschen.\\
 {{:oais:sa-ed-19.png?direct&300}}