[Archivesspace_Users_Group] OAI configuration questions

Christine Di Bella christine.dibella at lyrasis.org
Fri Oct 19 16:23:39 EDT 2018

Hi Rick,

(The config file being referenced in the instructions you got is one and the same - no change in location. It's possible that some lines look a bit different depending on any local changes you've made. If you need help comparing yours and an out-of-the-box one, let us know and we can put in a tech support ticket for you.)

Our documentation could always be better, but there are some OAI-PMH settings controlled in the config file. Aside from designating a port different than the default, for v.2.5.0, the bulk of them start at line 107 or thereabouts. The most current instructions we have are at https://github.com/archivesspace/archivesspace/#configuring-oai-pmh.

In addition, a few more repository-specific options were added to the repository record area as of v2.5.0 (see a screenshot of a portion of that bit of the screen for doing that below):

[cid:image001.png at 01D467C7.335CA750]


Christine Di Bella
ArchivesSpace Program Manager
christine.dibella at lyrasis.org<mailto:christine.dibella at lyrasis.org>
800.999.8558 x2905
cdibella13 (Skype)


From: archivesspace_users_group-bounces at lyralists.lyrasis.org <archivesspace_users_group-bounces at lyralists.lyrasis.org> On Behalf Of Neal, Rick
Sent: Friday, October 19, 2018 10:02 AM
To: Archivesspace Users Group <archivesspace_users_group at lyralists.lyrasis.org>
Subject: [Archivesspace_Users_Group] OAI configuration questions

Good morning,

I have upgraded our version of ArchiveSpace to 2.5.0.  Recently I got a request to "get an OAI port configured so that Virginia Heritage can run a scraper and get our content off of ArchivesSpace".  They included some good instructions (see below) to help me.

My problem is that my config.rb file doesn't have any references to OAI in it at all.  The location I am looking at is ../ archivesspace/config/ .  There is a config.rb file in there but it doesn't match.

Is OAI configured in some other file for version 2.5.0?  Also, is there documentation for setting up OAI with version 2.5.0?


Rick Neal
Library Systems and Applications Administrator
University of Richmond

The instructions I received are below...

Here are the default settings in config-defaults. These should be added and modified in local config.rb file:

# OAI configuration options
AppConfig[:oai_repository_name] = 'ArchivesSpace OAI Provider'
AppConfig[:oai_proxy_url] = 'http://your-public-oai-url.example.com'
AppConfig[:oai_record_prefix] = 'oai:archivesspace'
AppConfig[:oai_admin_email] = 'mailto:admin at example.com'
# In addition to the sets based on level of description, you can define OAI Sets
# based on repository codes and/or sponsors as follows
# AppConfig[:oai_sets] = {
#   'repository_set' => {
#     :repo_codes => ['hello626'],
#     :description => "A set of one or more repositories",
#   },
#   'sponsor_set' => {
#     :sponsors => ['The_Sponsor'],
#     :description => "A set of one or more sponsors",
#   },
# }
AppConfig[:oai_ead_options] = {}
# alternate example:  AppConfig[:oai_ead_options] = { :include_daos => true, :use_numbered_c_tags => true }

The two *necessary* options to set are:

oai_proxy_url should be set to the public URL. If not proxied and you keep the default http://localhost:8082/ for oai_url, you would replace localhost with the actual external hostname. ( same procedure for public webapp config. )

oai_record_prefix is used to generate what should be globally unique identifiers, so "oai:" prefix should be followed by a domain name. example:  'oai:http://lib.school.edu'

But you should also set a provider name ( that field was misnamed oai_repository_name  ) and an email address to report problems.

Sets are optional. I set up separate sets for law and health in our server, but I don't need to use these for VH crawl, as I'm going to be using the @mainagency code for distinguishing publishing org. So they should also have set Agency Code in ArchivesSpace "Manage Repositories" fields.

oai_ead_options support was added in v2.5.0. If you want digital objects exported, set that to be true.
For consistency, you should probably use the same options that you typically use when exporting from staff interface.
You probably don't want :include_unpublished,  as OAI is a public endpoint.

Once it's configured, you should be able to go to the  oai_proxy_url /sample and test the links on that page.

I would also suggest checking out the OAI implementation guidelines and the site validator in links below.
 The validator may not pass the FULL suite of tests, but should pass the basic ones.
( If it passes the basic test, the other problems are issues with the OAI implementation in ArchivesSpace. )

+ [Open Archives Initiative](http://www.openarchives.org/pmh/)
+ [Protocol documentation](http://www.openarchives.org/OAI/openarchivesprotocol.html)
+ [implementation guidelines](http://www.openarchives.org/OAI/2.0/guidelines.htm)
+ [site validator](http://www.openarchives.org/Register/ValidateSite)

Rick Neal
Library Applications and Systems Administrator
Boatwright Memorial Library
University of Richmond, VA 23173

rneal at richmond.edu<mailto:rneal at richmond.edu>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20181019/5b933e26/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 40015 bytes
Desc: image001.png
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20181019/5b933e26/attachment.png>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image004.jpg
Type: image/jpeg
Size: 6608 bytes
Desc: image004.jpg
URL: <http://lyralists.lyrasis.org/pipermail/archivesspace_users_group/attachments/20181019/5b933e26/attachment.jpg>

More information about the Archivesspace_Users_Group mailing list