Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Wiki Markup
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. 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/xoai/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/modules/xoai/xoai.xml}} and restarting your servlet container.

Metadata Formats

By default OAI 2.0 provides 12 metadata formats within the /request context:

  1. OAI_DC
  2. DIDL
  3. DIM
  4. ETDMS
  5. METS
  6. MODS
  7. OAI-ORE
  8. QDC
  9. RDF
  10. MARC
  11. UKETD_DC
  12. XOAIAt /driver context it provdes:
  1. OAI_DC
  2. DIDL
  3. METSAnd at /openaire context it provides:
  4. OAI_DC
  5. METS

Configuration

Basic Configuration

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1cdbdd18d26efc24-f8489237-4daf4118-958c86d9-67cdbcbd5075287b0762962b"><ac:plain-text-body><![CDATA[

Configuration File:

[dspace]/config/modules/oai.cfg

]]></ac:plain-text-body></ac:structured-macro>

Property:

storage

Example Value:

storage = solr

Information Note:

This allows to choose the OAI data source between solr and database

Property:

solr.url

Example Value:

solr.url = ${default.solr.server}/oai

Informational Note:

Solr Server location

Property:

identifier.prefix

Example Value:

identifier.prefix = ${dspace.hostname}

Informational Note:

OAI persistent identifier prefix. Format - oai:PREFIX:HANDLE

Property:

config.dir

Example Value:

config.dir = ${dspace.dir}/config/modules/oai

Informational Note:

Configuration directory, used by XOAI (core library). Contains xoai.xml, metadata format XSLTs and transformer XSLTs.

Property:

cache.dir

Example Value:

cache.dir = ${dspace.dir}/var/oai

Informational Note:

Directory to store runtime generated files (for caching purposes).

...