Oai.pl

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

Back to cfg.d

oai.pl contains configuration for OAI. This defines an $oai hash reference, which is assigned to $c->{oai}. This has the following configuration settings assigned to it.

• $oai->{v2}->{archive_id} - The archive ID to register the archive with OAI. This is commented out by default and if used should be set to something unique list the archive's hostname.
• $oai->{v2}->{base_url} - The base URL for accessing OAI pages. By default this is the path /cgi/oai2 under the archive's HTTP or HTTPS base URL.
• $oai->{sets} - The types of sets to be made available for OAI-PMH. By default these are:
  1. status - Sets for the different values of the eprint's ispublished field.
  2. subjects - Sets for the different values of the eprint's subjects field.
  3. types - Sets for the different values of the eprint's type field.
• $oai->{custom sets} - Specifications for custom sets to be made available for OAI-PMH. By default there is only one custom set Open Access DRIVERset, which contains all eprints where the full_text_status is set to public.
• $oai->{filters} - Filters to exclude certain items from OAI set. E.g. not before a certain date.
• $oai->{mime_types} - Maps document type to an appropriate MIME type.
• $oai->{content} - Specify either some text or a URL link describing the content of the archive.
• $oai->{metadata_policy} - Specify either some text or a URL link describing the metadata policy for the archive.
• $oai->{data_policy} - Specify either some text or a URL link describing the data policy for the archive.
• $oai->{submission_policy} - Specify either some text or a URL link describing the submission policy for the archive.
• $oai->{comments} - Specify some comments to describe anything not covered in the content or policies text / URLs.