Skip to content
Other versions

Loading…

Migration from 6.4 to 8.2

The OpenKM migration tool installs OpenKM 8.2 next to an OpenKM 6.4 installation, on a new database, and copies the 6.4 repository into it, as it does from 7.1. It copies the data straight between the two databases, so it takes seconds or minutes instead of the hours the Database import would need. OpenKM 6.4 is only read: its database and documents don’t change, and it keeps its service until the migration succeeds. You can download it from https://download.openkm.com/okm/OKMMigrator.jar.

It’s the same tool used for the migration from 7.1 to 8.2, and most of what that page explains also applies here: this page covers what is different in 6.4.

The same as from 7.1: folders, documents with all their versions, records and mails, with their metadata, notes, keywords, categories, permissions, subscriptions, locks, relations, tasks, bookmarks, users and roles, and stamps. With these differences:

  • Passwords: OpenKM 6.4 stores them in a way OpenKM 8.2 can’t check, so every user, okmAdmin included, gets a new password (see Steps).
  • Metadata: OpenKM 6.4 doesn’t keep its history. OpenKM 8.2 has the current values, and each metadata group shows up as one more version of the node. The tool starts OpenKM 8.2 a second time to register the 6.4 metadata groups, so 8.2 creates their tables itself.
  • Tasks: in OpenKM 8.2 a task has a single assigned user. If a 6.4 task had several, or roles, the first user stays assigned and the rest, and the users of those roles, get notified.
  • It also doesn’t migrate the forum, the wiki, staples, contacts, OMR, CMIS types, the Dropbox, Google Drive and Zoho connections, or shared queries and subscriptions. If there’s data of any of those, the tool warns about it.
  • OpenKM 6.4 must be on MySQL, MariaDB or PostgreSQL, with the documents on disk. If it keeps them in the database (repository.datastore.backend=db in its OpenKM.cfg), the tool stops without doing anything.
  • OpenKM 6.4 has no openkm.properties: the tool reads the connection to its database from the jdbc/OpenKMDS datasource of conf/server.xml (or conf/context.xml), where the installer sets it up, and the rest from OpenKM.cfg.
  • Create the empty 8.2 database, take a backup and have your download portal user and password ready, as from 7.1.
  • Long metadata values: OpenKM 8.2 keeps each property in a column of 128 characters (texts and drop-downs) or 256 (text areas), unless the group sets another size, and OpenKM 6.4 allows 512. If a value doesn’t fit, the tool stops and tells you which properties.
  • Download the tool into the base directory of the 6.4 installation (the folder where the tomcat symlink is located) and run it from there:
Terminal window
$ cd /opt/openkm
$ wget https://download.openkm.com/okm/OKMMigrator.jar
$ java -jar OKMMigrator.jar
  • It recognizes OpenKM 6.4 by its tomcat/OpenKM.cfg. If Tomcat is somewhere else, pass it with -p <Tomcat folder>/OpenKM.cfg.
  • Its questions, checks and confirmation are the same as from 7.1, and so is the rest, except that it starts OpenKM 8.2 twice: once to create its database schema and once to register the 6.4 metadata groups.
  • When it’s done, you’ll see ### MIGRATION 6.4 -> 8.2: DONE ### followed by the remaining steps, the same as from 7.1 except the first one:
    • New passwords. They are in <8.2 folder>/migrated-users-passwords.csv (for instance, /opt/openkm-8.2/migrated-users-passwords.csv), which only its owner can read. Start OpenKM 8.2 with its service, log in as okmAdmin with its new password, hand out the others and delete the file. To make every user change their password on their first login, set user.password.expiration (days) in Administration > Configuration (see Configuration parameters).
    • Then run MailPreviewFromRaw, activate the Mail Extractor Worker task again, rebuild the search index and register the license, as from 7.1.

If OpenKM 6.4 only kept the headers of a mail and not the whole message, the tool rebuilds a message with them and the text of the mail, and its attachments are migrated as documents, because they can’t be extracted again.

Documents, clean-up and if something goes wrong

Section titled “Documents, clean-up and if something goes wrong”

The same as from 7.1, with the 6.4 database and folders. Without multitenant.mode=on, OpenKM 6.4 keeps the documents in <repository.home>/datastore and the extracted text in <repository.home>/extraction, without a tenant folder; OpenKM 8.2 keeps them in tenant_1.

The command-line parameters are the same as from 7.1, except that -p is the path to the 6.4 OpenKM.cfg (by default, ./tomcat/OpenKM.cfg).