Archivist's Toolkit to ArchivesSpace migration code
Java Shell
Clone or download
lmcglohon Merge pull request #14 from archivesspace/updates
fixed issue with agent dates and removed JFormDesigner evaluation mes…
Latest commit dde1a9c May 23, 2018
Permalink
Failed to load latest commit information.
docs
lib
logs
src
.gitignore fixed an issue with containers and some repo contact info Nov 30, 2017
README.md
dbcopy.properties subjects can have multiple term types Oct 24, 2017
dbcopy.sh
makep
plugin.xml

README.md

The Archivists’ Toolkit to ArchivesSpace migration tool enables migration of data from an Archivists’ Toolkit instance to an ArchivesSpace instance. It is the most comprehensive and efficient option for people who have not previously migrated and want to migrate all of their AT data to ArchivesSpace.

The migration tool is intended to run as a plugin within Archivists’ Toolkit. Instructions and a data mapping are available at on the ArchivesSpace migration tools and data mapping page at http://archivesspace.org/using-archivesspace/migration-tools-and-data-mapping/.

We recommend migrating to the latest version of ArchivesSpace when possible. Archivists’ Toolkit users who are ready to move to the latest version of ArchivesSpace should use version 2.2.2 of the tool. Archivists’ Toolkit users who wish to move into a pre-1.5.0 version of ArchivesSpace due to the container management changes should use version 1.4.2 of the tool.

NOTES ON DATA MIGRATION AND DEFAULTS

  1. If a date is missing in AT but is required for AS the default date will be set to 1/1/1900 or 0 for integer dates.
  2. The start date specified for a container location is the creation date of the associated resource/accession.
  3. Many containers, including containers associated with accessions, do not have meaningful identifiers in AT. These containers will be assigned a default container indicator which will include the words "unknown container" as well as information about its content.
  4. Sometimes AT records will have an indicator but no container type for either container 2 or 3. This is not allowed in AS so the default for AS will be "unknown_item" so that the indicator is not lost. The same rule applies if a container 3 is specified without a container 2.
  5. Some IDs are checked for uniqueness in AS but not AT. In these cases if an ID is not unique the problem will be corrected by adding ## along with some random string to the ID.
  6. If an assessment is linked to records from multiple repositories, duplicate assessments are created - one for each linked repository.

HOW TOP CONTAINER UNIQUENESS IS DETERMINED

Archivist's Toolkit does not include the concept of distinct top containers but rather the same container may be entered many times for multiple instances. For this reason it was necessary to establish a set of rules to determine what constitutes a unique top container. Top containers created from instances are considered to be the same if either the repository and barcode match or if the repository, resource, indicator, and container type match. For accessions, no instances exist in Archivists’ Toolkit. Instead, a top container is created based on each location to which the accession is linked.

CONTINUING A PREVIOUS MIGRATION

If a problem occurs during migration, or if you manually cancel a migration, URI maps should be saved and allow you to continue from where you left off by checking the 'continue previous migration' box.

  • If you are running the migration tool as an Archivist's Toolkit plugin and a connection problem occurs that causes the migration to stop or you manually cancel the migration, restart AT before attempting to continue the migration.
  • Check the record the migration stopped at as the migrator may correct for a duplicate ID where there is not actually one.
  • It is not necessary to run the repository check again when continuing a migration.
  • You should save your error log and repository check report even if you plan to continue a migration, as these logs reset when you continue a migration.

NOTE ON CPU AND MEMORY USAGE

Data migration is a memory intensive task due to the large number of objects being created. As such, it’s recommended to run the plugin on a machine with at least 2 GB memory, and setting the max heap space to 1024 mb.

NOTES ON RUNNING IN STANDALONE MODE

Though intended to run as a plugin within the AT application, the migration tool can run in standalone mode for testing purposes. To run in standalone mode:

  1. Create a directory call "logs" in the project directory if it is not already there.
  2. Run the "dbCopyFrame" class making sure all the *.jar files in "lib" are in the Classpath.

NOTES ON RUNNING IN COMMAND LINE MODE

  1. Edit the dbcopy.properties to point to the desired AT database and ASpace Instance.
  2. Run the "dbCopyCLI" class making sure all the *.jar files in "lib" are in the Classpath.

NOTES FOR DEVELOPERS

This repo contains the source code for the ScriptAT plugin which contains the AT to ArchivesSpace data migration utility. If you need to revise the plugin, the majority of development work will probably take place in a few classes, primarily in the package at-migration\src\org\archiviststoolkit\plugin\utils\aspace. A description of some of the classes is given below.

  1. dbCopyFrame is the user interface for the migration tool. It mostly calls methods in ASpaceCopyUtil.
  2. dbCopyCLI mainly does the same thing as dbCopyFrame but is for command line mode.
  3. ASpaceCopyUtil has a method for copying each record type. Each of these is called by dbCopyFrame/dbCopyCLI. It gets records from AT, calls on ASpaceMapper to map them to the ASpace model, then calls on ASpaceClient to save them to ASpace.
  4. ASpaceMapper takes AT model records and converts them to the appropriate ASpace JSON model.
  5. TopContainerMapper serves the same function as ASpaceMapper but is specialized for top containers, which present some special challenges.
  6. ASpaceClient saves records to ASpace and gets records from ASpace.

NOTES ON COMPILING THE PLUGIN FROM SOURCE CODE

This assumes you already have basic knowledge of how to compile and run Java programs using your IDE of choice. The current source needs to be compiled with JDK 1.6, or later. To build:

  1. Clone this repo.
  2. Import the source code into your IDE.
  3. In your IDE, place all the *.jar files found in the "lib" folder in the Classpath.
  4. You should now be able to successfully compile the plugin from source code. You must use JDK 1.6 to compile the code. 1.7 or later will not work as an AT plugin.
  5. You can edit the makep script to fit your development environment to generate the scriptAT.zip plugin file after code compilation.

Note: If you intend to modify user interface code, then you will need to use JFormdesigner to open the *.jfd files. Consult the JFormDesigner documentation on how to install and use it.

NOTES ON WRITING TESTS FOR THE PLUGIN

When writing tests you should always place them in the test directory. To write a test:

  1. Create a class that extends Testing to write your tests in.
  2. Import junit.framework.JUnit4TestAdapter, org.junit.Assert, and org.junit.Test.
  3. Write tests with annotation @Test in this class.
  4. Add the following method: public static junit.framework.Test suite() {return new JUnit4TestAdapter(Name of your class here.class);}
  5. You can now run your test by calling a constructor for your class from the testing main method then running the Testing main method.