Cómo migrar un gadget de Nuxeo 5.4.2 a Nuxeo 5.6 o posterior

Los gadgets son pequeños bloques que se pueden añadir al panel de control de Nuxeo y que facilitan cierta información al usuario, como por ejemplo la lista de tareas pendientes, los documentos abiertos recientemente, etc. de manera que el usuario disponga de esa información de manera rápida y accesible.

A veces, las necesidades de una empresa no quedan cubiertas por los gadgets incluidos por defecto en Nuxeo, por lo que se pueden desarrollar nuevos gadgets para que los usuarios o los trabajadores de la empresa puedan contar con la información que necesitan. Estos gadgets formarán parte de un plugin mayor que puede contener otros gadgets. 

El problema viene cuando tratamos de migrar un gadget desarrollado para Nuxeo 5.4.2 o una versión más antigua  a la versión 5.6 o una versión posterior de Nuxeo, puesto que la plataforma ha cambiado la forma en la que interpreta los gadgets. 

Por tanto, si queremos que nuestro antiguo gadget siga funcionando cuando actualicemos la plataforma a una versión más nueva debemos seguir unos sencillos pasos que vamos a describir a continuación.

PASO 1

En primer lugar, abre el fichero xml del gadget que quieres migrar. De manera general, en ese fichero encontrarás una lista de scripts y varios métodos.

Corta todos los métodos que hay dentro del xml del gadget, para pegarlos en otro fichero.

PASO 2

Crea un fichero con extensión .js (por ejemplo: GADGET_SCRIPT.js) en /nuxeo.war/scripts/<PLUGIN>/gadgets/ y pega la porción de código que has cortado en el paso anterior.

PASO 3

Crea una contribución en un fichero .xml al punto de extensión "resources" del componente "org.nuxeo.theme.services.ThemeService" que indique la ruta del nuevo fichero .js creado en el paso anterior y además referencia esta contribución desde la sección "Nuxeo-Component" del MANIFEST.MF del plugin al que pertenece el gadget. 

PASO 4

En el fichero .xml del gadget (el correspondiente al primer paso), sustituye todas las líneas de los scripts:

<script src="{...}NOMBRE_SCRIPT_1.js"></script>

<script src="{...}NOMBRE_SCRIPT_2.js"></script>

...

por una sóla línea con la forma:

<script src="{clientSideBarUrl}nxthemes-lib/gadget-NOMBRE_SCRIPT_1.js,gadget-NOMBRE_SCRIPT_2.js,..."></script>

PASO 5

Por último, añade a la lista anterior el último script que has creado con los métodos extraídos del fichero .xml del gadget. En el ejemplo llamamos a este script "GADGET_SCRIPT.js":

<script src="{clientSideBarUrl}nxthemes-lib/gadget-NOMBRE_SCRIPT_1.js,gadget-NOMBRE_SCRIPT_2.js,...,gadget-GADGET_SCRIPT.js"></script>