3.1.1 Hauptkonfiguration
Die Hauptkonfiguration erfolgt in den folgenden Abschnitten
Abschnitt: identifyTags
<identifyTags>
<repositoryName>OAI Frontend</repositoryName>
<baseURL useInRequestElement="true">http://localhost:8080/viewer/oai/</baseURL>
<protocolVersion> 2.0</protocolVersion>
<adminEmail>[email protected]</adminEmail>
<deletedRecord>transient</deletedRecord>
<granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</identifyTags>
Die Parameter sind in der folgenden Tabelle im einzelnen erklärt:
Option
Bedeutung
repositoryName
Dieser Parameter legt den Namen des OAI-Repositories fest.
baseURL
Dieser Parameter definiert diejenige URL, unter der die OAI-Schnittstelle angesprochen werden kann. Mit dem Attribut useInRequestElement="true"
kann festgelegt werden, dass der hier Konfigurierte Wert für das <request />
Element im OAI-Datensatz verwendet werden soll. Andernfalls wird die URL aus dem Servlet-Request extrahiert. Standardwert ist false
.
protocolVersion
Version des OAI Protokolls.
adminEmail
Kontakt E-Mail Adresse.
deleteRecord
Angabe, wie mit gelöschten Datensätzen umgegangen wird.
no
- Es werden in der Repository keine Informationen über gelöschte Werke unterhalten.persistent
- Informationen über Löschungen werden protokolliert und ohne zeitliche Einschränkung vorgehalten.transient
- Die Repository kann Informationen über Löschungen enthalten. Die Konsistenz der Informationen sowie das Vorhalten über eine unbestimmte Zeit werden aber nicht garantiert.
granularity
Definiert, wie genau mit Zeiten umgegangen wird. Erlaubt sind Datestamps und UTCdatetime.
Abschnitt: oai-identifier
<oai-identifier>
<xmlns>http://www.openarchives.org/OAI/2.0/</xmlns>
<repositoryIdentifier></repositoryIdentifier>
</oai-identifier>
Die Parameter sind in der folgenden Tabelle im einzelnen erklärt:
Option
Bedeutung
xmlns
Standard Namespace für OAI
repositoryIdentier
Optionaler Identifier der Repository. Wird als Präfix für Record Identifier verwendet.
Abschnitt: solr
<solr>
<solrUrl>http://localhost:8983/solr/collection1</solrUrl>
<hitsPerToken>100</hitsPerToken>
<querySuffix>-DC:restricted</querySuffix>
<restrictions>
<!-- <restriction field="ACCESSCONDITION">restricted1</restriction> -->
<!-- <restriction field="ACCESSCONDITION" conditions="-MDNUM_PUBLICRELEASEYEAR:[* TO NOW/YEAR]">restricted2</licenseType> -->
</restrictions>
</solr>
Die Parameter sind in der folgenden Tabelle im einzelnen erklärt:
Option
Bedeutung
solrUrl
URL zur Instanz von Apache Solr. Diese ist in der Regel dieselbe URL, die der Goobi viewer verwendet.
hitsPerToken
Anzahl der Records, die Solr maximal bei einer Anfrage (Seite/Token) zurückgibt. Standardwert ist 20
.
querySuffix
Statisches Suffix, das in sämtlichen Solr Queries enthalten sein soll, um etwa bestimmte Dokumente komplett herauszufiltern.
restrictions/restriction
Hier besteht die Möglichkeit Zugriffsbeschränkungen zu konfigurieren, analog zu denen im Goobi viewer Core.
In Beispiel 1 werden alle Werte herausgefiltert, bei denen im Solr Feld ACCESSCONDITION
der Wert restricted1
steht.
In Beispiel 2 ist gezeigt, wie eine zusätzliche Bedingung im Attribut conditions
angegeben werden kann. Analog zur Konfiguration der Moving Wall werden hier Werke nur dann herausgefiltert, wenn im Feld ACCESSCONDITION
der Wert restricted2
steht und zusätzlich im Feld MDNUM_PUBLICRELEASEYEAR
ein Wert kleiner als das aktuelle Jahr enthalten ist.
Weitere Einstellungen
Außerdem gibt es die folgenden weiteren Parameter:
<viewerConfigFolder>/opt/digiverso/viewer/config/</viewerConfigFolder>
<oaiFolder>/opt/digiverso/viewer/oai/</oaiFolder>
<resumptionTokenFolder>/opt/digiverso/viewer/oai/token/</resumptionTokenFolder>
<urnResolverUrl>http://localhost:8080/viewer/resolver?urn=</urnResolverUrl>
<piResolverUrl>http://localhost:8080/viewer/piresolver?id=</piResolverUrl>
<documentResolverUrl>http://localhost:8080/viewer/metsresolver?id=</documentResolverUrl>
<harvestUrl>http://localhost:8080/viewer/harvest</harvestUrl>
<restApiUrl>http://localhost:8080/viewer/api/v1/</restApiUrl>
<useCollectionBlacklist>true</useCollectionBlacklist>
<defaultLocale>en</defaultLocale>
Die Parameter sind in der folgenden Tabelle im einzelnen erklärt:
Option
Bedeutung
viewerConfigFolder
Pfad der die Goobi viewer Konfigurationsdateien enthält, zum Beispiel die lokale config_oai.xml
Datei.
oaiFolder
Pfad, an dem die MARC21slimUtils.xsl
und MODS2MARC21slim.xsl
Dateien liegen.
resumptionTokenFolder
Pfad, an dem Resumption Tokens abgelegt werden.
urnResolverUrl
Pfad zum internen URN Resolver des Goobi viewers
piResolverUrl
Pfad zum internen Identifier Resolver des Goobi viewers
documentResolverUrl
URL des Resolvers von METS und LIDO-Dokumenten (nur intern erreichbar)
harvestUrl
URL der Harvest-API des Goobi viewers (nur intern erreichbar). Dieser wird dazu verwendet, Crowdsourcing-Ergebnisse und Übersichtsseiten-Konfigurationen über OAI auszuliefern.
restApiUrl
URL zur Goobi viewer Core REST API zum Abrufen von Volltexten, ALTO, TEI, CMDI und Inhaltsverzeichnis
useCollectionBlacklist
Falls true, wird die im Goobi viewer konfigurierten Collection Blacklists berücksichtigt und betreffende Werke herausgefiltert. Standardwert ist true
.
defaultLocale
Sprache, in die zu übersetztende Werte übersetzt werden sollen. Standardwert ist en
.
Last updated