Difference between revisions of "Improvements/Islandora"

From Archivematica
Jump to navigation Jump to search
Line 1: Line 1:
Sections of this page have been copied and adapted from the Islandora Foundation's Archidora documentation under a [http://creativecommons.org/licenses/by-sa/3.0/ Creative Commons Attribution-Share Alike 3.0 Unported License]. These sections are appended by a hyperlink to the original content in the Islandora wiki. We are grateful to Islandora for both writing and sharing this documentation.
 
 
== Synopsis ==
 
 
Archidora is a module that integrates the digital preservation functionality of Archivematica with [http://islandora.ca/ Islandora]. It was developed by [http://www.artefactual.com/ Artefactual Systems] and [http://www.discoverygarden.ca/ Discovery Garden], sponsored by the [http://library.usask.ca/ University of Saskatchewan Library].
 
 
== User story ==
 
 
The goal of the Archidora module is to allow Islandora users to seamlessly preserve content that is ingested into Islandora using Archivematica's suite of digital preservation micro-services, creating preservation copies of that content for long-term storage. The Islandora user ingesting the content should not be required to mediate the transfer to Archivematica in any way. Upon completion of the transfer and ingest into Archivematica, a notification is sent back to Islandora indicating that the storage was successful.
 
 
[[File:Archidora-1.png|center|500px]]
 
 
== Status ==
 
 
The Archidora module was developed in 2014 and has been deployed at the University of Saskatchewan Library since 2015. Testing is ongoing.
 
 
The code is currently held [https://github.com/Islandora-Labs/archidora on Github by the Islandora Foundation], but is not being actively maintained.
 
 
== Scope ==
 
 
 
=== Download ===
 
 
* Islandora module: https://github.com/discoverygarden/archidora
 
* Archivematica: Archivematica 1.4 and Storage Service 0.7 or later is required; download from http://www.archivematica.org.
 
* This integration is currently considered a beta feature.
 
 
- ''[https://wiki.duraspace.org/display/ISLANDORA/Archidora Islandora Archidora documentation]''
 
 
=== Install ===
 
 
* Installation and testing is similar to any Drupal module. Please see [https://wiki.duraspace.org/display/ISLANDORA715/Installing+the+Islandora+Enhancement+Modules Installing the Islandora Enhancement Modules] for details.
 
 
- ''[https://wiki.duraspace.org/display/ISLANDORA/Archidora Islandora Archidora documentation]''
 
 
 
=== Configure ===
 
=== Configure ===
  
==== 1. In the Archivematica Storage Space: ====
+
==== In the Archivematica Storage Space: ====
  
 
* Create a Space with access protocol FEDORA via SWORD2.
 
* Create a Space with access protocol FEDORA via SWORD2.
Line 43: Line 8:
 
* See [https://www.archivematica.org/en/docs/storage-service-0.7/administrators/#fedora Archivematica Storage Service documentation] for more details.
 
* See [https://www.archivematica.org/en/docs/storage-service-0.7/administrators/#fedora Archivematica Storage Service documentation] for more details.
  
==== 2. In Islandora ====
+
==== In Islandora ====
 +
 
 +
* Configure Archidora at admin/islandora/archidora.
 +
** Archivematica Storage Service Base URL - normally http://archivematica-url:8000
 +
** Deposit Location - will be configured automatically once storage service URL is entered
 +
** Archivematica User - Archivematica dashboard user to be used for Islandora integration (not storage service)
 +
** Archivematica API Key - API key for the Archivematica dashboard user listed above
 +
 
 +
* Archivematica may also be configured to call back to Islandora to delete the high-res "OBJ" datastreams - this is done in the Storage Service > Administration > Service callbacks
 +
** URI: http://islandora-base-url/islandora/object/<source_id>/archidora/{Islandora API}/delete
 +
*** Where the API key is the "Islandora Archivematica integration API key" listed/generated on the Archidora admin screen
 +
** Event: post-store
 +
** Method: post
 +
** Expected status: 200
  
* configure Archidora, at admin/islandora/archidora
 
Archivematica Storage Service Base URL - normally http://archivematica-url:8000
 
Deposit Location - will be configured automatically once storage service URL is entered
 
Archivematica User - Archivematica dashboard user to be used for Islandora integration (not storage service)
 
Archivematica API Key - API key for the Archivematica dashboard user listed above
 
Archivematica may also be configured to call back to Islandora to delete the high-res "OBJ" datastreams. This is done in the Storage Service - Administration | Service callbacks
 
URI: http://islandora-base-url/islandora/object/<source_id>/archidora/{Islandora API}/delete
 
where the API key is the "Islandora Archivematica integration API key" listed/generated on the Archidora admin screen
 
Event: post-store
 
Method: post
 
Expected status: 200
 
 
Note: the OBJ datastreams are not deleted automatically, but rather are listed at the collection level (or compound object level) on the Manage | Archivematica tab. They can be deleted individually or in bulk.
 
Note: the OBJ datastreams are not deleted automatically, but rather are listed at the collection level (or compound object level) on the Manage | Archivematica tab. They can be deleted individually or in bulk.
 +
 
Cron must be enabled.
 
Cron must be enabled.
  
 +
* Collection-level configuration:
 +
** Check off "Don't Archive Children" to stop objects from being sent to Archivematica for a particular collection.
  
- [https://wiki.duraspace.org/display/ISLANDORA/Archidora Islandora Archidora documentation]
 
  
== Interest ==
+
 
 +
- ''[https://wiki.duraspace.org/display/ISLANDORA/Archidora Islandora Archidora documentation]''

Revision as of 18:45, 17 March 2016

Configure

In the Archivematica Storage Space:

  • Create a Space with access protocol FEDORA via SWORD2.
  • Create a Location within that Space (purpose = FEDORA deposits)
  • Enter the Fedora URL, username and password.
  • See Archivematica Storage Service documentation for more details.

In Islandora

  • Configure Archidora at admin/islandora/archidora.
    • Archivematica Storage Service Base URL - normally http://archivematica-url:8000
    • Deposit Location - will be configured automatically once storage service URL is entered
    • Archivematica User - Archivematica dashboard user to be used for Islandora integration (not storage service)
    • Archivematica API Key - API key for the Archivematica dashboard user listed above
  • Archivematica may also be configured to call back to Islandora to delete the high-res "OBJ" datastreams - this is done in the Storage Service > Administration > Service callbacks
    • URI: http://islandora-base-url/islandora/object/<source_id>/archidora/{Islandora API}/delete
      • Where the API key is the "Islandora Archivematica integration API key" listed/generated on the Archidora admin screen
    • Event: post-store
    • Method: post
    • Expected status: 200

Note: the OBJ datastreams are not deleted automatically, but rather are listed at the collection level (or compound object level) on the Manage | Archivematica tab. They can be deleted individually or in bulk.

Cron must be enabled.

  • Collection-level configuration:
    • Check off "Don't Archive Children" to stop objects from being sent to Archivematica for a particular collection.


- Islandora Archidora documentation