DIRECTOR Multiempresa - Manual de usuario 2.0

1. Acerca del manual

1.1 Propósito y alcance

El presente manual tiene por finalidad la capacitación de los usuarios que deseen utilizar la consola de administración del producto Director.
Brinda la información necesaria, con el nivel suficiente de detalle para que el usuario pueda monitorear el estado del sistema, así como también obtener información sobre el procesamiento de operaciones y realizar las tareas de administración correspondientes.

El manual se encuentra dividido en los siguientes capítulos:

Capítulo 1- Acerca del manual
Provee una visión global del manual, brindado información sobre el contenido del mismo

Capítulo 2 – Introducción
Explica en qué consiste el producto Director y los componentes que abarca Napse

Capítulo 3 – Consola de administración
Brinda información para comenzar a interactuar con la consola de administración

Capítulo 4 – Versiones
Brinda información para la administración de productos y versiones de dichos productos

Capítulo 5 – Monitoreo
Explica el procedimiento para descargar e instalar una nueva versión de una solución Napse en las terminales de una o más tiendas y el procedimiento de cómo monitorear las terminales de las tiendas

Capítulo 6 – Administración
Informa los temas administrativos referentes a la aplicación

1.2 Referencias tipográficas

En este manual se utilizarán las siguientes convenciones:

2. Introducción

2.1 ¿Qué es Director?

Director es una solución multiempresa de Napse que permite gestionar, administrar, distribuir y monitorear de manera centralizada y eficiente nuevas versiones de productos Napse en la red de tiendas de un retailer.
Además, posee la funcionalidad de monitorear en forma remota las terminales publicando múltiple información de las mismas.

2.2 Componentes

Director se encuentra constituido por los siguientes componentes:

• Director Server
  Ubicado de forma centralizada en un servidor, permite y efectúa la gestión, administración, coordinación e integración del sistema. Le ofrece al usuario una consola web de operación. 
  
  

• Consola de administración
  Por medio de la interfaz gráfica web, el usuario puede acceder a la solución para administrar los productos Napse y sus versiones y monitorear las terminales de los locales. 
  
  

• GIT
  Se encarga de llevar a cabo el control y la gestión de versiones de los productos definidos en el sistema. 
  
  

• Agente
  Se encuentra integrado en cada producto de una terminal, Entre sus principales funciones se encuentran: informar periódicamente el estado del producto, actualizar el producto a nuevas versiones vigentes e informar datos de una terminal.
  
  

3. Consola de administración

Debido a las características de un servicio web, el acceso a la consola administrativa se puede realizar de forma remota.
Para acceder a la consola web de Director se debe utilizar el siguiente enlace:

Donde:

• IP-SERVER: corresponde a la dirección IP o nombre del server donde se está ejecutando el servidor Director
• PORT: corresponde al puerto del servidor web utilizado por Director.

Finalizada la inicialización del sistema y accediendo a la URL mencionada, se visualizará la siguiente pantalla, desde donde se podrá visualizar información de integración y realizar el inicio de sesión:

Director concede por defecto una cuenta de acceso a la consola de administración. El formulario de Login solicitará los datos de la cuenta por defecto:

• Nombre de usuario: suser
• Clave de acceso: Nosotros123
• Compañía

Este usuario tendrá los permisos necesarios para poder gestionar los usuarios del sistema.

Pantalla de Login

3.1 Flujo Operativo

En este apartado se explicará el flujo o secuencia normal de configuración y operatoria en la consola de Director:

1. Creación de la compañía (Documento VTOL CORE - Manual de usuario 4.0.0.X).
   Se debe crear la entidad con mayor jerarquía en la red del negocio del retailer. La compañía contendrá un conjunto de locales.
   
   
2. Creación del local.
   Un local pertenece a una compañía y posee un conjunto de terminales.
   
   
3. Creación de las terminales.
   Las terminales son las unidades lógicas que representan una caja. En las mismas se ejecutan los productos que se actualizarán mediante Director.
   
   
