Die vorliegende Dokumentation beschreibt die Installation, die Konfiguration und den Einsatz des Fedora Export Plugins in Goobi workflow.
Details | |
Identifier | prov_export_fedora |
Source code | https://gitea.intranda.com/goobi-workflow/goobi-plugin-export-fedora-prov |
Lizenz | GPL 2.0 oder neuer |
Kompatibilität | Goobi workflow 3.0 und neuer |
Dokumentationsdatum | 18.12.2019 |
Die Konfiguration erfolgt über die Konfigurationsdatei intranda_export_fedora.xml
und kann im laufenden Betrieb angepasst werden.
<config_plugin><config><!-- which workflow to use for (can be more then one, otherwise use *) --><workflow>*</workflow><!-- general Fedora configuration data --><fedoraUrl>http://localhost:8080/fedora/rest</fedoraUrl><useVersioning>false</useVersioning><!-- Basic HTTP authentication user name (optional) --><userName>foo</userName><!-- Basic HTTP authentication password (optional) --><password>bar</password><!-- which content to ingest --><ingestMaster>true</ingestMaster><ingestMedia>false</ingestMedia><ingestJp2>false</ingestJp2><ingestPdf>false</ingestPdf><!-- command for specific property including the parameter for Barcode and for the unit-or-item-type --><externalLinkContent>PREFIX crm: <http://www.cidoc-crm.org/cidoc-crm/>INSERT { <> crm:P70_documents <http://example.com/code=[UNIT_ITEM_CODE]&entityId=[BARCODE]#> }WHERE { }</externalLinkContent><!-- command for specific property including the parameter for PID --><externalLinkContentPID>PREFIX crm:<http://www.cidoc-crm.org/cidoc-crm/>INSERT { <> crm:P70_documents <http://example.com/resolver?pid=/[PID]#> }WHERE { }</externalLinkContentPID><!-- command for specific property including the parameter for full_partial --><fullPartialContent>PREFIX crm: <http://www.cidoc-crm.org/cidoc-crm/>INSERT { <> crm:P3_has_note "[FULL_PARTIAL]" }WHERE { }</fullPartialContent><!-- Property containing the public release date (optional)--><availableMetadataQuery>PREFIX dcterms: <http://purl.org/dc/terms/>INSERT {<> dcterms:available "[DATE_AVAILABLE]" .}WHERE { }</availableMetadataQuery><!-- Properties query for the /images container --><imagesContainerMetadataQuery>PREFIX ldp: <http://www.w3.org/ns/ldp#>PREFIX pcdm: <http://pcdm.org/models#>INSERT {<> a ldp:DirectContainer\,pcdm:Object ;ldp:membershipResource <[URL]> ;ldp:hasMemberRelation pcdm:hasMember .}WHERE { }</imagesContainerMetadataQuery><!-- Properties query for the /files container --><filesContainerMetadataQuery>PREFIX ldp: <http://www.w3.org/ns/ldp#>PREFIX pcdm: <http://pcdm.org/models#>INSERT {<> a ldp:DirectContainer\,pcdm:Object ;ldp:membershipResource <[URL]> ;ldp:hasMemberRelation pcdm:hasFile .}WHERE { }</filesContainerMetadataQuery><!-- Properties query for the /fcr:metadata part of a file --><imageFileMetadataQuery>PREFIX exif: <https://www.w3.org/2003/12/exif/ns#>INSERT {<> exif:imageLength [HEIGHT] ;exif:imageWidth [WIDTH] .}WHERE { }</imageFileMetadataQuery></config><config><!-- which workflow to use for (can be more then one, otherwise use *) --><workflow>My_special_workflow</workflow>...</config></config_plugin>
Parameter | Erläuterung |
| REST Endpoint des Fedora Applikation |
| Wenn |
| Optionale Basic HTTP Authentifizierung. Beide Werte müssen gesetzt sein, damit die Authentifizierung stattfindet. |
| Wenn |
| Wenn |
| Wenn |
| Wenn |
| Wenn |
| Wenn |
| Externe URL mit Verwendung eines 10-stelligen Barcodes und des Unit Item Codes. |
| Externe URL mit Verwendung einer 36-stelligen PID. |
| |
| Optionale SPARQL-Query, um das Veröffentlichungs-Datum als Attribut zum Root-Container des Werks hinzuzufügen. Die Prozesseigenschaft |
| Optionale SPARQL-Query, um zusätzliche Attribute und Verlinkungen zum |
| Optionale SPARQL-Query, um zusätzliche Attribute und Verlinkungen zum |
| Optionale SPARQL-Query, um für alle Bilddateien im Repository (unter z.B. |
Der Block <config>
ist wiederholbar und kann so in unterschiedlichen Projekten verschiedene Metadaten definieren. Die Unterelemente <workflow>
wird zur Prüfung genutzt, ob der vorliegende Block für den aktuellen Schritt genutzt werden soll. Dabei wird geprüft, ob es einen Eintrag gibt, der sowohl den Workflow-Namen enthält. Ist dies nicht der Fall, wird der Block mit <workflow>*</workflow>
verwendet.
Es muss ein Export Schritt konfiguriert werden:
Export DMS
Automatische Aufgabe
Plugin für Arbeitsschritt: FedoraExport
Bei der Ausführung des Schrittes wird ein Export des Goobi Vorgangs (analog zum Export ins Dateisystem) in das konfigurierte Fedora Repository unter Berücksichtigung der Konfiguration (siehe oben) eingespielt.
Es werden für die Bildung der Container-URLs bzw. von zusätzlichen Container-Attributen folgende Vorgangseigenschaften hinzugezogen (und sind unter Umständen zwingend erforderlich):
barcode (enthält einen 10-stelligen Barcode oder eine 36-stellige PID)
unit_Item_code (nur bei Barcodes)
full_partial
Die Daten des Vorgangs lassen sich anschließend über das folgende URL-Muster im Repository abrufen:
http(s)://<Fedora REST endpoint>/records/<barcode.substring(0,4)>/<barcode.sunstring(4,8)>/<barcode.substring(8,10)>/
http://localhost:8888/fedora/rest/records/barc/ode1/234/images/
http://localhost:8888/fedora/rest/records/barc/ode1/234/images/1/files/master_00000001.tif http://localhost:8888/fedora/rest/records/barc/ode1/234/images/2/files/master_00000002.tif http://localhost:8888/fedora/rest/records/barc/ode1/234/images/3/files/master_00000003.tif
http://localhost:8888/fedora/rest/records/barc/ode1/234/images/1/files/00000001.jp2 http://localhost:8888/fedora/rest/records/barc/ode1/234/images/2/files/00000002.jp2 http://localhost:8888/fedora/rest/records/barc/ode1/234/images/3/files/00000003.jp2
http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6 /images/
http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6 /images/1/files/master_00000001.tif http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6/images/2/files/master_00000002.tif http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6/images/3/files/master_00000003.tif
http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6/images/1/files/00000001.jp2 http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6/images/2/files/00000002.jp2 http://localhost:8888/fedora/rest/records/DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6/images/3/files/00000003.jp2