Migration from 4.1 to 5.0

From OpenKM Documentation
Jump to: navigation, search

Download the migration utility called utilities.jar. This is a self-contained JAR with all the required dependencies. Can be executed from command line as:

$ java -Xmx512m -Djava.security.auth.login.config=jaas.conf -cp utilities.jar com.openkm.util.RepositoryUpgrade

And will show the parameters needed:

  • -roc, --repository-old-config: Path to the old repository configuration file. This is the $OLD_JBOSS_HOME/repository.xml file by default. Perhaps is different if you changes the repository.config property in OpenKM.cfg file.
  • -roh, --repository-old-home: Path to the old repository directory. This is the $OLD_JBOSS_HOME/repository directory by default. Perhaps is different if you changes the repository.home property in OpenKM.cfg file.
  • -rnc, --repository-new-config: Path to the new repository configuration. If you downloaded the JBoss + OpenKM bundle, there is a default $NEW_JBOSS_HOME/repository.xml file.
  • -rnh, --repository-new-home: Path to the new repository directory. This is the $NEW_JBOSS_HOME/repository directory by default. This folder actually does not exists and will be created in the migration process.

This is the content of the file jaas.conf

OpenKM {
  org.apache.jackrabbit.core.security.simple.SimpleLoginModule Required;

Nota advertencia.png Remember to make a backup before start the migration process or try to migrate a copy of the current repository.

Some warnings like can be ignored:

java.lang.ClassNotFoundException: es.git.openkm.extractor.AudioTextExtractor
java.lang.ClassNotFoundException: es.git.openkm.analysis.FilenameAnalyzer

Store the utility.log file for further reference.

There was a typo in OpenKM 4.1 in the property name. If you have configure LDAP integration, please edit your OpenKM.cfg and replace:




Nota clasica.png Miration process does not only involves the document repository but also the database data and structure. Because OpenKM can be installed in several database, this is not a simple way to make the migration.

We recommend to export the OpenKM 4.1 database data and make the changes to be imported in the new database structure. Or simple re-create users in the new OpenKM installation. Sorry for the inconvenience, but the changes between 4.1 and 5.0 were drastics due to heavy changes in the persistence layer (now we use Hibernate). The good news is that these changes will enable a simpler migration process in future OpenKM releases.

Also you can contact us for paid support and we study your particular migration problems.