4. Creación del producto (apartado 4.1.1 Alta de productos)
   Es preciso definir en el sistema el producto de software que se utiliza en las terminales y la ruta en GIT en donde se almacenarán las versiones. Un producto poseerá varias versiones.
   
   
5. Alta de versión para el producto creado previamente (apartado 4.2.2 Alta de versiones)
   Se define en el sistema la versión vigente del producto creado previamente.
   
   
6. Monitoreo y gestión de versiones por producto y por terminales (apartado 5.1 Monitoreo de Versiones)
   En estas pantallas, se gestionan las versiones de los productos por terminales y se monitorean las características que poseen cada una de las terminales.
   
   

4. Versiones

4.1 Administración de Productos

Un producto es una solución de software instalada en las terminales de una empresa.
Director permite definir y gestionar los productos de forma única para su posterior uso en el sistema.

Acceso:
Para acceder a esta pantalla se debe seleccionar la opción del menú denominada "Administración de Productos" dentro de "Versiones" (Versiones > Administración de Productos).

Descripción de la página:
A través de esta página es posible efectuar el alta, consulta y edición de los productos que operará el retailer.

4.1.1 Alta de productos 

Crear en GitLab (previamente configurado) un repositorio para el nuevo producto.

Al momento de dar de alta en repositorio en gitLab se debe tener en cuenta las siguientes consideraciones:

• El Project name deberá ser el nombre de la compañía + el código del producto (respetando mayúsculas y minúsculas del código de compañía y del código de producto).
• El Project slug deberá ser exactamente igual al Project name (respetando mayúsculas y minúsculas).
• En Project URL, el usuario deberá ser root.
• El Nivel de visibilidad deberá ser público.

Una vez creado el repositorio, ya podemos crear un producto en Director Server.
Presionar el botón "Nuevo" del formulario "Administración de Productos". Se desplegará la siguiente pantalla:

Se informará el código de compañía en la cual se encuentra logueado el usuario, sin posibilidad de edición y  se deberán ingresar los siguientes campos:

• Código: obligatorio y único
• Nombre: obligatorio
• Nombre repositorio GIT: el nombre del repositorio se autocompleta con el código de la compañía y el código del producto ingresado por el usuario. El  nombre de repositorio deberá ser previamente creado en GIT.
• Descripción: detalle descriptivo opcional del producto
• Activo: estado del producto, por defecto estará tildado que significa habilitado

Presionar el botón "Guardar" para finalizar la creación del producto o "Volver" para regresar a la pantalla de administración de productos.
Una vez registrado el producto se generará en forma automática una versión base, la cual se utilizará como punto de partida para una futura versión que se desee instalar en una o más tiendas/terminales.

4.1.2 Modificación de productos

Para modificar un producto en particular previamente cargado, se debe presionar el botón "Opciones > Editar".
En el formulario de edición, se mostrarán los datos cargados y se podrán modificar los siguientes valores:

• Nombre
• Descripción
• Estado

Presionar "Guardar" para guardar los cambios o "Volver" para descartarlos y volver a la pantalla principal.

4.2 Administración de Versiones

Los productos evolucionan en forma de versiones para otorgar nuevas funcionalidades.
Con Director, las versiones de los productos se alojan en un repositorio central para luego ser distribuidas en todas las terminales de un retail de manera remota.

Acceso:
Para acceder a esta pantalla se debe seleccionar la opción del menú denominada "Administración de Versiones" dentro de "Versiones" (Versiones > Administración de Versiones).

Descripción de la página:
Gracias a este formulario es posible efectuar el alta, consulta y edición de las versiones de los productos registrados en el sistema.

4.2.1 Búsqueda de versiones

Las versiones cargadas en el sistema se pueden localizar mediante los siguientes filtros:

• Producto
• Código de la versión

Una vez completado alguno de dichos campos, se debe presionar el ícono de "Buscar" para que la búsqueda se lleve a cabo y se puedan visualizar los registros que posean una coincidencia igual o parcial.

