WebProtégé 2.x Migration

This page describes how to migrate an existing WebProtégé 2.x installation (e.g. 2.6.0) to a WebProtégé 3.x installation. A WebProtégé 3.x .war file cannot simply be "dropped in" as a replacement for previous versions of WebProtégé because the backend storage mechanisms are not compatible. To preserve existing data (projects, project settings, discussion threads etc.) you need to run the WebProtégé migration tool.

Before you perform the migration

Before proceeding with the migration we recommend that you back up your existing WebProtégé installation. You can do this by following the WebProtégé back up instructions.

Migration steps

1. Stop tomcat (the servlet container that you use to run WebProtégé).

2. Download the WebProtégé migration tool, migrate-webprotege.jar.

3. Open a terminal and change the working directory to the directory containing the migrate-webprotege.jar file that you just downloaded.

4. Run the migration tool. To do this, type the command below, replacing <Options> with the options documented below. Depending on the size of projects in your WebProtégé installation you may need to alter the maximum memory (using the -Xmx flag) that should be made available to Java.

   java -Xmx2000M -jar migrate-webprotege.jar <OPTIONS>

   The migration tool supports the following options, however only the -d (WebProtégé database name) and the -w (data directory path) options are required.

    -d,--database <arg>         WebProtégé database name in MongoDB
    -w,--data-directory <arg>   The WebProtégé data directory path
    -h,--mongo-host <arg>       MongoDB host name e.g. localhost or
                                my.server.com
    -p,--mongo-port <arg>       MongoDB port

   For example, if your current WebProtégé installation uses the default database name (webprotege) and the default data directory (/data/webprotege) the migration would be run by typing:

   java -jar migrate-webprotege.jar -d "webprotege" -w /data/webprotege

5. The migration tool should run, printing out its progress as it goes. Once the tool finishes the migration you are ready to replace the previous webprotege.war file with the war file for WebProtégé 3.0.0.