FOXML Migration

From MPDLMediaWiki
Jump to: navigation, search

Overview

foxml_migration is an application to transform exiting FedoraFlexible Extensible Digital Object Repository Architecture object xml files.

Repository URLUniform Resource Locator: https://subversion.mpdl.mpg.de/repos/common/trunk/common_services/foxml_migration

Installation/Deployment

Requirements

  • foxml_migration-jar-with-dependencies.jar.
  • folder xsl in project root containing 14 xslt stylsheets and a mapping xml file.
  • migration.properties file.

Deployment

  • copy the required files into a directory of your choice onto the server, where FedoraFlexible Extensible Digital Object Repository Architecture is installed.

before execution

  • stop all solutions accessing the FedoraFlexible Extensible Digital Object Repository Architecture instance.
  • stop escidoc-core.
  • stop FedoraFlexible Extensible Digital Object Repository Architecture.
  • backup the entire $FEDORA_HOME/data/objects directory !!!
  • ensure the $FEDORA_HOME environment variable is set correctly.
  • adjust settings in migration.properties file according to your requirements.

running the application

  • the jar file currently accepts two command line arguments:
  • in order to migrate all existing objects to the newer metadata schemas run java -Xms128m -Xmx512m -XX:MaxPermSize=256m -jar foxml_migration-jar-with-dependencies.jar migration.
  • to change all references to the escidoc:TOCTable of Contents content model (only relevant for ViRRVirtueller Raum Reichsrecht instances):
    • manually edit the escidoc:TOCTable of Contents FOXMLFedora Object XML file and replace all occurences of "TOCTable of Contents" with "toc".
    • run java -Xms128m -Xmx512m -XX:MaxPermSize=256m -jar foxml_migration-jar-with-dependencies.jar cmodel.

after execution

  • check the log file (migration.log or propchange.log) for any errors.
    • in case of errors restore the $FEDORA_HOME/data/objects directory.
  • rebuild the FedoraFlexible Extensible Digital Object Repository Architecture database and the resource index.
  • start FedoraFlexible Extensible Digital Object Repository Architecture.
  • start escidoc-core:
  • use the escidoc-core admin tool to recache and reindex.
  • perform all tasks according to http://colab.mpdl.mpg.de/mediawiki/Checklist_for_Metadata_Changes
  • start solution(s).

Technical Documentation

Overview

foxml_migration transforms the following metadata records:

All transformations are logged (--> migration.log).

Architecture

foxml_migration - an executable jar file - has a very simple architecture:

  • collect all FOXMLFedora Object XML files in $FEDORA_HOME/data/objects
  • check the current schema of the metadata inside the default escidoc metadata record
  • transform all versions of the escidoc metadata record according to the list above
  • update the existing FOXMLFedora Object XML file with all transformed datastreams
  • save the migrated file