4.2.2 Alta de versiones 

Para crear una versión de un producto, presionar el botón "Nuevo" del formulario "Administración de Versiones". Se desplegará la siguiente pantalla

Se informará el código de compañía en la cual se encuentra logueado el usuario, sin posibilidad de edición, y  se deberán ingresar los siguientes campos:

• Código: obligatorio y único
• Descripción: detalle descriptivo opcional de la versión
• Producto
• Versión anterior: Versión (Código) de la cual hereda la nueva versión
• Activo: estado del producto, por defecto estará tildado que significa habilitado
• Backup base de datos: permite realizar un backup automático de la base de datos
• Seleccionar versión: el archivo a adjuntar debe ser formato zip y contener la versión del producto con la siguiente estructura de directorios:

• Importar: presionar en el botón importar para importar la versión.

Una vez cargado y validado el archivo, se informarán los cambios que se efectuaron en el repositorio tras la carga de una nueva versión.

Presionar el botón "Aceptar" para continuar.
Finalmente, presionar "Guardar" para registrar la versión en el sistema o "Volver" para volver a la pantalla de administración de versiones.

4.2.3 Modificación de versiones

Para modificar una versión previamente cargada, se debe presionar el botón "Opciones > Editar".
En el formulario de edición, se mostrarán los datos cargados y se podrán modificar los siguientes valores:

• Descripción
• Backup base de datos
• Estado

El código de la compañía, código, producto, versión anterior y el archivo de versión, no es posible editarlos.

Presionar "Guardar" para guardar los cambios o "Volver" para descartarlos y volver a la pantalla de administración de versiones.

5. Monitoreo

5.1 Monitoreo de Versiones 

Las versiones de los productos que están instaladas en los terminales se podrán controlar y actualizar de forma centralizada.
El proceso de actualización de versiones de productos consta de dos etapas:

• Descarga: Descarga en la terminal la versión disponible de un producto
• Instalación: Con la descarga finalizada de archivos correspondientes a la versión y disponibles en la terminal, se efectúa la instalación automática

Cada uno de los pasos de la actualización en cada terminal es ejecutado e informado por el componente Director Agent.
Ambas etapas de actualización se realizan bajo demanda desde la pantalla de "Monitoreo de Versiones" de Director.

Acceso:
Para acceder a esta pantalla se debe seleccionar la opción del menú denominada "Monitoreo de Versiones" dentro de "Monitoreo" (Monitoreo > Monitoreo de Versiones).

Descripción de la página:
En esta página, se logran ejecutar los procesos de descarga e instalación de versiones.
En la cuadrilla se logra visualizar todas las terminales con sus productos instalados, conocer la versión que poseen y la versión que tienen descargada para actualizar el producto, como así también si poseen una tarea asignada a la terminal (tanto de descarga como de instalación).
Además, se informa el estado de la terminal (activo o desconectada) y el estado del producto que se ejecuta en la terminal (en funcionamiento o detenido).

5.1.1 Búsqueda

Los filtros ofrecidos para monitorear las versiones instaladas en las terminales son los siguientes:

• Producto (obligatorio)
• División Operativa
• Tienda
• Categoría
• Terminal
• Actual
• Descargada
• Último estado (mayor)
• Última tarea
• Versión de agente

Presionar el botón de "Buscar" para que la búsqueda se lleve adelante. Al hacer esto, en la tabla se mostrará como resultado las terminales por tienda y por producto.

5.1.2 Descarga de versión

El proceso de descarga permite que en una terminal se descargue remotamente desde un repositorio central una versión seleccionada por el usuario para posteriormente efectuar el proceso de instalación de la versión descargada.

Para descargar una versión a una o más terminales, se debe tildar la/las mismas y luego presionar el botón de “Descargar”, donde se mostrará un diálogo con un resumen de la cantidad de terminales seleccionadas y una lista de versiones disponibles para descargar a las terminales seleccionadas, con el objetivo de que el usuario pueda confirmar la acción deseada.

