diff --git a/docs/index_de.md b/docs/index_de.md index e8f63ce..b0ee6a0 100644 --- a/docs/index_de.md +++ b/docs/index_de.md @@ -1,243 +1,243 @@ ---- -title: AEON Datenübernahme -identifier: intranda_workflow_aeon_process_creation -description: Dies ist ein Workflow Plugin für den Goobi workflow. Es ermöglicht die Erstellung mehrerer Goobi Vorgäng auf der Grundlage einer ersten AEON-Anfrage. Es ermöglicht die manuelle Auswahl von Elementen aus der AEON-Antwort, um zu entscheiden, für welche Elemente ein Goobi Vorgang erzeugt werden soll. -published: true ---- -## Einführung -Mit diesem Plugin können einzelne Datensätze aus AEON abgefragt werden. Nachdem ein Datensatz abgefragt wurde, werden alle Metadaten aus der sog. Metadata Cloud abgefragt und aufgelistet. Der Nutzer kann anschließend auswählen, welche Datensätze er als Goobi-Vorgang anlegen möchte. - - -## Installation -Das Plugin besteht insgesamt aus den folgenden zu installierenden Dateien: - -```bash -plugin-intranda-workflow-aeon-process-creation-base.jar -plugin-intranda-workflow-aeon-process-creation-gui.jar -plugin_intranda_workflow_aeon_process_creation.xml -``` - -Diese Dateien müssen in den richtigen Verzeichnissen installiert werden, so dass diese nach der Installation unter den folgenden Pfaden vorliegen: - -```bash -/opt/digiverso/goobi/plugins/workflow/plugin-intranda-workflow-aeon-process-creation-base.jar -/opt/digiverso/goobi/plugins/GUI/plugin-intranda-workflow-aeon-process-creation-gui.jar -/opt/digiverso/goobi/config/plugin_intranda_workflow_aeon_process_creation.xml -``` - -Dieses Plugin verfügt über eine eigene Berechtigungsstufe für die Verwendung. Aus diesem Grund müssen Nutzer über die erforderlichen Rechte verfügen. Bitte weisen Sie daher der Benutzergruppe der entsprechenden Nutzer das folgende Recht zu: - -``` -Plugin_workflow_aeon_process_creation -``` - -![Korrekt zugewiesenes Recht für die Nutzer](screen2_de.png) - - -## Überblick und Funktionsweise -Wenn der Nutzer über die Berechtigung zur Nutzung des Plugins verfügt, kann Im Menüpunkt `Worklow` das Plugin `AEON Abfrage Plugin` geöffnet werden. - -![Geöffnetes Plugin ohne ausgeführte Suche](screen3_de.png) - -Hier kann nun ein Transaction identifier eingetragen werden, um die Suche nach einem AEON-Record zu starten. - -![Anzeige der Daten nach Ausführung einer Suche](screen4_de.png) - -Wenn eine erfolgreiche Suche durchgeführt wurde, wurde der Bereich `Abfragedetails` mit den Feldern gefüllt, die innerhalb der Konfiguration im Bereich `` festgelegt wurden. Im Bereich `Eigenschaften für alle Vorgänge` werden die frei definierbaren Eigenschaften aus dem Konfigurationsbereich `` angezeigt. - -Diese Felder lassen sich bearbeiten, sofern dies in der Konfigurationsdatei vorgesehen wurde. Verstöße gegen die Validierung werden unmittelbar bei den einzelnen Feldern angezeigt. - -Im rechten Bereich der Nutzeroberfläche werden die einzelnen ermittelten Datensätze aufgelistet, die innerhalb der Metadata Cloud zu dem Barcode des AEON-Records gefunden wurden. Jede Box stellt hierbei einen eigenständigen Datensatz dar. Mehr Details eines Datensatzes lassen sich anzeigen, indem weitere Felder der Boxen ausgeklappt werden. Über die entsprechenden Icons pro Box lassen sich diejenigen Datensätze auswählen, für die Vorgänge in Goobi erzeugt werden sollen. - -![Ausgeklappte Boxen mit weiteren angezeigten Feldern](screen5_de.png) - -Sofern mindestens ein Datensatz ausgewählt wurde und keine unerfüllten strikten Validierungen vorliegen, lassen sich mittels Klick auf den Button `Vorgänge anlegen` die einzelnen Goobi-Vorgänge für die ausgewählten Datensätze auf der Basis der konfigurierten Produktionsvorlage anlegen. Anschließend gelangt der Nutzer somit auf eine weitere Ansicht. - -![Zweite Seite mit der Möglichkeit einen Laufzettel herunterzuladen](screen6_de.png) - -Hier werden im linken Bereich noch einmal diejenigen Datensätze aufgeführt, für die Vorgänge in Goobi angelegt wurden. Im rechten Bereich steht die Möglichkeit zur Verfügung einen Laufzettel für alle erzeugten Vorgänge zu generieren und herunterzuladen, wo die zugehörigen Vorgänge alle innerhalb eines gemeinsamen Batches zusammengefasst aufgeführt werden. - - -## Konfiguration -Die Konfiguration des Plugins erfolgt über die Konfigurationsdatei `plugin_intranda_workflow_aeon_process_creation.xml` und kann im laufenden Betrieb angepasst werden. Im folgenden ist eine beispielhafte Konfigurationsdatei aufgeführt: - -```xml - - - https://example.com/api - 1234567890 - username - password - - - - digitisation on demand - metadata cloud - - - - - Transaction Identifier - input - Transaction Identifier - This is my description for the field so that everyone gets some help. - \d+ - Your content does not follow our validation guidelines - - - - Creation Date - input - Creation date - This is my description for the field so that everyone gets some help. - Your content does not follow our validation guidelines - - - - Title - input - Main title - Transmission - This is my description for the field so that everyone gets some help. - - - - Document type - input - Doc type - This is my description for the field so that everyone gets some help. - - - - User Name - input - User - This is my description for the field so that everyone gets some help. - - - - - - Strict validation example - input - Strict field - no numeric value - This is my description for the field so that everyone gets some help. - \d+ - Value is no number - - - - Loose validation example - input - Loose field - no numeric value - This is my description for the field so that everyone gets some help. - \d+ - Value is no number - - - - no validation example - input - Text field - default value - This is my description for the field so that everyone gets some help. - Your content does not follow our validation guidelines - - - Dropdown example - select - CoWorker - Steffen - - - - This is my description for the field so that everyone gets some help. - - - - Vocabulary example - vocabulary - Vocabulary - Subject terms - type=Person - This is my description for the field so that everyone gets some help. - - - Boolean example - checkbox - Status - true - This is my description for the field so that everyone gets some help. - - - - - - Bib Identifier - input - Text field - This is my description for the field so that everyone gets some help. - - - Item Title - input - Text field - This is my description for the field so that everyone gets some help. - - - Item Identifier - input - Text field - This is my description for the field so that everyone gets some help. - - - Holding Identifier - input - Text field - This is my description for the field so that everyone gets some help. - - - Record type - select - publication - - - This is my description for the field so that everyone gets some help. - - - Collection - input - Text field - This is my description for the field so that everyone gets some help. - - - -``` - -Innerhalb des Bereiches `` werden die Zugangsdaten verwaltet. Hier müssen die URL zur RESTful API von AEON sowie Nutzername und Passwort hinterlegt werden. Soll alternativ ein Key für die Verwendung der API genutzt werden muss dieser angegeben werden. - -Im Block `` kann definiert werden, welche OPAC-Konfiguration zur Anfrage von Katalogdaten genutzt werden soll und auf Basis welcher Produktionsvorlage die einzelnen Vorgänge erzeugt werden sollen. - -Anschließend erfolgt die Konfiguration der angezeigten und importierbaren Felder. Dies ist in 3 Bereiche aufgeteilt. Der Bereich `` enthält diejenigen Felder, die aus dem AEON-Record gelesen werden. Der Bereich `` enthält frei definierbare Eigenschaften, die zu den zu erzeugenden Vorgängen gehören. Und der Bereich `` enthält die Felder, die bei der Abfrage der Daten aus der Metadata Cloud bezogen wurden. - -Die Konfiguration innerhalb der drei Bereiche ist annähernd identisch. Jedes Feld wird jeweils durch ein Element `` definiert. Innerhalb davon sind anschließend folgende Möglichkeiten vorgesehen: - -Parameter | Erläuterung -------------------- | ----------------------------------------------------- -`title` | Anzeigename des Feldes -`type` | Typ des Feldes, mögliche Werte sind `input` (Textfeld), `select` (Auswahlfeld), `vocabulary` (Auswahlfeld aus einem Vokabular), `checkbox` (Checkbox), `input-dont-overwrite` (Textfeld, das im linken Bereich editierbar ist, aber nicht im rechten Bereich), `radio-dont-overwrite` (Radio-Buttons, die im linken Bereich editierbar sind, aber nicht im rechten Bereich) -`readonly` | Die Werte `true` oder `false` definieren, ob der Inhalt des Feldes bearbeitet werden darf. -`aeon` | Name des json Elements, aus dem das Feld befüllt wird. Dieser Parameter wird für die frei definierbare Eigenschaften nicht ausgewertet. -`displayAlways` | Die Werte `true` oder `false` definieren, ob das Feld angezeigt wird, wenn nur ein minimierter Datensatz angezeigt wird. Dieser Parameter wird ausschließlich für die Felder aus der Metadata Cloud ausgewertet. -`displayInTitle` | Die Werte `true` oder `false` definieren, ob das Feld innerhalb der Kopfzeile der Box aufgeführt wird. Dieser Parameter wird ausschließlich für die Felder aus der Metadata Cloud ausgewertet. -`variable` | Dieser Parameter definiert den Namen der zu erstellenden Eigenschaft. Dieser Parameter wird für Daten aus der Metadata Cloud nicht ausgewertet. -`place` | Hier wird der Typ der Eigenschaft festgelegt. Mögliche Werte sind `work` (Werkstückeigenschaft), `process` (Vorgangseigenschaft), `template` (Vorlageneigenschaft). -`value` | Mit diesem Parameter kann ein Default Wert festgelegt werden. Falls ein AEON Element konfiguriert und durch die Abfrage erhalten wurde, wird der konfigurierte default Wert mit dem Inhalt aus AEON überschrieben. -`help` | Mit diesem Parameter läßt sich ein Hilfetext definieren der optional angezeigt werden kann. -`validation` | Dieser Parameter definiert einen regulären Ausdruck, gegen den der Feldinhalt validiert werden kann. -`strict` | Die Werte `true` oder `false` definieren, ob ein Verstoß gegen die Validierung zwingend behoben werden muss, bevor Vorgänge angelegt werden können. -`message` | Dieser Parameter legt eine Meldung fest, die im Falle von Validierungsfehlern angezeigt werden soll. -`vocabularyName` | Dieser Parameter definiert ein zu nutzendes Vokabular. -`vocabularyField` | Mit dem Parameter `fieldname=value` kann das Trefferset auf Werte eingeschränkt werden, die diese Definition erfüllen. Das Feld ist wiederholbar, um mehrere Einschränkungen gleichzeitig zu definieren. +--- +title: AEON Datenübernahme +identifier: intranda_workflow_aeon_process_creation +description: Dieses Workflow Plugin ermöglicht die Erstellung von Goobi Vorgängen auf der Grundlage einer ersten AEON-Anfrage. Es ermöglicht unter anderem eine manuelle Auswahl von Elementen aus der AEON-Antwort. +published: true +--- +## Einführung +Mit diesem Plugin können einzelne Datensätze aus AEON abgefragt werden. Nachdem ein Datensatz abgefragt wurde, werden alle Metadaten aus der sog. Metadata Cloud abgefragt und aufgelistet. Der Nutzer kann anschließend auswählen, welche Datensätze er als Goobi-Vorgang anlegen möchte. + + +## Installation +Das Plugin besteht insgesamt aus den folgenden zu installierenden Dateien: + +```bash +plugin-intranda-workflow-aeon-process-creation-base.jar +plugin-intranda-workflow-aeon-process-creation-gui.jar +plugin_intranda_workflow_aeon_process_creation.xml +``` + +Diese Dateien müssen in den richtigen Verzeichnissen installiert werden, so dass diese nach der Installation unter den folgenden Pfaden vorliegen: + +```bash +/opt/digiverso/goobi/plugins/workflow/plugin-intranda-workflow-aeon-process-creation-base.jar +/opt/digiverso/goobi/plugins/GUI/plugin-intranda-workflow-aeon-process-creation-gui.jar +/opt/digiverso/goobi/config/plugin_intranda_workflow_aeon_process_creation.xml +``` + +Dieses Plugin verfügt über eine eigene Berechtigungsstufe für die Verwendung. Aus diesem Grund müssen Nutzer über die erforderlichen Rechte verfügen. Bitte weisen Sie daher der Benutzergruppe der entsprechenden Nutzer das folgende Recht zu: + +``` +Plugin_workflow_aeon_process_creation +``` + +![Korrekt zugewiesenes Recht für die Nutzer](screen2_de.png) + + +## Überblick und Funktionsweise +Wenn der Nutzer über die Berechtigung zur Nutzung des Plugins verfügt, kann Im Menüpunkt `Worklow` das Plugin `AEON Abfrage Plugin` geöffnet werden. + +![Geöffnetes Plugin ohne ausgeführte Suche](screen3_de.png) + +Hier kann nun ein Transaction identifier eingetragen werden, um die Suche nach einem AEON-Record zu starten. + +![Anzeige der Daten nach Ausführung einer Suche](screen4_de.png) + +Wenn eine erfolgreiche Suche durchgeführt wurde, wurde der Bereich `Abfragedetails` mit den Feldern gefüllt, die innerhalb der Konfiguration im Bereich `` festgelegt wurden. Im Bereich `Eigenschaften für alle Vorgänge` werden die frei definierbaren Eigenschaften aus dem Konfigurationsbereich `` angezeigt. + +Diese Felder lassen sich bearbeiten, sofern dies in der Konfigurationsdatei vorgesehen wurde. Verstöße gegen die Validierung werden unmittelbar bei den einzelnen Feldern angezeigt. + +Im rechten Bereich der Nutzeroberfläche werden die einzelnen ermittelten Datensätze aufgelistet, die innerhalb der Metadata Cloud zu dem Barcode des AEON-Records gefunden wurden. Jede Box stellt hierbei einen eigenständigen Datensatz dar. Mehr Details eines Datensatzes lassen sich anzeigen, indem weitere Felder der Boxen ausgeklappt werden. Über die entsprechenden Icons pro Box lassen sich diejenigen Datensätze auswählen, für die Vorgänge in Goobi erzeugt werden sollen. + +![Ausgeklappte Boxen mit weiteren angezeigten Feldern](screen5_de.png) + +Sofern mindestens ein Datensatz ausgewählt wurde und keine unerfüllten strikten Validierungen vorliegen, lassen sich mittels Klick auf den Button `Vorgänge anlegen` die einzelnen Goobi-Vorgänge für die ausgewählten Datensätze auf der Basis der konfigurierten Produktionsvorlage anlegen. Anschließend gelangt der Nutzer somit auf eine weitere Ansicht. + +![Zweite Seite mit der Möglichkeit einen Laufzettel herunterzuladen](screen6_de.png) + +Hier werden im linken Bereich noch einmal diejenigen Datensätze aufgeführt, für die Vorgänge in Goobi angelegt wurden. Im rechten Bereich steht die Möglichkeit zur Verfügung einen Laufzettel für alle erzeugten Vorgänge zu generieren und herunterzuladen, wo die zugehörigen Vorgänge alle innerhalb eines gemeinsamen Batches zusammengefasst aufgeführt werden. + + +## Konfiguration +Die Konfiguration des Plugins erfolgt über die Konfigurationsdatei `plugin_intranda_workflow_aeon_process_creation.xml` und kann im laufenden Betrieb angepasst werden. Im folgenden ist eine beispielhafte Konfigurationsdatei aufgeführt: + +```xml + + + https://example.com/api + 1234567890 + username + password + + + + digitisation on demand + metadata cloud + + + + + Transaction Identifier + input + Transaction Identifier + This is my description for the field so that everyone gets some help. + \d+ + Your content does not follow our validation guidelines + + + + Creation Date + input + Creation date + This is my description for the field so that everyone gets some help. + Your content does not follow our validation guidelines + + + + Title + input + Main title + Transmission + This is my description for the field so that everyone gets some help. + + + + Document type + input + Doc type + This is my description for the field so that everyone gets some help. + + + + User Name + input + User + This is my description for the field so that everyone gets some help. + + + + + + Strict validation example + input + Strict field + no numeric value + This is my description for the field so that everyone gets some help. + \d+ + Value is no number + + + + Loose validation example + input + Loose field + no numeric value + This is my description for the field so that everyone gets some help. + \d+ + Value is no number + + + + no validation example + input + Text field + default value + This is my description for the field so that everyone gets some help. + Your content does not follow our validation guidelines + + + Dropdown example + select + CoWorker + Steffen + + + + This is my description for the field so that everyone gets some help. + + + + Vocabulary example + vocabulary + Vocabulary + Subject terms + type=Person + This is my description for the field so that everyone gets some help. + + + Boolean example + checkbox + Status + true + This is my description for the field so that everyone gets some help. + + + + + + Bib Identifier + input + Text field + This is my description for the field so that everyone gets some help. + + + Item Title + input + Text field + This is my description for the field so that everyone gets some help. + + + Item Identifier + input + Text field + This is my description for the field so that everyone gets some help. + + + Holding Identifier + input + Text field + This is my description for the field so that everyone gets some help. + + + Record type + select + publication + + + This is my description for the field so that everyone gets some help. + + + Collection + input + Text field + This is my description for the field so that everyone gets some help. + + + +``` + +Innerhalb des Bereiches `` werden die Zugangsdaten verwaltet. Hier müssen die URL zur RESTful API von AEON sowie Nutzername und Passwort hinterlegt werden. Soll alternativ ein Key für die Verwendung der API genutzt werden muss dieser angegeben werden. + +Im Block `` kann definiert werden, welche OPAC-Konfiguration zur Anfrage von Katalogdaten genutzt werden soll und auf Basis welcher Produktionsvorlage die einzelnen Vorgänge erzeugt werden sollen. + +Anschließend erfolgt die Konfiguration der angezeigten und importierbaren Felder. Dies ist in 3 Bereiche aufgeteilt. Der Bereich `` enthält diejenigen Felder, die aus dem AEON-Record gelesen werden. Der Bereich `` enthält frei definierbare Eigenschaften, die zu den zu erzeugenden Vorgängen gehören. Und der Bereich `` enthält die Felder, die bei der Abfrage der Daten aus der Metadata Cloud bezogen wurden. + +Die Konfiguration innerhalb der drei Bereiche ist annähernd identisch. Jedes Feld wird jeweils durch ein Element `` definiert. Innerhalb davon sind anschließend folgende Möglichkeiten vorgesehen: + +Parameter | Erläuterung +------------------- | ----------------------------------------------------- +`title` | Anzeigename des Feldes +`type` | Typ des Feldes, mögliche Werte sind `input` (Textfeld), `select` (Auswahlfeld), `vocabulary` (Auswahlfeld aus einem Vokabular), `checkbox` (Checkbox), `input-dont-overwrite` (Textfeld, das im linken Bereich editierbar ist, aber nicht im rechten Bereich), `radio-dont-overwrite` (Radio-Buttons, die im linken Bereich editierbar sind, aber nicht im rechten Bereich) +`readonly` | Die Werte `true` oder `false` definieren, ob der Inhalt des Feldes bearbeitet werden darf. +`aeon` | Name des json Elements, aus dem das Feld befüllt wird. Dieser Parameter wird für die frei definierbare Eigenschaften nicht ausgewertet. +`displayAlways` | Die Werte `true` oder `false` definieren, ob das Feld angezeigt wird, wenn nur ein minimierter Datensatz angezeigt wird. Dieser Parameter wird ausschließlich für die Felder aus der Metadata Cloud ausgewertet. +`displayInTitle` | Die Werte `true` oder `false` definieren, ob das Feld innerhalb der Kopfzeile der Box aufgeführt wird. Dieser Parameter wird ausschließlich für die Felder aus der Metadata Cloud ausgewertet. +`variable` | Dieser Parameter definiert den Namen der zu erstellenden Eigenschaft. Dieser Parameter wird für Daten aus der Metadata Cloud nicht ausgewertet. +`place` | Hier wird der Typ der Eigenschaft festgelegt. Mögliche Werte sind `work` (Werkstückeigenschaft), `process` (Vorgangseigenschaft), `template` (Vorlageneigenschaft). +`value` | Mit diesem Parameter kann ein Default Wert festgelegt werden. Falls ein AEON Element konfiguriert und durch die Abfrage erhalten wurde, wird der konfigurierte default Wert mit dem Inhalt aus AEON überschrieben. +`help` | Mit diesem Parameter läßt sich ein Hilfetext definieren der optional angezeigt werden kann. +`validation` | Dieser Parameter definiert einen regulären Ausdruck, gegen den der Feldinhalt validiert werden kann. +`strict` | Die Werte `true` oder `false` definieren, ob ein Verstoß gegen die Validierung zwingend behoben werden muss, bevor Vorgänge angelegt werden können. +`message` | Dieser Parameter legt eine Meldung fest, die im Falle von Validierungsfehlern angezeigt werden soll. +`vocabularyName` | Dieser Parameter definiert ein zu nutzendes Vokabular. +`vocabularyField` | Mit dem Parameter `fieldname=value` kann das Trefferset auf Werte eingeschränkt werden, die diese Definition erfüllen. Das Feld ist wiederholbar, um mehrere Einschränkungen gleichzeitig zu definieren.