Ir al contenido

Utilidad Updater

“Updater utility” de OpenKM es una herramienta administrativa en Java que ayuda a realizar actualizaciones automáticamente. Puede descargarla desde https://download.openkm.com/okm/OKMUpdater.jar.

Parámetros de línea de comandos:

Parámetro Descripción
-a, –auto Encadena las actualizaciones automáticamente hasta la última versión.
-d, –dev Actualiza la versión de desarrollo (solo debe usarse bajo supervisión técnica de OpenKM).
-e, –export : Exporta las acciones de actualización de una versión como Markdown, en vez de aplicarlas.
-f, –force Fuerza la actualización.
-h, –help Muestra información de ayuda.
-l, –log Elimina los logs de Tomcat.
-m, –manual Aplica las acciones manualmente.
-n, –monochrome Modo monocromo.
-o, –no-post Deshabilita las acciones de la etapa post.
-r, –no-pre Deshabilita las acciones de la etapa pre.
-t, –timeout Tiempo límite de ejecución del script.
--no-service Se usa con –tomcat-start/–tomcat-stop: Tomcat no está configurado como servicio.
--tomcat-start Arranca Tomcat y termina, sin ejecutar ninguna actualización (pensado para herramientas de orquestación externas, como migrator).
--tomcat-stop Detiene Tomcat y termina, sin ejecutar ninguna actualización (pensado para herramientas de orquestación externas, como migrator).
-u, –url Sobrescribe la URL de Tomcat detectada.
-v, –version Muestra la versión.
-x, –check Comprueba la conectividad con la API de actualización.

Etapas de la actualización

Sección titulada «Etapas de la actualización»
  • Comprueba si está ubicada en la carpeta $TOMCAT_HOME; en caso contrario, mostrará un mensaje de error.
  • Solicita al administrador cierta información.
    • URL de OpenKM (normalmente algo accesible desde el servidor, como http://localhost:8080/openkm).
    • Si la aplicación está configurada como servicio [S/N].
    • El usuario válido con ROLE_ADMIN de OpenKM (okmAdmin).
    • La contraseña del usuario administrador.
  • Comprueba la configuración del servicio, la conexión del usuario y la versión de OpenKM.
  • Si la utilidad supera estas comprobaciones, pedirá confirmación al usuario para continuar con la actualización [S/N].
  • Descarga el nuevo fichero openkm.war (versión actual + 1).
  • Al terminar la descarga, ejecutará las acciones previas a la actualización.
  • Detiene OpenKM.
  • Reemplaza el fichero OpenKM.war antiguo por el recién descargado.
  • Modifica el parámetro hibernate.hbm2ddl a update en el fichero $TOMCAT_HOME/openkm.properties.
  • Vuelve a iniciar OpenKM.
  • Comprueba si OpenKM está disponible y, entonces, ejecuta las acciones posteriores a la actualización.

Modo manual

Sección titulada «Modo manual»

Si invoca la utilidad OKMUpdater con el parámetro -m, no se ejecutará ninguna de las acciones, así que deberá ejecutarlas manualmente. Según el tipo de acción, deberá usar distintas utilidades ubicadas en Administration > Utility.

Tipos de acciones:

  • SQL: vaya a Administration > Utilities > Database query (elija SQL en la selección)
  • HQL: vaya a Administration > Utilities > Database query (elija HQL en la selección)
  • Script: vaya a Administration > Utilities > Scripting.

Tenga en cuenta que algunas acciones deben ejecutarse antes de la actualización y otras después. Este es el proceso de actualización resumido:

  • Ejecutar acciones PRE
  • Detener OpenKM
  • Reemplazar openkm.war
  • Iniciar OpenKM
  • Ejecutar acciones POST