INTRODUCCIÓN

El Monitoreo de Integraciones en la consola de Bridge Manager es una herramienta clave para supervisar y controlar las diferentes integraciones que el sistema mantiene con servicios externos y módulos internos. Esta funcionalidad permite a los usuarios visualizar en tiempo real el estado de los procesos automáticos y la comunicación con otros sistemas, garantizando que todas las operaciones se lleven a cabo sin interrupciones.

El objetivo principal del Monitoreo de Integraciones es ofrecer una visión centralizada del funcionamiento de las distintas integraciones, proporcionando alertas e información detallada sobre posibles errores o problemas. De este modo, los usuarios pueden tomar decisiones rápidas y correctivas para asegurar que el sistema continúe operando de manera eficiente.

El Monitoreo de Integraciones sirve para identificar posibles fallos en la comunicación entre sistemas, errores en los procesos automáticos, y asegurar que los flujos de trabajo se completen exitosamente. Permite a los administradores y supervisores de la consola Bridge Manager mantener el control sobre la estabilidad del sistema, prevenir interrupciones en el servicio, y garantizar la correcta sincronización de datos entre las distintas plataformas o servicios externos que interactúan con Bridge.



Para acceder al módulo "Monitor de Integraciones" en Bridge Manager, dirígete al menú principal, selecciona Monitoreo y luego haz clic en Monitor de Integraciones.



MONITOR DE INTEGRACIONES

El módulo de "Monitoreo de Integraciones" en Bridge permite a los usuarios supervisar el estado y la actividad de los plugins integrados. Este apartado explica cómo visualizar y entender la información presentada en esta sección del sistema, asegurando que puedan identificar rápidamente el estado y la actividad de cada plugin.


Consumo de Colas RabbitMQ: El plugin siempre consume las colas RabbitMQ para procesar los mensajes entrantes. Esto permite una gestión eficiente de las transacciones y la comunicación entre los diferentes componentes del sistema.

Desde esta sección se pueden visualizar los plugins y sus estados. En API se genera un endpoint para recibir los heartbeats de los plugin, en la ruta plugin/status, validando si el plugin existe o no para agregarlo a la colección PluginMonitor o de existir actualizar su campo lastUpdate.


En la pantalla de "Monitoreo de Integraciones", se muestra una lista de todos los plugins registrados, junto con información relevante sobre su estado y última actualización:

Información de la Tabla

  • Estado:

    • Icono amarillo con un check : El plugin está activo y funcionando correctamente.
    • Icono rojo con linea cruzada : El plugin está inactivo o no ha enviado señales recientemente.

  • Código: "plugin -> code" Código único del plugin para que BM lo diferencie.

  •  Nombre/Descripción: Texto informativo del plugin, valor por default.

  • URL: Es la Url completa del plugin, es decir, IP y Puerto, ejemplo: "http://localhost:8681".

  • Última Actualización: Indica la última vez que el sistema recibió una señal de actividad del plugin. Esto es útil para verificar si el plugin está funcionando en tiempo real.

  • Botón "Detalle": permite a los usuarios obtener información detallada sobre un plugin específico.



DETALLE DEL PLUGIN

En el contexto de Bridge Manager, un plugin es un componente externo que se integra con el sistema para realizar tareas específicas y automatizadas, sin alterar el núcleo del software. Los plugins amplían la funcionalidad de Bridge Manager, permitiendo la comunicación y el procesamiento de datos con sistemas externos o la automatización de tareas internas. Esto incluye, por ejemplo, la gestión de transacciones, el procesamiento de mensajes, o el monitoreo de integraciones.

El objetivo principal de un plugin es facilitar la interacción con sistemas externos o automatizar tareas dentro de Bridge Manager. Cada plugin tiene un propósito definido, como procesar colas de mensajes (por ejemplo, con RabbitMQ), manejar transacciones o monitorear integraciones.


Dependiendo de los plugins que cada cliente gestione desde el Monitor de integraciones, la visualizacion de la pantalla de detalles podrá variar en base a lo gestione el plugin desarrollado.


