Page History

...

Details about OAI 2.0 internals can be found here.

Using Solr

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:

...

Code Block
0 3 * * * [dspace]/bin/dspace oai import

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:

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.

...