Date: Fri, 29 Mar 2024 02:04:59 -0400 (EDT) Message-ID: <1567687036.29830.1711692299792@lyrasis1-roc-mp1> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_29829_1607436388.1711692299792" ------=_Part_29829_1607436388.1711692299792 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
The Islandora OAI module (based on the oai2forcck Drupa= l module) provides support for a site to be visible via the Open Archives Initiative P= rotocol for Metadata Harvesting (OAI-PMH). In short, a site properly config= ured using this module has its Solr index - and accompanying metadata - vis= ible to other sites that harvest OAI-compatible metadata. These harvesters = make various types of requests at a URL that you can specify, and your site= responds with metadata information that they in turn can add to massive ar= chival indices. This makes it much easier for researchers to find objects o= n your site.
For more information on the OAI-PMH, you may consult the official docume= ntation at http://www.openarchives.org/OAI/openarchivesprotocol.html.
Besides installing the Islandora Solr modules, you will also need to cor= rectly configure Solr and GSearch in order for Islandora OAI to work. The O= AI module passes information to metadata harvesters based on results it fin= ds from your Solr index; if Solr is not properly configured, OAI won't func= tion either.
Islandora OAI works mostly autonomously. It gets requests from metadata = harvesters in the form of HTTP POST keys that come after your OAI URL. Your= site then sends back information, in XML format, based on the values of th= e keys that were given. You can check that your configuration is correct by= manually entering these keys in your browser's address bar, and seeing wha= t comes back.
A simple check you can run involves asking your OAI URL for a list of in= formation about your repository. To do this, you will need to know a few of= your site's OAI configuration options. More information on this can be fou= nd in the next section of this page.
To check for the first few records, use your browser to access the follo= wing site:
http://path.to.your.site= /repository?verb=3DIdentify
Where:
If your Solr Index is set up correctly, and you entered the URL properly= , you should see an XML file containing information about your OAI setup.= p>
Configuration options for the Islandora OAI module can be found at http:= //path.to.your.site/admin/islandora/tools/islandora-oai an= d include the following options:
If you select "configure" you see the following screens.
Below this is the "Metadata Format" section:
This section allows you to configure the settings for the OAI-PMH'smetad= ata_prefix verb; Islandora uses XSL files to define the method for transfor= ming your site's metadata datastreams into a format compatible with the OAI= -PMH. Islandora OAI comes with two XSL files; they convert the MODS datastr= eam of an object to either Electronic Thesis and Dissertation Metadata Stan= dard format or Dublin Core format, which then can be served up to a harvest= er.
Transformations - This section allows you to confi= gure the way Islandora converts your metadata datastreams into a format com= patible with the OAI-PMH.
After you have exposed content types and some fields, your repository is= available at /oai2
Some example requests are as follows:
*/oai2?verb=3DIdentify
*/oai2?verb=3DListMetadataFormats
*/oai2?verb=3DListIdentifiers&metadataPrefix=3Doai_dc
<=
/li>
*/oai2?verb=3DListRecords&metadataPrefix=3Doai_dc
Services like WorldCat expect links back to the object such as a Handle = URL. If your metadata doesn't have this there are two approaches that can b= e used. Self transforming XSLTs can be used to add specific elements tailor= ed to individual needs. However, there is options in configuration to appen= d on URL values to the XML output of OAI. Each metadata prefix has an indiv= idual set of configuration. If selected, a user can define where the object= URL will get appended in the output returned.
Similarily, OCLC's Digital Collection Gateway can take advatange of thum= bnail URLs for rendering. This option is only currently available for oai_d= c requests. If selected, a URL to the object's thumbnail will be added as a= dc:identifier.thumbnail if the object has a thumbnail.
If existing content has already been harvested and/or the url and thumbn= ail are not mapping in Digital Collection Gateway, you will need to map tho= se manually in the 'Metadata Map' for a given collection/set.
If the XACML module is present you will need to configure the rels.isViewableBy
fields in the admin page such that the OAI r=
equests respect these object restrictions.
The responses generated by this module have been validated against= Open Archives' Validation.
By default the vanilla islandora_oai module provides a very basic output= . It is possible to add additional content to the description field of the = repository. This includes pointing at other harvesters and repositories, br= anding information etc. An example of how to implement these can be referen= ced in the 6.x version of the module.
The original 6.x version of this module was based off of the OAI2ForCCK = module located here.