Feature #10797

Add EAD support in OAI responses and generate XML metadata asynchronously

Added by Mike Cantelon over 3 years ago. Updated almost 3 years ago.

Status:VerifiedStart date:01/23/2017
Priority:MediumDue date:
Assignee:Dan Gillean% Done:

0%

Category:OAI-PMH
Target version:Release 2.4.0
Google Code Legacy ID: Tested version:
Sponsored:Yes Requires documentation:

Description

This feature will add a number of changes to AtoM to better support metadata export.

First, DC and EAD XML documents will be generated (and updated) asynchronously by the job scheduler as archival descriptions are saved. This will allow large hierarchies to be accessed via the browser as XML without the timeout issues encountered when generating the XML on demand.

This functionality will also allow us to provide EAD XML as an option within the OAI repository module. Work to enhance the OAI repository module will include:

  • Update AtoM's OAI response to "List metadata formats" query to include EAD-XML as an available format
  • Update GetRecord OAI responses to be able to return EAD XML instead of DC XML in response body
  • Update ListIdentifiers response to show only top-level descriptions when metadataPrefix is EAD
  • Update ListRecords OAI responses to be able to return EAD XML instead of DC XML in response body
    • Limit list to a single EAD record, to avoid timeouts
  • Improve data load for ListRecords, GetRecord and ListIdentifiers verb
  • Limit collections fetched for set specs to the requested resources.
  • Add resumptionToken to the ListSets verb

Finally, to allow users to generate and store EAD and DC XML for existing descriptions, this work will include the addition of a command-line task to regenerate the XML files for all descriptions in the site.


Related issues

Related to Access to Memory (AtoM) - Feature #11002: XML cache task: add option to skip information objects Verified 03/23/2017

History

#3 Updated by Dan Gillean over 3 years ago

  • Subject changed from OAI-PMH pre-caching and EAD support to Add EAD support in OAI responses and generate XML metadata asynchronously
  • Description updated (diff)
  • Target version set to Release 2.4.0

#4 Updated by Mike Cantelon over 3 years ago

  • Status changed from New to QA/Review
  • Assignee changed from Mike Cantelon to Dan Gillean

#5 Updated by Dan Gillean over 3 years ago

  • Related to Feature #11002: XML cache task: add option to skip information objects added

#6 Updated by Dan Gillean over 3 years ago

  • Description updated (diff)

Some notes:

Current OAI Repository documentation (includes list of supported verbs, etc):

To run the CLI task to generate EAD and DC XML for all existing descriptions:

php symfony cache:xml-representations

The resulting XML files will be placed in 2 directories in the Downloads folder - one for EAD and one for DC. the filenames use a hash, so they cannot be associated at a glance with their corresponding descriptions.

Users can then test the functionality by doing the following:

1) Make sure the new Generate XML setting (at the bottom of the Global settings page) is on, and that the CLI cache task has been run
2) Make sure that the OAI plugin is enabled, and that you've configured the options in Settings
3) Use the ListSets OAI verb to return a list of top-level descriptions. Example:

http://example-site.com/;oai?verb=ListSets

4) Select one of the OAI identifiers returned for the fonds/collection you wish to harvest
5) Use the selected OAI identifier in a GetRecord request, with the metadata format listed as "oai_ead". Example

http://example-site.com/;oai?verb=GetRecord&identifier=oai:10.10.10.10:oaitest_29110&metadataPrefix=oai_ead

#7 Updated by Dan Gillean almost 3 years ago

  • Status changed from QA/Review to Verified

Note: as a result of this work, whenever the XML is pre-generated, it will exclude draft records. Authenticated users can still export EAD with draft records using the clipboard, but the download option on the view page of a description will only serve up published records when the Cache XML setting is turned on. This means that only published records will be returned in the EAD XML OAI response as well.

Also available in: Atom PDF