El objetivo principal de un plugin es facilitar:

  • Interacción con sistemas externos: Los plugins actúan como puentes entre Bridge Manager y otros sistemas, asegurando que ambos se mantengan sincronizados.
  • Automatización de tareas: Procesos como la actualización de inventario, la sincronización de datos, o el monitoreo de eventos pueden programarse y ejecutarse sin intervención manual.
  • Escalabilidad: Los plugins permiten añadir nuevas funciones o integraciones sin necesidad de modificar la estructura central de Bridge Manager.


Un plugin puede estar configurado para:

  • Procesar mensajes de una cola: Por ejemplo, un plugin conectado a RabbitMQ podría gestionar la entrada de datos mediante el consumo de colas de mensajes, lo que permite la comunicación y el flujo de información entre distintos módulos de Bridge Manager y sistemas externos.
  • Sincronizar datos: Si Bridge Manager está integrado con un sistema de inventario externo, un plugin podría asegurar que los datos de inventario se actualicen automáticamente en ambos sistemas.
  • Emitir alertas: Un plugin puede configurarse para enviar alertas si no ha recibido una actualización en un período de tiempo específico, ayudando a detectar problemas de comunicación.


En resumen, los plugins en Bridge Manager son herramientas versátiles que permiten la expansión funcional del sistema y garantizan una integración eficiente y continua con otros servicios o plataformas.


Para acceder al detalle de un plugin, se debe localizar el plugin en la lista de la pantalla "Monitoreo de Integraciones" y hacer clic en el botón 'Detalle' correspondiente.


En la pantalla de "Detalle de Plugin", se muestra información específica del plugin seleccionado, junto con opciones para configuraciones adicionales y acciones. Esta vista incluye las siguientes secciones:

CABECERA:

En la cabecera se podrá visualizar los datos principales del plugin, así cómo también las diferentes configuraciones adicionales dispuestas según las distintas particularidades del plugin. 

  • Código: Identificador único del plugin.
  • Nombre/Descripción: Descripción del plugin.
  • URL: Dirección web del plugin.
  • Estado: Indica si el plugin está activo.


Desde BMC en el botón “Transacciones” se podrá visualizar las transacciones del plugin y su estado, cada registro tiene la opción de ver el contenido y en el caso de las transacciones con status error se podrá realizar la acción de REPROCESAR, adicionalmente, se puede seleccionar multiples transacciones para reprocesar con el botón “Reprocesar seleccionadas”:


DESCARGA DE LOGS

La sección de "Descarga de Logs" permite obtener los registros de actividad del plugin. Es importante destacar que al hacer clic en el botón de descarga, el sistema realiza una llamada al plugin para solicitar esta información. Por lo tanto, es necesario que el plugin esté activo y en funcionamiento para poder proporcionar los archivos de logs. Si el plugin no está activo o levantado, no se podrán obtener los logs.

  • Fecha de descarga: Permite descargar los registros de actividad del plugin hasta la fecha seleccionada. Los logs se guardarán en la carpeta de descargas en un archivo '.zip'



PROCESOS PROGRAMADOS

En esta sección se muestra una lista de tareas automatizadas que el plugin ejecuta regularmente.

Cada proceso incluye:

  • Nombre del Proceso: Descripción del proceso.
  • Descripción: Detalles sobre lo que hace el proceso.
  • Últimas Notas: Notas recientes sobre la ejecución del proceso.
  • Cron: Programación del proceso (frecuencia de ejecución).
  • Estado: Indica si el proceso está activo.
  • Última Ejecución: Fecha y hora de la última vez que se ejecutó el proceso.


Acciones Disponibles: Detener y Ejecutar

Cada proceso programado tiene dos botones de acción asociados:

DETENER

El botón Detener se utiliza para detener la ejecución de un proceso programado. Al hacer clic en este botón, el proceso dejará de ejecutarse automáticamente según la programación establecida. Esto puede ser útil en situaciones donde se necesita pausar temporalmente una tarea debido a:

  • Mantenimiento del sistema.
  • Solución de problemas específicos relacionados con el proceso.
  • Ajustes de configuración necesarios antes de continuar con la ejecución regular.

Ejemplo: Si un proceso de envío de facturas está generando errores, el usuario puede detener el proceso mientras se investiga y soluciona el problema, evitando así más errores hasta que se resuelva la situación.


EJECUTAR

