Migración de 7.1 a 8.2
La herramienta de migración de OpenKM instala OpenKM 8.2 junto a una instalación OpenKM 7.1, en una base de datos nueva, y le copia el repositorio de la 7.1. Copia los datos directamente entre las dos bases de datos, así que tarda segundos o minutos en vez de las horas que necesitaría la Importación de base de datos, y aprovecha el texto que la 7.1 ya tenía extraído. OpenKM 7.1 solo se lee: su base de datos y sus documentos no cambian, y conserva su servicio hasta que la migración termina bien. Puede descargarla desde https://download.openkm.com/okm/OKMMigrator.jar.
Es la misma herramienta que la de la migración de 8.1 a 8.2: detecta que la instalación antigua es una 7.1 y pasa a este modo por sí sola.
Qué se migra
Sección titulada «Qué se migra»Carpetas, documentos con todas sus versiones, records y correos, con sus metadatos (y su histórico), notas, keywords, categorías, permisos, suscripciones, bloqueos, relaciones, tareas, bookmarks, usuarios (con su contraseña) y roles, y los sellos.
No se migran perfiles, automatizaciones, configuración, activity log, informes, tareas programadas, cuentas de correo, plantillas OCR ni workflows. Los usuarios con un perfil propio de la 7.1 pasan al perfil por defecto de la 8.2: revise ese perfil después (por ejemplo, para que se vean los grupos de metadatos). Los adjuntos de los correos los vuelve a extraer la 8.2 a partir del propio correo.
Sellos, informes y LDAP
Sección titulada «Sellos, informes y LDAP»- Los sellos se migran con los usuarios a los que están asignados, y funcionan igual: las expresiones de posición y los scripts usan las mismas variables en la 8.2. Solo un script que use clases de OpenKM puede necesitar cambios.
Hay que volver a configurarlos a mano en OpenKM 8.2, antes de que los usuarios empiecen a trabajar con ella:
-
Informes: vuelva a subirlos en Administration > Reports. OpenKM 8.2 usa JasperReports 7, que solo lee su propio formato JRXML, no el de JasperReports 6 de OpenKM 7.1: antes, abra cada informe en Jaspersoft Studio 7 y guárdelo en el formato nuevo, o dará el error «Unable to load report». Los informes que usan clases de OpenKM también pueden necesitar cambios.
-
Autenticación con LDAP o Active Directory: no se migra, y su configuración cambió en la 8.2, así que no copie tal cual las claves de la 7.1. Vuelva a configurarla siguiendo Configuración de LDAP:
- En
openkm.properties, la 8.2 solo usaokm.authentication.ldap,ldap.server,ldap.base,ldap.manager.distinguished.name,ldap.manager.password,ldap.referralyldap.user.search.filter. Las clavesldap.role.*de la 7.1 ya no existen. ldap.manager.passwordva en claro: si en la 7.1 empieza por{DES}o{AES}, está cifrada y la 8.2 no puede leerla.- Los usuarios y roles se sincronizan desde el LDAP con los parámetros
principal.ldap.*, en Administración > Configuración.
Los usuarios y roles guardados en la base de datos sí se migran.
- En
Antes de empezar
Sección titulada «Antes de empezar»- OpenKM 7.1 debe tener un solo tenant (lo habitual), sobre MySQL, MariaDB o PostgreSQL.
- Cree, como administrador de la base de datos, la base de datos vacía de la 8.2, en el mismo servidor que la de la 7.1 y con permiso para el mismo usuario de base de datos. Si no existe, la herramienta muestra el SQL exacto y se detiene sin hacer nada. Por ejemplo, en MySQL o MariaDB:
CREATE DATABASE okmdb82 DEFAULT CHARACTER SET utf8mb3 COLLATE utf8mb3_bin;GRANT ALL ON okmdb82.* TO 'openkm'@'localhost';Y en PostgreSQL:
CREATE DATABASE okmdb82 WITH OWNER openkm ENCODING 'UTF8' TEMPLATE template0;- Esquemas externos de metadatos: si algún grupo de metadatos de la 7.1 rellena sus desplegables con una consulta a otra base de datos (por ejemplo,
optionsQuery="select ct_id, ct_name from ama.Origen"), ese esquema no se copia. Como OpenKM 8.2 usa el mismo usuario de base de datos que la 7.1, en MySQL y MariaDB ya puede leerlo. En PostgreSQL ese esquema está dentro de la base de datos de la 7.1: créelo también en la de la 8.2, con sus datos, antes de arrancar OpenKM 8.2. Si no, esos desplegables aparecerán vacíos y, si alguien guarda el grupo así, podría borrar los valores. - Haga un backup de la base de datos y del repositorio de la 7.1. La herramienta no los modifica, pero tampoco hace ningún backup.
- Tenga a mano el usuario y la contraseña del portal de descargas de OpenKM, los mismos que usa con el instalador. Se necesitan para descargar OpenKM 8.2.
- Descargue la herramienta en el directorio base de la instalación 7.1 (la carpeta donde está el enlace simbólico
tomcat) y ejecútela desde ahí:
$ cd /opt/openkm$ wget https://download.openkm.com/okm/OKMMigrator.jar$ java -jar OKMMigrator.jar- Responda a sus preguntas. Cada una propone un valor, que se acepta pulsando Intro:
- Carpeta donde instalar OpenKM 8.2: junto a la de la 7.1, por ejemplo
/opt/openkm-8.2. Se instala ahí sin tocar el enlacetomcatni el servicio de la 7.1. - Nombre de la nueva base de datos de OpenKM 8.2:
okmdb82. - Carpeta de los documentos de OpenKM 8.2: vea Documentos.
- Carpeta donde instalar OpenKM 8.2: junto a la de la 7.1, por ejemplo
- Antes de cambiar nada, comprueba los requisitos y muestra qué va a instalar y de qué carpetas a qué carpetas va a llevar los documentos. Después pide el usuario y la contraseña del portal de descargas, y una confirmación (
[y/N]). Escribaypara continuar. - A partir de ahí es automático: para OpenKM 7.1, instala OpenKM 8.2, la arranca una vez para que cree el esquema de su base de datos, copia los datos y los documentos y, solo si todo ha ido bien, registra el servicio de OpenKM para la 8.2 en lugar del de la 7.1.
- Al terminar verá
### MIGRATION 7.1 -> 8.2: DONE ###seguido de los pasos que quedan:- Arranque OpenKM 8.2 con su servicio. Los usuarios,
okmAdminincluido, entran con su contraseña de la 7.1. - Abra
<URL de OpenKM>/management/updaterUtilsy ejecute MailPreviewFromRaw. Regenera la previsualización de los correos y los prepara para volver a extraer su texto y sus adjuntos. - En Administración > Crontab, reactive la tarea Mail Extractor Worker. La herramienta la deja parada porque, sin el paso anterior, marcaría los correos como extraídos sin texto ni adjuntos.
- Reconstruya el índice de búsqueda desde Administración > Utilidades > Reconstruir índices. Hasta entonces los documentos están, pero no salen en las búsquedas.
- Registre la licencia de OpenKM 8.2. Es una instalación nueva, con su propio Installation ID, así que necesita su propia licencia, que cubra todos sus usuarios activos: pídasela a OpenKM cuando OpenKM 8.2 ya haya arrancado por primera vez. Hasta entonces, solo admite 10 usuarios.
- Arranque OpenKM 8.2 con su servicio. Los usuarios,
Documentos
Sección titulada «Documentos»La herramienta traslada los documentos (datastore) y el texto extraído (extraction) de la 7.1 a carpetas nuevas de OpenKM 8.2, en el mismo disco que las de la 7.1, para poder usar hardlinks: es instantáneo y no ocupa espacio extra. Por defecto:
- Si la 7.1 los guarda dentro de su Tomcat (lo habitual), OpenKM 8.2 los guarda dentro del suyo.
- Si la 7.1 tiene su
repository.homefuera de Tomcat (por ejemplo,repository.home=/data/repository), OpenKM 8.2 tiene el suyo al lado, con el sufijo-8.2(/data/repository-8.2), siempre que esté en el mismo disco, y los guarda en el mismo sitio dentro de él:/data/repository-8.2/tenant_1/datastorey/data/repository-8.2/tenant_1/extraction. - Si no, al lado de la carpeta de la 7.1, con el sufijo
-8.2. Por ejemplo, si la 7.1 guarda los documentos en/mnt/datastore_71, OpenKM 8.2 usa/mnt/datastore_71-8.2.
Puede elegir otra carpeta para los documentos cuando la herramienta la pregunte. Si está en otro disco, los documentos se copian, y el disco necesita tanto espacio libre como ocupe el repositorio de la 7.1. Para copiarlos siempre, aunque estén en el mismo disco, añada --copy-files.
Si la carpeta de documentos de la 7.1 es un enlace simbólico (por ejemplo, repository/datastore apuntando a /mnt/datastore_71), la herramienta usa la carpeta real, y la de OpenKM 8.2 va al lado (/mnt/datastore_71-8.2), en el mismo disco. Los enlaces simbólicos dentro de las carpetas de la 7.1 no se admiten: la herramienta los busca en las comprobaciones iniciales y se detiene sin cambiar nada, así que sustitúyalos antes por las carpetas reales.
Si OpenKM 8.2 va a leer los documentos donde ya están (por ejemplo, en el mismo /mnt/datastore_71 o en un almacenamiento compartido), añada --skip-datastore: no se trasladan, y la herramienta configura OpenKM 8.2 para que los lea ahí. --skip-extraction hace lo mismo con el texto extraído. Si la 7.1 guarda los documentos en un bucket S3, configure repository.datastore.type=s3 y su repository.datastore.s3.key-prefix en el openkm.properties de la 8.2 antes de arrancarla.
Si la 7.1 reparte los documentos en varios shards (varios discos), su carpeta incluye ${shard.id}, por ejemplo /discoN/openkm/${shard.id}/${tenant.id}/datastore. La carpeta que se propone para OpenKM 8.2 lo conserva, de modo que cada shard sigue en su disco: /discoN/openkm/${shard.id}/${tenant.id}/datastore-8.2.
Después de la migración: limpieza
Sección titulada «Después de la migración: limpieza»Cuando haya comprobado durante unos días que OpenKM 8.2 funciona bien, puede eliminar OpenKM 7.1. Antes, asegúrese de que la tarea Mail Extractor Worker ha procesado todos los correos (su texto y adjuntos se vuelven a extraer del propio correo) y de que el índice de búsqueda está reconstruido. Hasta entonces, consérvelo todo: OpenKM 7.1 es la única vuelta atrás.
-
Servicio: no hay que hacer nada. El servicio mantiene su nombre (
openkmen Linux,OpenKMen Windows) y ahora arranca OpenKM 8.2; la herramienta sustituyó el de la 7.1 al terminar la migración. Con--no-serviceno se registró ningún servicio. -
Base de datos de la 7.1 (por ejemplo,
okmdb): haga un último backup y bórrela, por ejemploDROP DATABASE okmdb;. No borre el usuario de la base de datos: OpenKM 8.2 usa el mismo. En MySQL y MariaDB, tampoco borre los esquemas externos que leen los desplegables de metadatos (vea Antes de empezar). -
Carpeta de la instalación 7.1 (por ejemplo,
/opt/openkm, con el Tomcat de la 7.1 y su symlinktomcat; OpenKM 8.2 está en/opt/openkm-8.2): se puede borrar, igual que las carpetas de documentos de la 7.1 fuera de Tomcat (por ejemplo,/mnt/datastore_71, o la carpeta de la 7.1 de cada shard), pero antes compruebe cómo se trasladaron los documentos (vea Documentos):- Con hardlinks (mismo disco, lo habitual): borrar las carpetas de la 7.1 solo quita los nombres de los ficheros de la 7.1. OpenKM 8.2 conserva los suyos, así que no se pierde nada, pero tampoco se libera espacio de los documentos: nunca estuvieron duplicados.
- Copiados (otro disco, o
--copy-files): los ficheros de la 7.1 son un duplicado. Borrarlos libera ese espacio. repository.homede la 7.1 fuera de Tomcat (por ejemplo,repository.home=/data/repository): se puede borrar entero. El de OpenKM 8.2 es otra carpeta,/data/repository-8.2: no la borre.- Sin trasladar (
--skip-datastoreo--skip-extraction): OpenKM 8.2 lee esas carpetas donde están. No las borre. Si están dentro del Tomcat de la 7.1, conserve también esa carpeta, o muévalas antes y cambierepository.datastore.homeorepository.extraction.homeen elopenkm.propertiesde la 8.2.
Si la carpeta de la 7.1 era un enlace simbólico, los ficheros se trasladaron desde la carpeta real a la que apunta (por ejemplo,
/mnt/datastore_71), que se puede borrar como cualquier otra carpeta de la 7.1; el enlace desaparece con el Tomcat de la 7.1. El resumen de la consola yOKMMigrator.logindican cuántos ficheros se enlazaron con hardlinks y cuántos se copiaron. En Linux,ls -lmuestra un número de enlaces de 2 o más en un fichero con hardlink. -
Restos:
OKMMigrator.jaryOKMMigrator.log(en la carpeta desde la que ejecutó la herramienta, dentro de la de la 7.1), yOKMInstaller.jaryOKMUpdater.jaren la carpeta de la 8.2. ConserveOKMUpdater.jarpara futuras actualizaciones.
Parámetros de la línea de comandos
Sección titulada «Parámetros de la línea de comandos»| Parámetro | Descripción |
|---|---|
| -p, –old-properties |
Ruta al fichero openkm.properties de la instalación 7.1. Por defecto, ./tomcat/openkm.properties. |
| -d, –parent-dir |
Carpeta donde instalar OpenKM 8.2, sin preguntar. |
| --target-datastore |
Carpeta de los documentos de OpenKM 8.2, sin preguntar. Puede incluir ${tenant.id} y ${shard.id}. |
| --target-extraction |
Carpeta del texto extraído de OpenKM 8.2. Por defecto, en el mismo disco que la de la 7.1. |
| --source-datastore |
Carpeta de documentos de la 7.1. Por defecto, la que indique su openkm.properties. |
| --source-extraction |
Carpeta de texto extraído de la 7.1. Por defecto, la que indique su openkm.properties. |
| --copy-files | Copia los documentos aunque se puedan trasladar con hardlinks. |
| --skip-datastore | No traslada los documentos: OpenKM 8.2 queda configurada para leerlos donde ya están. |
| --skip-extraction | No traslada el texto extraído: OpenKM 8.2 queda configurada para leerlo donde ya está. |
| --no-service | OpenKM 7.1 no está configurada como servicio: su Tomcat se para con shutdown.sh y no se registra ningún servicio para OpenKM 8.2. |
| -f, –force | Omite la petición de confirmación (para uso no interactivo o desde scripts). |
| -h, –help | Muestra la ayuda. |
Las carpetas indicadas con --source-* sustituyen a la configuración del openkm.properties, así que no se pueden usar con un repositorio repartido en varios shards.
Si algo falla
Sección titulada «Si algo falla»Si la herramienta se detiene en las comprobaciones previas, no ha cambiado nada: corrija lo que indique y vuelva a lanzarla. Si falla después, OpenKM 7.1 queda como estaba, con su servicio (vuelva a arrancarla si la necesita), y OpenKM 8.2 a medio instalar: borre lo que indique el mensaje, borre y vuelva a crear la base de datos de la 8.2, y vuelva a lanzar la herramienta.
Guarde la salida completa de la consola y el fichero OKMMigrator.log (queda en la carpeta desde la que se ejecutó) y contacte con el soporte de OpenKM si necesita ayuda.