-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request 'Release v24.07' (#12) from release_24.07 into master
- Loading branch information
Showing
6 changed files
with
221 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: EWIG Langzeitarchivierung | ||
| identifier: intranda_step_lza_ewig | ||
| published: true | ||
| description: Dieses Step-Plugin erlaubt den Ingest von Vorgängen in das Langzeitarchiv EWIG. | ||
| --- | ||
| ## Einführung | ||
| Die vorliegende Dokumentation beschreibt die Installation, Konfiguration und den Einsatz eines Plugins zum Erstellen einer METS Datei für die Langzeitarchivierung EWIG. | ||
|
|
||
|
|
||
| ## Installation | ||
| Das Plugin besteht aus zwei Dateien: | ||
|
|
||
| ```bash | ||
| plugin_intranda_step_LZA_EWIG-base.jar | ||
| plugin_intranda_step_lza_ewig.xml | ||
| ``` | ||
|
|
||
| Die Datei `plugin_intranda_step_LZA_EWIG-base.jar` enthält die Programmlogik und muss für den tomcat-Nutzer lesbar in folgendes Verzeichnis installiert werden: | ||
|
|
||
| ```bash | ||
| /opt/digiverso/goobi/plugins/step/ | ||
| ``` | ||
|
|
||
| Die Datei `plugin_intranda_step_lza_ewig.xml` muss ebenfalls für den tomcat-Nutzer lesbar sein und in folgendes Verzeichnis installiert werden: | ||
|
|
||
| ```bash | ||
| /opt/digiverso/goobi/config/ | ||
| ``` | ||
|
|
||
|
|
||
| ## Überblick und Funktionsweise | ||
| Nachdem das Plugin installiert und konfiguriert wurde, kann es innerhalb eines Arbeitsschrittes genutzt werden. Dazu muss innerhalb der gewünschten Aufgabe das Plugin `intranda_step_lza_ewig` ausgewählt werden. Des Weiteren muss die Checkbox Automatische Aufgabe gesetzt sein. | ||
|
|
||
|  | ||
|
|
||
| Der Arbeitsschritt innerhalb von Goobi workflow exportiert alle notwendigen Dateien für den EWIG Ingest. Der Upload selbst erfolgt über den intranda TaskManager. Dies ist sinnvoll, um zu vermeiden, das mehrere parallel laufende Uploadvorgänge Konflikte mit einander haben und das System verlangsamen. Für den Upload siehe [Kapitel 4.17](https://docs.intranda.com/intranda-taskmanager-de/4/4.17-upload-von-dateien-in-das-ewig-langzeitarchiv) in der intranda TaskManager Dokumentation. | ||
|
|
||
|
|
||
| ## Konfiguration | ||
| Die Konfigurationsdatei `plugin_intranda_step_lza_ewig.xml` muss wie folgt aufgebaut sein: | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <config_plugin> | ||
| <config> | ||
| <project>*</project> | ||
| <step>*</step> | ||
| <exportFolder>/opt/digiverso/</exportFolder> | ||
| <exportXmlLog>true</exportXmlLog> | ||
| <createManifest>true</createManifest> | ||
|
|
||
| <manifestParameter | ||
| name="SubmissionManifestVersion">2.0</manifestParameter> | ||
| <manifestParameter name="SubmittingOrganization">Example | ||
| organisation</manifestParameter> | ||
| <manifestParameter | ||
| name="OrganizationIdentifier">DE-1</manifestParameter> | ||
| <manifestParameter name="ContractNumber">1234567</manifestParameter> | ||
| <manifestParameter name="Contact">Mustermann, | ||
| Max</manifestParameter> | ||
| <manifestParameter name="ContactRole">Abteilungsleitung | ||
| Bibliothek</manifestParameter> | ||
| <manifestParameter | ||
| name="ContactEmail">max.mustermann@example.com</manifestParameter> | ||
| <manifestParameter name="TransferCurator">Doe, | ||
| John</manifestParameter> | ||
| <manifestParameter | ||
| name="TransferCuratorEmail">john.doe@example.com</manifestParameter> | ||
| <manifestParameter | ||
| name="SubmissionName">[Abteilungskürzel]_[eindeutiger | ||
| Name]</manifestParameter> | ||
| <manifestParameter | ||
| name="SubmissionDescription">${meta.singleDigCollection};Digitalisierungsprojekt | ||
| der ZLB</manifestParameter> | ||
| <manifestParameter | ||
| name="RightsHolder">${meta.rightsHolder};N/A</manifestParameter> | ||
| <manifestParameter | ||
| name="Rights">http://id.loc.gov/vocabulary/preservation/copyrightStatus/pub</manifestParameter> | ||
| <manifestParameter name="RightsDescription">''</manifestParameter> | ||
| <manifestParameter | ||
| name="License">${meta.AccessLicense};${meta.AccessStatus};https://creativecommons.org/publicdomain/mark/1.0/</manifestParameter> | ||
| <manifestParameter | ||
| name="AccessRights">${meta.AccessStatus};public</manifestParameter> | ||
| <manifestParameter | ||
| name="MetadataFileFormat">http://www.loc.gov/METS/</manifestParameter> | ||
| <manifestParameter | ||
| name="endpoint">https://goobi.example.com/api/endpoint/wi</manifestParameter> | ||
| </config> | ||
| </config_plugin> | ||
| ``` | ||
|
|
||
| Der `<config>` Block ist wiederholbar und kann so in unterschiedlichen Projekten verschiedene Parameter definieren. Die Unterelemente `<project>` und `<step>` werden zur Prüfung genutzt, ob der vorliegende Block für den aktuellen Schritt genutzt werden soll. Dabei wird zuerst geprüft, ob es einen Eintrag gibt, der sowohl den Projektnamen als auch den Schrittenamen enthält. Ist dies nicht der Fall, wird nach einem Eintrag für durch den gekennzeichnete, beliebige Projekte und dem verwendeten Schrittenamen gesucht. Wenn dazu ebenfalls kein Eintrag gefunden wurde, erfolgt eine Suche nach dem Projektnamen und beliebigen Schritten, ansonsten greift der default Block, bei dem sowohl `<project>` als auch `<step>`_ enthalten. | ||
|
|
||
| Im Element `<exportFolder>` wird dabei festgelegt an welcher Stelle im Dateisystem die exportierten METS Dateien abgelegt werden. | ||
|
|
||
| Mittels `<exportXmlLog>` wird festgelegt, ob das XML Log ebenfalls exportiert und in die METS Datei geschrieben werden soll. Das Log enthält Informationen über den Workflow. | ||
|
|
||
| Das Element `<createManifest>` steuert, ob ein submission manifest erzeugt werden soll. Ist dies der Fall, müssen auch die `<manifestParameter>` konfiguriert werden. | ||
|
|
||
| Jeder `<manifestParameter>` besteht aus zwei Teilen, dem Attribut `name`, das den Namen des Parameters enthält, sowie dem Text, in dem die gewünschten Feldinhalte konfiguriert werden. Dabei können sowohl statische Texte als auch alle in Goobi bekannten Variablen genutzt werden. Mehrere Parameter können mittels Semikolon getrennt angegeben werden. Für den Fall, dass der erste Wert nicht bekannt ist, weil zum Beispiel das konfigurierte Metadatum nicht ausgefüllt wurde, wird dann der nächste Wert probiert. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: EWIG Long term archiving | ||
| identifier: intranda_step_lza_ewig | ||
| published: true | ||
| description: This step plug-in allows you to ingest processes into the EWIG long-term archive. | ||
| --- | ||
| ## Introduction | ||
| This documentation describes the installation, configuration and use of a plugin for creating a METS file for long-term archiving EWIG. | ||
|
|
||
|
|
||
| ## Installation | ||
| The plugin consists of two files: | ||
|
|
||
| ```bash | ||
| plugin_intranda_step_LZA_EWIG-base.jar | ||
| plugin_intranda_step_lza_ewig.xml | ||
| ``` | ||
|
|
||
| The file `plugin_intranda_step_LZA_EWIG-base.jar` contains the program logic and must be installed in the following directory so that it is readable for the tomcat user: | ||
|
|
||
| ```bash | ||
| /opt/digiverso/goobi/plugins/step/ | ||
| ``` | ||
|
|
||
| The `plugin_intranda_step_lza_ewig.xml` file must also be readable by the tomcat user and installed in the following directory: | ||
|
|
||
| ```bash | ||
| /opt/digiverso/goobi/config/ | ||
| ``` | ||
|
|
||
|
|
||
| ## Overview and functionality | ||
| After the plugin has been installed and configured, it can be used within one step. To do this, the `intranda_step_lza_ewig` plugin must be selected within the desired task. The Automatic Task checkbox must also be selected. | ||
|
|
||
|  | ||
|
|
||
| This step within Goobi workflow exports all the files required for EWIG Ingest. The upload itself is carried out via the intranda TaskManager. This is useful to avoid several upload processes running in parallel having conflicts with each other and slowing down the system. For uploads, see [chapter 4.17 ](https://docs.intranda.com/intranda-taskmanager-de/4/4.17-upload-von-dateien-in-das-ewig-langzeitarchiv)in the intranda TaskManager documentation. | ||
|
|
||
|
|
||
| ## Configuration | ||
| The configuration file `plugin_intranda_step_lza_ewig.xml` must be structured as follows: | ||
|
|
||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <config_plugin> | ||
| <config> | ||
| <project>*</project> | ||
| <step>*</step> | ||
| <exportFolder>/opt/digiverso/</exportFolder> | ||
| <exportXmlLog>true</exportXmlLog> | ||
| <createManifest>true</createManifest> | ||
|
|
||
| <manifestParameter | ||
| name="SubmissionManifestVersion">2.0</manifestParameter> | ||
| <manifestParameter name="SubmittingOrganization">Example | ||
| organisation</manifestParameter> | ||
| <manifestParameter | ||
| name="OrganizationIdentifier">DE-1</manifestParameter> | ||
| <manifestParameter name="ContractNumber">1234567</manifestParameter> | ||
| <manifestParameter name="Contact">Mustermann, | ||
| Max</manifestParameter> | ||
| <manifestParameter name="ContactRole">Abteilungsleitung | ||
| Bibliothek</manifestParameter> | ||
| <manifestParameter | ||
| name="ContactEmail">max.mustermann@example.com</manifestParameter> | ||
| <manifestParameter name="TransferCurator">Doe, | ||
| John</manifestParameter> | ||
| <manifestParameter | ||
| name="TransferCuratorEmail">john.doe@example.com</manifestParameter> | ||
| <manifestParameter | ||
| name="SubmissionName">[Abteilungskürzel]_[eindeutiger | ||
| Name]</manifestParameter> | ||
| <manifestParameter | ||
| name="SubmissionDescription">${meta.singleDigCollection};Digitalisierungsprojekt | ||
| der ZLB</manifestParameter> | ||
| <manifestParameter | ||
| name="RightsHolder">${meta.rightsHolder};N/A</manifestParameter> | ||
| <manifestParameter | ||
| name="Rights">http://id.loc.gov/vocabulary/preservation/copyrightStatus/pub</manifestParameter> | ||
| <manifestParameter name="RightsDescription">''</manifestParameter> | ||
| <manifestParameter | ||
| name="License">${meta.AccessLicense};${meta.AccessStatus};https://creativecommons.org/publicdomain/mark/1.0/</manifestParameter> | ||
| <manifestParameter | ||
| name="AccessRights">${meta.AccessStatus};public</manifestParameter> | ||
| <manifestParameter | ||
| name="MetadataFileFormat">http://www.loc.gov/METS/</manifestParameter> | ||
| <manifestParameter | ||
| name="endpoint">https://goobi.example.com/api/endpoint/wi</manifestParameter> | ||
| </config> | ||
| </config_plugin> | ||
| ``` | ||
|
|
||
| The `<config>` block is repeatable and can therefore define different parameters in different projects. The subelements `<project>` and `<step>` are used to check whether the present block should be used for the current step. First, the system checks whether there is an entry containing both the project name and the step name. If this is not the case, an entry for any project marked by the arbitrary project name and the step name used is searched for. If no entry is found, a search is performed for the project name and any steps, otherwise the default block is used, which contains both `<project>` and `<step>`. | ||
|
|
||
| The element `<exportFolder>` defines where in the file system the exported METS files are stored. | ||
|
|
||
| With `<exportXmlLog>` you can determine whether the XML log should also be exported and written to the METS file. The log contains information about the workflow. | ||
|
|
||
| The `<createManifest>` element controls whether a submission manifest should be created. If this is the case, the `<manifestParameter>` must also be configured. | ||
|
|
||
| Each `<manifestParameter>` consists of two parts, the `name` attribute, which contains the name of the parameter, and the text in which the desired field contents are configured. Both static texts and all variables known in Goobi can be used. Several parameters can be specified separated by semicolons. If the first value is not known because, for example, the configured metadata has not been filled in, the next value is then tried. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters