3.1.1 Main Configuration

The main configuration is done in the following sections

Section: identifyTags

config_oai.xml

<identifyTags>
    <repositoryName>OAI Frontend</repositoryName>
    <baseURL useInRequestElement="true">http://localhost:8080/viewer/oai/</baseURL>
    <protocolVersion> 2.0</protocolVersion>
    <adminEmail>[e-mail]</adminEmail>
    <deletedRecord>transient</deletedRecord>
    <granularity>YYYY-MM-DDThh:mm:ssZ</granularity>
</identifyTags>

The parameters are explained in detail in the following table:

Setting	Description
repositoryName	This parameter specifies the name of the OAI repository.
baseURL	This parameter defines the URL under which the OAI interface can be addressed. With the attribute useInRequestElement="true" it can be specified that the value configured here is to be used for the <request /> element in the OAI dataset. Otherwise the URL is extracted from the servlet request. Default value is false.
protocolVersion	Version of the OAI protocol.
adminEmail	Contact e-mail address.
deleteRecord	Specifies how deleted records are handled. no - No information about deleted records is maintained in the repository. persistent - Information about deletions is logged and stored without any time limitation. transient - The repository may contain information about deletions. The consistency of the information as well as the retention over an indefinite period are not guaranteed however.
granularity	Defines how exactly times are handled. Datestamps and UTCdatetime are allowed.

Section: oai-identifier

config_oai.xml

<oai-identifier>
    <xmlns>http://www.openarchives.org/OAI/2.0/</xmlns>
    <repositoryIdentifier></repositoryIdentifier>
</oai-identifier>

The parameters are explained in detail in the following table:

Setting	Description
xmlns	Standard namespace for OAI
repositoryIdentier	Optional identifier of the repository. Used as a prefix for Record Identifier.

Section: solr

config_oai.xml

<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>

The parameters are explained in detail in the following table:

Setting	Description
solrUrl	URL to the instance of Apache Solr. This is usually the same URL used by the Goobi viewer.
hitsPerToken	The maximum number of records Solr can return for a request (page/token). The default value is 20.
querySuffix	Static suffix that is to be included in all Solr queries in order to completely filter out certain documents, for example.
restrictions/restriction	Here you can configure access restrictions in the same way as in the Goobi viewer Core. In example 1, all values are filtered out where the Solr field ACCESSCONDITION contains the value restricted1. Example 2 shows how an additional condition can be specified in the conditions attribute. Similar to the configuration of the Moving Wall, records are only filtered out here if the field ACCESSCONDITION contains the value restricted2 and the field MDNUM_PUBLICRELEASEYEAR also contains a value smaller than the current year.

Further settings

There are also the following other parameters:

config_oai.xml

<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/rest/</restApiUrl>
<fulltextUrl>http://localhost:8080/viewer/api/v1/records/{pi}/files/plaintext/{fileName}/</fulltextUrl>
‌<useCollectionBlacklist>true</useCollectionBlacklist>
<defaultLocale>en</defaultLocale>

The parameters are explained in detail in the following table:

Setting	Description
viewerConfigFolder	Path containing the Goobi viewer configuration files, for example the local config_oai.xml file:
oaiFolder	​Path where the MARC21slimUtils.xsl and MODS2MARC21slim.xsl files are located.
resumptionTokenFolder	Path where resumption tokens are stored
urnResolverUrl	‌Path to the internal URN resolver of the Goobi viewer
piResolverUrl	‌This is the path to the internal identifier resolver of the Goobi viewer
documentResolverUrl	‌URL of the resolver of METS and LIDO documents (can only be reached internally)
harvestUrl	URL of the Harvest API of the Goobi viewer (only accessible internally). This is used to deliver crowdsourcing results and overview page configurations via OAI
restApiUrl	URL to the Goobi viewer Core REST API for retrieving full text, ALTO, TEI, CMDI and table of contents:
fulltextUrl	URL to the Goobi viewer Core REST API for retrieving full text single pages. Allowed parameters that are automatically filled in by the indexer are: {pi} {fileName} {page}
useCollectionBlacklist	If true, the collection blacklists configured in the Goobi viewer are taken into account and the relevant records are filtered out. The default value is true.
defaultLocale	Language into which the values to be translated are to be translated. The default value is en.