|Map Notation Information|
:: indicates a field within a table/JSON object
-> indicates a refrence to another table/JSON object
italics indicate that a corresponding field in ASpace is used rather than the literal data from Archon.
Where possible links are provided to show enum value mappings
There is a separate sheet for each JSON endpoint in Archon except enums which are all in one sheet.
|Notes on Preparing Container Locations for Migration|
In Archon locations are linked directly to collections and accessions. In ArchivesSpace they must be linked via a container in stead. To create this container, the migration tool uses the content field of Archon's link between the collection/accession and the location. The tool will attempt to figure out an appropriate container type and indicator(s) from this field and find an actual physical content record it matches, but failing that will simply create a container with no type and the entire content field as the indicator. If you wish for the location migration to be cleaner, you can format the content field in Archon according to the following guidelines. This is more important for collections than accessions since the locations can be linked to physical content from collections if done right.
- If you want to link the location to all the linked collection's locations simply write 'all' in the content field (not case sensitive).
- The content field should START with the container type which should match one of your physical content types. Spelling and punctuation should match the physical content type precisely, case does not matter. For instance, it could start with 'folder' or 'box' or 'map case' (only if 'map case' had been added to the physical content types in Archon, it's not a default value). Note that 'boxes' or 'folders' are also fine, but these are the only plural forms that will work.
- The indicator(s) should follow and be separated from the container type by at least one space. Indicators should entirely match how the indicator appears in the corresponding physical content record.
- If you want to link containers with more than one indicator, separate the indicators with commas.
- If you want to indicate sequential numerical indicators, separate the lowest indicator and the highest indicator with a dash (must be exactly this character '-').
'Box 1-5,7 ,8 -10' would be linked to 'box 1', 'box 2', 'box 3', 'box 4', 'box 5', 'box 7', 'box 8', 'box 9', and 'box 10'
'folders 1-3' would be linked to 'folder 1', 'folder 2', and 'folder 3'
'volume a,b,c' would be linked to 'volume a', 'volume b', and 'volume c'
-Migration API uses archon's built in publishing system
-Application must authenticate to listed url by passing credentials via HTTP header. Account must be user with full admin rights
-If credentials are OK, Archon will provide a session token in json format
-Session token will then need to be submitted in http header as GET to each endpoint and batch_start
-Autentication testing can be done in firefox with RESTClient Extension or in Chrome with Postman
-endpoints return either a json object or following error messages
-API returns records in batches of 100 (or less if there are less than 100 items left for that endpoint)
-When endpoint returns empty set for a particular batch start, all data has been provided
-for each data type being migrated or referenced, a single tab provides url of archon endpoints, notes, mapping table with datatype values for archon data, and processing instructions and, where appropriate, list -of default values for related static and editable lookup lists/enumerations
-Order that objects are migrated is shown on migration order/work tracking tab
-processing instructions for each data type are numbered in logic order, on the particular tab for each datatype
-related objects for each data type are referenced via either a single ID or array of ID for the related value provided on the JSON object for the related data type.
-In case of more complex relationships, eg. related location records and creator relationship types, a multidimenional array shows relationships or reated values