Page History
...
Details about OAI 2.0 internals can be found here.
...
Info |
---|
As of DSpace 6, the OAI 2.0 Server only uses Solr for its indexing. The previous capability to use Database indexing has been removed. |
Indexing OAI content
OAI 2.0 uses the Solr data source by defaultSolr for all indexing of content.
The Solr index can be updated at your convenience, depending on how fresh you need the information to be. Typically, the administrator sets up a nightly cron job to update the Solr index from the SQL database.
OAI Manager
...
OAI manager is a utility that allows one to do certain administrative operations with OAI. You can call it from the command line using the dspace launcher:
...
Note that [dspace]
should be replaced by the correct value, that is, the value defined in dspace.cfg
parameter dspace.dir
.
Using Database
OAI 2.0 could also work using the database for querying. To configure that one must change the [dspace]/config/modules/xoai.cfg
file, specifically the "storage"
parameter, setting it to "database"
. This decreases performance significantly and likely has no other benefits than leaving out Solr as a dependency.
OAI Manager (Database Data Source)
OAI manager is a utility that allows one to do some administrative operations with OAI. You can call it from the command line using the dspace launcher:
Syntax
[dspace]/bin/dspace oai <action> [parameters]
Actions
- clean-cache Cleans the OAI cache
- compile-items Compiles DSpace items
- erase-compiled-items Erases all DSpace compiled items
Parameters
- -v Verbose output
- -h Shows an help text
Scheduled Tasks
In order to refresh the OAI cache and compile DSpace items (for fast responses), it is required to run the [dspace]/bin/dspace xoai compile-items
command periodically. You can add the following task to your crontab:
Code Block |
---|
0 3 * * * [dspace]/bin/dspace oai compile-items
|
Note that [dspace]
should be replaced by the correct value, that is, the value defined in dspace.cfg
parameter dspace.dir
.
Client-side stylesheet
Client-side stylesheet
The OAI-PMH The OAI-PMH response is an XML file. While OAI-PMH is primarily used by harvesting tools and usually not directly by humans, sometimes it can be useful to look at the OAI-PMH requests directly - usually when setting it up for the first time or to verify any changes you make. For these cases, XOAI provides an XSLT stylesheet to transform the response XML to a nice looking, human-readable and interactive HTML. The stylesheet is linked from the XML response and the transformation takes place in the user's browser (this requires a recent browser, older browsers will only display the XML directly). Most automated tools are interested only in the XML file itself and will not perform the transformation. If you want, you can change which stylesheet will be used by placing it into the [dspace]/webapps/oai/static
directory (or into the [dspace-src]/dspace-xoai/dspace-xoai-webapp/src/main/webapp/static
after which you have to rebuild DSpace), modifying the "stylesheet" attribute of the "Configuration" element in [dspace]/config/crosswalks/oai/xoai.xml
and restarting your servlet container.
...
DRIVER Guidelines for Repository Managers and Administrators on how to expose digital scientific resources using OAI-PMH and Dublin Core Metadata, creating interoperability by homogenizing the repository output. The set driver of OAI-PMH PMH driver
set is based on DRIVER Guidelines 2.0 (see the English version of the document).
This set is used to expose items of the repository that are available for open access. It’s not necessary for all the items of the repository to be available for open access.
...
- Must have a publication date - dc.date.issued (already configured in DSpace items)
- dc.language must use ISO639-3
- the value ofof dc.type must be one of the 16 options of types named in the guidelines (see page 68)
How do you easily add those metadata values?
...
The name of the set in OAI-PMH is "ec_fundedresources" and will expose the items of the repository that comply with these guidelines. These guidelines are based on top of DRIVER guidelines. See version 2.0 of the Guidelines.
See the Application Profile of OpenAIRE.
...
Info | ||
---|---|---|
| ||
|
Sanity check your OAI interface with the OAI Validator
There is a very useful validator for OAI interfaces available at http://
...
...
oaipmh.com, we urge you to use this validator to confirm your OAI interface is in fact usable.
Frequently asked questions and issues
TODO fill out based on notes from the March DCAT call: DCAT Meeting March 2016