Fedora Export PROV

Einführung
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
Konfiguration
Die Konfiguration erfolgt über die Konfigurationsdatei intranda_export_fedora.xml und kann im laufenden Betrieb angepasst werden.
1
<config_plugin>
2
    <config>
3
        <!-- which workflow to use for (can be more then one, otherwise use *) -->
4
        <workflow>*</workflow>
5
​
6
        <!-- general Fedora configuration data -->
7
        <fedoraUrl>http://localhost:8080/fedora/rest</fedoraUrl>
8
        <useVersioning>false</useVersioning>
9
        <!-- Basic HTTP authentication user name (optional) -->
10
        <userName>foo</userName>
11
        <!-- Basic HTTP authentication password (optional) -->
12
        <password>bar</password>
13
​
14
        <!-- which content to ingest -->
15
        <ingestMaster>true</ingestMaster>
16
        <ingestMedia>false</ingestMedia>
17
        <ingestJp2>false</ingestJp2>
18
        <ingestPdf>false</ingestPdf>
19
​
20
        <!-- command for specific property including the parameter for Barcode and for the unit-or-item-type -->
21
        <externalLinkContent>
22
            PREFIX crm: &lt;http://www.cidoc-crm.org/cidoc-crm/&gt;
23
            INSERT { &lt;&gt; crm:P70_documents &lt;http://example.com/code=[UNIT_ITEM_CODE]&amp;entityId=[BARCODE]#&gt; }
24
            WHERE { }
25
        </externalLinkContent>
26
​
27
        <!-- command for specific property including the parameter for PID -->
28
        <externalLinkContentPID>
29
            PREFIX crm:&lt;http://www.cidoc-crm.org/cidoc-crm/&gt;
30
            INSERT { &lt;&gt; crm:P70_documents &lt;http://example.com/resolver?pid=/[PID]#&gt; }
31
            WHERE { }
32
        </externalLinkContentPID>
33
​
34
        <!-- command for specific property including the parameter for full_partial -->
35
        <fullPartialContent>
36
            PREFIX crm: &lt;http://www.cidoc-crm.org/cidoc-crm/&gt;
37
            INSERT { &lt;&gt; crm:P3_has_note "[FULL_PARTIAL]" }
38
            WHERE { }
39
        </fullPartialContent>
40
​
41
        <!-- Property containing the public release date (optional)-->
42
        <availableMetadataQuery>
43
            PREFIX dcterms: &lt;http://purl.org/dc/terms/&gt;
44
            INSERT {
45
                &lt;&gt; dcterms:available "[DATE_AVAILABLE]" .
46
            }
47
            WHERE { }
48
        </availableMetadataQuery>
49
​
50
        <!-- Properties query for the /images container -->
51
        <imagesContainerMetadataQuery>
52
            PREFIX ldp: &lt;http://www.w3.org/ns/ldp#&gt;
53
            PREFIX pcdm: &lt;http://pcdm.org/models#&gt;
54
            INSERT {
55
                &lt;&gt; a ldp:DirectContainer\,pcdm:Object ;
56
                ldp:membershipResource &lt;[URL]&gt; ;
57
                ldp:hasMemberRelation pcdm:hasMember .
58
            }
59
            WHERE { }
60
        </imagesContainerMetadataQuery>
61
​
62
        <!-- Properties query for the /files container -->
63
        <filesContainerMetadataQuery>
64
            PREFIX ldp: &lt;http://www.w3.org/ns/ldp#&gt;
65
            PREFIX pcdm: &lt;http://pcdm.org/models#&gt;
66
            INSERT {
67
                &lt;&gt; a ldp:DirectContainer\,pcdm:Object ;
68
                ldp:membershipResource &lt;[URL]&gt; ;
69
                ldp:hasMemberRelation pcdm:hasFile .
70
            }
71
            WHERE { }
72
        </filesContainerMetadataQuery>
73
​
74
        <!-- Properties query for the /fcr:metadata part of a file -->
75
        <imageFileMetadataQuery>
76
            PREFIX exif: &lt;https://www.w3.org/2003/12/exif/ns#&gt;
77
            INSERT {
78
                &lt;&gt;  exif:imageLength [HEIGHT] ;
79
                exif:imageWidth [WIDTH] .
80
            }
81
            WHERE { }
82
        </imageFileMetadataQuery>
83
​
84
    </config>
85
​
86
    <config>
87
        <!-- which workflow to use for (can be more then one, otherwise use *) -->
88
        <workflow>My_special_workflow</workflow>
89
        ...
90
    </config>
91
</config_plugin>
Copied!
Parameter
Erläuterung
fedoraUrl
REST Endpoint des Fedora Applikation
useVersioning
Wenn true gesetzt ist, wird die Revisionierung von Fedora verwendet. In diesem Fall wird für jeder Ausführung des Exportschrittes eine neue Revision des Vorgangs im Repository angelegt. Standardwert ist true.
userName, password
Optionale Basic HTTP Authentifizierung. Beide Werte müssen gesetzt sein, damit die Authentifizierung stattfindet.
ingestMaster
Wenn true gesetzt ist, werden die Master-Bilder des Vorgangs exportiert. Standardwert ist true.
ingestMedia
Wenn true gesetzt ist, werden die Derivate des Vorgangs exportiert. Standardwert ist true.
ingestJp2
Wenn true gesetzt ist, werden die JPEG2000-Bilder des Vorgangs in den Subcontainer /media exportiert. Standardwert ist true.
ingestPdf
Wenn true gesetzt ist, werden die PDFs des Vorgangs in den Subcontainer /media exportiert. Standardwert ist true.
ingestMetsFile
Wenn true gesetzt ist, eine METS/MODS Datei erzeugt und im Container Exportiert. Standardwert ist true.
exportMetsFile
Wenn true gesetzt ist, eine METS/MODS Datei erzeugt und in den üblichen Export-Ordner (z.B. /hotfolder) geschrieben. Standardwert ist true.
externalLinkContent
Externe URL mit Verwendung eines 10-stelligen Barcodes und des Unit Item Codes.
externalLinkContentPID
Externe URL mit Verwendung einer 36-stelligen PID.
fullPartialContent
​
availableMetadataQuery
Optionale SPARQL-Query, um das Veröffentlichungs-Datum als Attribut zum Root-Container des Werks hinzuzufügen. Die Prozesseigenschaft available muss hierfür gesetzt sein.
imagesContainerMetadataQuery
Optionale SPARQL-Query, um zusätzliche Attribute und Verlinkungen zum /images-Container hinzuzufügen.
filesContainerMetadataQuery
Optionale SPARQL-Query, um zusätzliche Attribute und Verlinkungen zum /files-Container hinzuzufügen.
imageFileMetadataQuery
Optionale SPARQL-Query, um für alle Bilddateien im Repository (unter z.B. ../00000001.tif/fcr:metadata) zusätzliche Attribute zu schreiben.
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.
Nutzung in Goobi
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:
1
http(s)://<Fedora REST endpoint>/records/<barcode.substring(0,4)>/<barcode.sunstring(4,8)>/<barcode.substring(8,10)>/
Copied!
Beispiele für die URLs nach erfolgreichem Ingest nach Fedora
Beispiel mit Barcode (barcode=“barcode123”):
Hauptcontainer für die Bilder
​http://localhost:8888/fedora/rest/records/barc/ode1/234/images/​
Container für die Master-Bilder
​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​
Container für die JP2-Derivate
​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​
Beispiel mit PID (barcode=“DB0027DB-F83B-11E9-AE98-A392051B17E6”):
Hauptcontainer für die Bilder
​http://localhost:8888/fedora/rest/records/​DB/00/27/DB/-F83B-11E9-AE98-A392051B17E6
/images/​
Container für die Master-Bilder
​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​
Container für die JP2-Derivate
​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​