OAI-PMH provider for Voyager

Tags: intermediate , voyager , oai-pmh
Last Updated: Dec 10, 2010 10:40

• Description

  A fully-featured OAI-PMH Provider (server) implementation for Voyager with customizable set definitions.

  Features:

• Support for all verbs (functions) of OAI-PMH 2.0
• Configurable sets
• Can utilize keyword indexes
• Can return records in Dublin Core as well as MARCXML
• Access control for IP addresses
• Support for handling of deletions
• Can return bib and authority records

  ---

• Author: Ere Maijala
• Additional author(s):
• Institution: None
• Year: 2008

  ---

• License: MPL 1.1 / GPL 2.0
• Short description: Use, modification and distribution of the code are permitted provided the copyright notice, list of conditions and disclaimer appear in all related material.
• Link to terms: MPL 1.1, GPL 2.0

  ---

• Skill required for using this code: intermediate

  ---

State

Stable

Programming language

Perl

Software requirements

Tested on Voyager 7. Probably works with other versions too.

Screen captures

-

Author(s) homepage

-

Download

Version 2.11
Sample config file

Working example

-

Using the following Ex Libris open interfaces

-

Changes

Version 2.11 - 10 December 2010

• Fixed a bug causing return_all_for_empty_set configuration directive to not work properly

Version 2.1 - 18 November 2010

• Settings moved to a separate config file
• New set rules
  • Suppressed records
  • Create locations
  • Happening locations
• Possibility to strip fields from the records
• Possibility to include holdings and (optionally) availability information (for Primo)

Version 1.5

• First release on EL Commons

Release notes

While the setup is fairly straight-forward, the set definitions can be slightly daunting. Please don't hesitate to contact the author (ere.maijala at helsinki.fi) for more information.

Please note that enabling holdings and availability information slows down date interval harvesting considerably. This is due to the fact that the provider needs to find the appropriate timestamp for each record, and it seems that not all the relevant fields are indexed/non-null so there is quite a bit of extra work for Oracle in this case.

Installation instructions

1. Copy oai-pmh.cgi to directory /m1/voyager/xxxdb/webvoyage/cgi-bin (or wherever your cgi-bin resides)
2. Set it executable (chmod +x oai-pmh.cgi). As a result, the directory listing using command ls -l should show something like the following:
3. Copy oai-pmh.config to the same directory
4. Open oai-pmh.config with a text editor and change the settings in the beginning of the file. The most important settings to get going are the database settings. If the WebVoyáge server is the database server, it's usually enough to set the user id and password. If not, also the address of the database server is needed. Make sure that Oracle really is installed in the path provided in ORACLE_HOME setting and modify if necessary. Keyword server address and port need to be set only if keyword rules are used in set specifications.
5. Test that the script works correctly by entering URL http://server/cgi-bin/oai-pmh.cgi?verb=Identify using a web browser.

   You can have multiple oai-pmh scripts in cgi-bin with their own settings. Just change the reference to oai-pmh.config in the script file to something else.

TO DO list

-

Known issues

None.

Comments