El botón Ejecutar se utiliza para iniciar manualmente la ejecución de un proceso programado. Al hacer clic en este botón, el proceso se ejecutará inmediatamente, independientemente de su programación regular. Esto puede ser útil en situaciones donde:

  • Es necesario ejecutar una tarea de inmediato debido a requerimientos urgentes.
  • Se están realizando pruebas para verificar el correcto funcionamiento del proceso.
  • Se ha realizado una actualización o cambio que necesita ser aplicado de inmediato.



DOCUMENTACIÓN TÉCNICA


A continuación se detalla la manera correcta de instalar un plugin en Windows, así como las posibles configuraciones que se pueden realizar para el correcto funcionamiento de este.
Ingresar al servidor del ambiente que posea bridge manager central y crear una carpeta para la instalación del plugin en donde se deberá copiar el proyecto.


Luego, en el archivo default.json contenido en la carpeta config, se deberán realizar las configuraciones iniciales para el funcionamiento del plugin y la visualización de los datos en el Monitor de Integraciones que se encuentra en Bridge Manager Central.

Este archivo contiene la siguiente estructura dentro de "app": 


Llave

Valor

mongoUrl

Es donde se configurará la conexión a la base de datos de nuestro central instalado.

mongodb://bridge:Nosotros123Usuario y password de nuestra base de datos.
@localhost:27017/

Ip y Puerto de nuestra base de datos de nuestro central instalado.

bridgeCentral

Indica el nombre de nuestra base de datos de nuestro central previamente instalado.

authSource=admin

Es la base de datos donde se autenticará para realizar la conexión.



  • Rabbit:  Se debe indicar usuario y contraseña utilizado para rabbit y el host donde esta alojado.

Llave

Valor

url

amqp://guest:guest@localhost

activetrue


Llave

Descripción

url

Describe la url donde se aloja nuestra instancia de rabbit.

amqp://guest:guest

Usuario y password de autenticación de la consola de rabbit.

@localhost

Ip(localHost) y puerto separado por “:” el cual indica donde se está ejecutando nuestra instancia/consola de rabbit.

active

Este valor no se debe de modificar y siempre debe ser true ya que en el caso contrario no se tomarán las colas de rabbit.

  • Server: Contiene el puerto donde se levantará el plugin, el modo del log y si utilizara SSL.

Llave

Valor

port

8681

logModedebug
isSslfalse


Llave

Descripción

port

Puerto que usara el plugin (este puerto no tiene relación con bridge (manager/api/pos), este puerto es único y el que usara la aplicación (plugin dash) para levantar y ejecutar sus propias operaciones.

logMode

Este es un valor fijo y no debe ser modificado.

isSsl

Este es un valor fijo y no debe ser modificado.


ENDPOINTS

Desde la consola de Bridge, es posible ejecutar algunas acciones en la aplicación integrada. Estas acciones deben estar declaradas en la configuración del plugin, para que aparezcan en el monitor de integraciones como botones.

Las acciones disponibles en la aplicación se deben colocar en el campo endpoints de la configuración. Cada elemento de dicha lista tiene la siguiente estructura:

La descripción de los campos son los siguientes:

  • path: ruta que se concatenará a pluginConfig.url para formar la URL completa que se invocará
  • options: refiere a opciones de http. En la consola, el comportamiento que tendrá cada botón dependerá de las siguientes opciones:
    • En caso de contener GET, al presionar el botón se invocará con dicho método para el cual se espera recibir en el body una lista de elementos tipo Param.
    • De no contener GET, se mostrará un popup mostrando los campos informados en params, para que el usuario pueda completar. Estos parámetros serán enviados en forma de json utilizando el método indicado (POST o PUT)
  • description: nombre con el que figurará el botón
  • icon: clase bootstrap con el que icono que se mostrará en el botón
  • params: lista de parámetros con los que se debe enviar la petición (excepto en caso de GET)

Cada elemento de tipo Param tiene la siguiente estructura:

Donde cada campo corresponde a:

  • key: nombre del campo con el que se informará en el json que va como body
  • name: nobmre del campo que figurará en la consola para completar
  • type: tipo de campo (string, boolean, number, etc.)
  • value: en el caso del request tipo GET, se espera recibir en dicho campo, el valor configurado actualmente en el plugin