Adicionalmente se le pedirá que indique las opciones de planificación

• Indicando fecha y hora
• O bien que la descarga se haga ni bien la terminal se reporte al servidor

Por último se le pedirá al usuario que ingrese un comentario (obligatorio) asociado a la acción de descarga y que generará un registro de auditoria en el sistema

Una vez finalizada la descarga de la versión en la/las terminales a la hora y fecha programada, se mostrará en la columna "Estado" la leyenda Disponible y en la columna "Descargada" el código de versión actualizado.

El paso siguiente es generar la instalación de la versión descargada en la terminal.

5.1.3 Instalación de versión

Una vez realizado exitosamente el proceso de descarga, se procede a ejecutar también de forma remota la instalación de la versión en la terminal.

Para actualizar una o más terminales se deben tildar y presionar el botón "Instalar".

Se abrirá un diálogo con un resumen de de la cantidad de terminales seleccionadas, un agrupamiento de cantidades de terminales que se instalarán X versión y un comentario obligatorio.

A diferencia de la descarga, el proceso de Instalación se ejecutará tan pronto el agente (componente cliente de la solución Director) se reporte al servidor. El agente ejecutará una serie de pasos y los informará a Director Server para que sea mostrado en la pantalla.

Finalizada la etapa de instalación, se informará en la columna "Estado" la leyenda Disponible y en la columna "Actual" la versión instalada.

6. Actualización masiva de agentes

6.1 Descripción

A través de Director se pueden descargar y actualizar versiones de aplicaciones. Este proceso se lleva a cabo gracias a la interacción entre un componente cliente llamado "agente", desplegado en cada terminal que posee software actualizable, y el componente servidor o Director Server. No obstante, para actualizar el agente en sí, no es posible hacerlo de la misma manera que se hace con una aplicación. Sin embargo, la solución posee un mecanismo para distribuir los binarios de los agentes en toda la cadena, por ejemplo cuando:

• se agregan nuevas funcionalidades
• se corrigen issues
• hay algún binario queda corrupto
• etc

6.2 ¿Cómo funciona?

Cuando inicia el agente, antes de iniciar la aplicación, le consulta al Director Server si sus binarios son los mismos que él tiene, utilizando para ello un número de versión.

Si dicha versión es la misma, el proceso continúa con el inicio normal.

Si no son iguales, se hace una comparación entre lo que tiene el cliente/agente y lo que tiene el servidor. Con éste delta, se hace la transferencia automática de las diferencias, la cuales son aplicadas en el cliente para luego, si continuar con el proceso normal de inicio

6.3 ¿Cómo se activa?

Para activar ésta funcionalidad se debe crear una carpeta en el servidor donde se ejecuta Director Server que contenga todos los binarios del Agente.

Por ejemplo:

Luego crear un archivo de texto llamado "update.config" que contenga la siguiente propiedad

application.version=N

Donde N es un número incremental que se debe incrementar cada vez que se haya introducido algún cambio a dicha carpeta (agregar, renombrar o quitar archivos)

Una vez creada, ingresar a la consola de administración de Director Server e ir a la sección "Configuración → Configuración". Luego buscar la propiedad "Directorio raíz de actualizaciones del agente". Dicha propiedad debe indicar el directorio creado en el paso anterior, donde se encuentran los binarios del agente que se quieren sincronizar.

6.4 ¿Cómo evidenciar el funcionamiento?

Realizada la configuración de los pasos anteriores, al iniciar cada agente, notará que se logea así con la siguiente explicación:

6.5 ¿Cómo desplegar una versión nueva?

Para desplegar una versión nueva se debe

1. agregar/reemplazar/eliminar los archivos deseados de la carpeta "monitoreada" por Director Server (propiedad "Directorio raíz de actualizaciones del agente")
2. abrir el archivo "update.config" de dicho directorio
3. incrementar el valor de la propiedad "application.version"
4. reiniciar cada agente de la cadena