lyrasis/islandora_aspace

Islandora integration with Archivespace.

Islandora ArchivesSpace

Introduction

This module allows metadata on Islandora to be managed in ArchivesSpace by linking Islandora objects to ArchivesSpace objects. This is accomplished by adding a new ArchivesSpace content model to objects that are being linked to ArchivesSpace objects.

Requirements

This module requires the following modules/libraries:

• Islandora
• Islandora XML Forms
• Drupal Services Module
• ArchivesSpace Islandora Plugin
• Twig
• Composer

Installation

• Make sure composer is installed and available on the system.
  • Composer is used to install the Twig dependancy.
• Install Drupal dependancies:
  • Islandora
  • Islandora XML Forms
  • Drupal Services Module
• Install module into Drupal.
• Run composer install --no-dev in module directory.
• Install Archivesspace plugin on your ASpace server.

Configuration

• This module has a counterpart plugin for ArchivesSpace that also needs to be configured. Details on configuring that module are available in the plugins readme file.
• All settings for this module are available at the settings page. It can be found in the menu at: Islandora > Utility Modules > ArchivesSpace Integration
• On the Settings Tab:
  • On the General Settings vertical tab:
    • Enter the ArchivesSpace username and password that Isladora will connect to the API using.
    • Enter the URL for the ArchivesSpace REST API.
    • Copy the API key and use this in ArchivesSpace to configure the integration.
  • On the Metadata Settings vertical tab:
    • Choose the DC Crosswalk used by the integration to convert the generated MODS datastream to Dublin Core for the DC datastream.
    • Choose the TWIG Template that will be used to convert the data coming from ArchivesSpace to MODS.
  • On the Content Models vertical tab
    • Choose the content models that the integration will be applied to.
• On the Templates Tab:
  • Here you can copy, edit or delete templates defined for your instance. These templates are used to convert the data coming from ArchivesSpace (found in JSON format in the ARCHIVESSPACE datastream) to the MODS datastream used in Islandora.
  • These templates are written using the TWIG templating system.
  • A very basic template used as the default for the module is available here.
  • Pull requests to add more detailed default templates are very welcome.

Notes

• For security the REST URLs used to communicate between ArchivesSpace and Islandora should be HTTPS.
  • If the REST URLS are not HTTPS then the API key and ArchivesSpace Username and Password will be sent in plain text over the internet.
• This module has been tested with Islandora:
  • 7.x-1.8
  • 7.x-1.10
• Hook documentation available in the islandora_aspace.api.php file.

Troubleshooting/Issues

Having problems or solved a problem? Check out the Islandora google groups for a solution.

• Islandora Group
• Islandora Dev Group

Maintainers/Sponsors

Current maintainers:

• Lyrasis

Development

If you would like to contribute to this module, please check out CONTRIBUTING.md. In addition, we have helpful Documentation for Developers info, as well as our Developers section on the Islandora.ca site.

License

GPLv3