Manual de Instalación - BRIDGE Manager



REVISIONES

Fecha

Versión

Descripción

Autor

 

2.0Creación del documento basado en v7,0 para v7.1

 

2.1Se agrega la carga de un archivo scripts.zip

 

2.2Se agrega versión de Java " La versión de Java debe ser de 64 bits y NO de 32 bits"

 

2.3Se agrega req de HW por Rabbit


CONTENIDO


BM - Introducción

¿Qué es BRIDGE MANAGER?

Bridge Manager es uno de los componentes de la solución Bridge que actúa como BackOffice complementando la operación en tienda de los puntos de venta.

Está formado por:

  • Una consola de administración: accesible desde un explorador web, encargada de brindar una herramienta centralizada de administración.
  • Una base de datos: para el resguardo de las configuraciones, maestros de información y operaciones realizadas.
  • BRIDGE API: componente encargado de recibir y exportar: 
    • Una serie de interfaces de integración: los cuales permiten integrar la solución con sistemas externos (como ERP, sistemas legacy).

Bridge Manager posee dos esquemas de funcionamiento:

  • Por tienda: funciona local en cada tienda, en donde se permite realizar las operaciones de la propia tienda, monitorear su situación, realizar configuraciones locales.
  • Central: centraliza la información de todas las tiendas, permite realizar configuraciones generales a todas las tiendas y es quien recibe la información proveniente de los sistemas externos, para luego replicarlo a las tiendas, en caso de corresponder.



Para realizar la instalación local en una tienda o en forma centralizada se utiliza un mismo instalador y se seleccionará el modo (tienda/central) al momento de la instalación.


Acerca de este manual


En este manual encontrará toda la información necesaria para instalar el producto BRIDGE MANAGER.

Se explicarán cada uno de los pasos de instalación, los requerimientos de hardware y software, las propiedades a ser configuradas.

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


Capítulo 1 - BM - Introducción

Provee una breve descripción del producto así como también una visión global del manual, brindando información sobre el contenido del mismo.


Capítulo 2 - BM - Requerimientos

Informa las plataformas soportadas y los requerimientos de software y hardware para poder instalar el sistema


Capítulo 3 - BM - Instalación

Detalle de los requisitos a cumplir previo a iniciar la instalación la instalación del producto y de los pasos a realizar para cada modo de instalación disponibles.

También incluye un detalle del resultado de la instalación.


Capítulo 4 - BM - Ejecución del sistema

Informa cómo ejecutar el sistema.


Capítulo 5 - BM - Desinstalación

Resumen de cómo realizar la desinstalación.


Capítulo 6 - BM - Configuraciones

Ajustes posteriores a la instalación que pueden requerirse como cambio de base de datos, usuarios, configuración de logs y su análisis.


Capítulo 7 - BM - Mantenimiento

Información a tener en cuenta para el mantenimiento del sistema.


Capítulo 8 - BM - Troubleshooting

Detalle de problemas que pueden ocurrir y sus soluciones.


Documentación relacionada

  • MANUAL DE USUARIO - Bridge Manager v7.1


BM - Requerimientos

A continuación se detallan los requerimientos mínimos tanto de hardware como de software, considerando que sean de uso dedicado para la aplicación Bridge.



Los mismos deberán analizarse según la implementación de la solución ya sea por la combinación de equipos a utilizar y factores que puedan requerir de mayores recursos (ej; cantidad de terminales que atiende cada servidor de tienda, cantidad de servidores de tienda que atenderá cada servidor de Bridge Manager Central, ticket promedio y cantidad de tickets por terminal/tienda, etc)


BMC

Plataformas Soportadas

  • SUSE
  • CENTOS
  • UBUNTU 18

Requerimientos de Software

  • Base de Datos: MongoDB 4.2 o superior. El espacio necesario de almacenamiento se estimará de acuerdo al volúmen de datos a manejar, incluyendo el histórico a mantener en forma constante.
  • Java Runtime Environment (JRE) 1.8.  

    La versión de Java debe ser de 64 bits y NO de 32 bits.

  • Runtime NodeJS 16 o superior.

Requerimientos de Hardware


  • El Hardware requerido para una instalación de Bridge se deberá estimar en cada caso, de acuerdo a la cantidad de Tiendas/Estaciones, Terminales y Transacciones (anuales).
    Por instalaciones que requieren de RabbitMQ 

Recomendación: 

  • Depende la estimación de requerimiento en cuanto a la carga, si, es la versión 3.8 de RabbitMQ (no importa la revisión)
  • Sugerencia de memoria disponible: precisa de 4GB y disco libre de 16 GB” 

BMT (Servidor de Tienda)

Tiendas con más de 4 terminales deberán contar con un servidor de Tienda


Plataformas Soportadas


  • SUSE
  • CENTOS
  • UBUNTU 18


Requerimientos de Software


  • Base de Datos: MongoDB 4.2 o superior. El espacio necesario de almacenamiento se estimará de acuerdo al volúmen de datos a manejar, incluyendo el histórico a mantener en forma constante.
  • Java Runtime Environment (JRE) 1.8. La versión de Java debe ser de 64 bits y NO de 32 bits.
  • Runtime NodeJS 16 o superior.


Requerimientos de Hardware

  • El Hardware requerido para una instalación de Bridge se deberá estimar en cada caso, de acuerdo a la cantidad de Tiendas/Estaciones, Terminales y Transacciones (anuales).

Importante: los siguientes recursos, deberán ser dedicados a Bridge, es decir, NO son del sistema operativo, ya que podrían estar en ejecución otras aplicaciones también.


  • Memoria RAM: 16Gb (mínimo para BMT), 32Gb (mínimo para BMC)
  • La base de datos (MongoDB), se estimará de acuerdo al volumen de datos a manejar, incluyendo el histórico a mantener en forma constante.
  • CPU: Intel i7 o procesador de similares características para BMT, i7 para BMC.
  • Capacidad de almacenamiento en Disco Rígido: 1Tb o superior.





BM - Instalación

Modos de instalación

  • Interactiva: solicita información para la configuración inicial del sistema. Dependiendo de si el entorno en el que se ejecute el instalador tiene interfaz gráfica o no, al iniciarse detecta si puede correr en modo gráfico caso contrario, se corre en modo texto.
    • Gráfico: a través de un wizard que presenta una serie de pantallas en donde se debe completar la información solicitada.
    • No gráfico: en modo texto.
  • Silenciosa: este modo es posible en caso de haber existido una instalación previa, tomando la configuración existente como base.


Requisitos iniciales

Para poder realizar la instalación se requiere:

  1. Disponer del instalador: archivo de nombre bridge-manager-installer-{version}.jar, donde {versión} es el número de versión del producto.
  2. JRE: chequear que se encuentre correctamente configurado el componente JDK en la variable de entorno JAVA_HOME.
  3. Asegurar la disponibilidad de los puertos donde escuchará Bridge: al seleccionarse un puerto, por ejemplo, 8080, se requiere que además estén disponibles los puertos: 8180 y 8280.
  4. Evitar que el nombre de la máquina o equipo donde se instalará Bridge Manager tenga un guión bajo ("_") en su nombre, porque queda inaccesible (o en su defecto configurar por su IP, si la misma fuera fija).

NOTA: en caso de que no permita definir la variable del sistema JAVA_HOME, verificar si no es requerida su definición adicional como variable de usuario

  • Si la versión de JRE fuera la JavaSetup8u261 o superior, pudiera no crearse el jre y jdk debiendo utilizar una versión previa


Base de datos

Bridge Manager trabaja con una base de datos MongoDB 4.2.6, por lo cual se requiere que no exista en el servidor donde se instala Bridge Manager, una versión previa.

La base puede localizarse en el mismo servidor que Bridge Manager o no:

  • Mismo servidor: al momento de la instalación de Bridge Manager se instalará automáticamente MongoDB si no existiera y se creará la base.
  • Servidor distinto: requiere que se instale manualmente MongoDB 4.2.6 (o superior):
    • Configuración en modo "Replica Set"  (REQUERIDO)
    • Configurado para que sea accesible desde el servidor donde se instale Bridge POS
    • Si es con seguridad: con un usuario "admin" (con contraseña "Nosotros123") con acceso “root” en la base “admin”.
    • Un usuario (cuyo nombre y contraseña se deberá indicar en la instalación) en la base “admin”, con permiso “dbOwner” sobre la base que se indicará crear en la instalación.

Por otro lado, si MongoDB ya se encontrara instalado y con seguridad es requerido que exista uno de los siguientes usuarios:

    • usuario "admin" con contraseña "Nosotros123" con acceso “root” en la base “admin”.
    • un usuario (cuyo nombre y contraseña se deberá indicar en la instalación) con permiso “dbOwner” para la base que se indicará crear en la instalación de Bridge POS.

 

COMANDOS DE MONGODB

El servicio de Mongo debe encontrarse detenido y luego reiniciado.

Para utilizar estos comandos hay que posicionarse en la ruta de instalación de mongo en la carpeta: \MongoDB\Server\4.2\bin

Abrir un CMD y ejecutar mongo.exe (Si se ejecuta mongo.exe directamente desde el explorador de archivos también abrirá la consola)

> use adminpara cambiar a la BD admin


switched to db admin

Para poder crear el usuario es necesario que el archivo mongod.cfg tenga configurada la seguridad

security:

authorization: "enabled"


> db.createUser({user:'admin',pwd:'Nosotros123',roles:['root']}) – para crear el usuario en la base admin

Successfully added user: { "user" : "admin", "roles" : [ "root" ] }

> db.createUser({user:'bridge',pwd:'nosotros',roles:[{role:'dbOwner',db:'bridgeOffline'}]})para crear el usuario en la base a utilizar con BRIDGE POS offline

Successfully added user: {

"user" : "bridge",

"roles" : [

{

"role" : "dbOwner",

"db" : "bridgeOffline"

}

]

}

> exit

bye

 

  • Luego de parametrizar la seguridad -> Autenticarse


db.auth('admin','Nosotros123') – para autenticarse con el usuario admin


  • Detener el servicio
  • Agregar linea de replicaset (Ver Configuracion de ReplicaSet)

replication:
replSetName: 'rs'

  • Reiniciar servicio
  • Autenticarse

db.auth('admin','Nosotros123') – para autenticarse con el usuario admin

  • Ejecutar

> rs.initiate() – para configurar la base de datos en modo replicaSet

> rs.config() – para verificar configuración de replicaSet


Configuración en modo ReplicaSet:

En la barra de búsqueda de Windows buscar "SERVICIOS", ingresar a la herramienta y localizar MongoDB Server (MongoDB). Veremos en la esquina superior izquierda las opciones "DETENER EL SERVICIO" y "REINICIAR EL SERVICIO". Ejecutar la opción DETENER.

 

En el explorador de archivos localizar y abrir al archivo MONGOD.CFG(C:\Program Files\MongoDB\Server\4.2\bin\mongod.cfg) como administrador (en caso de que el sistema no muestre la opción, copiar el archivo en otra ubicación), abrirlo como un .txt con el bloc de notas para su edición.

Una vez hecho esto, posicionarnos en la fila donde se encuentra el texto al inicio "#replication:  y realizar las siguientes modificaciones:

- borrar el " # " numeral y agregar debajo con una sangría de dos espacios, el texto " replSetName: 'rs' ", quedando de la siguiente forma:

 

replication:

  replSetName: 'rs'


Guardar la edición y copiar nuevamente el archivo en su ubicación original. El sistema solicitará permisos de admin para reemplazar el archivo, aceptar.

El paso siguiente es ejecutar el archivo MONGO.EXE localizado en la misma carpeta en la cual acabamos de editar el archivo MONGOD.CFG. Se abrirá la consola en la cual nos loguearemos como se ha explicado anteriormente (use admin ; db.auth('admin','Nosotros123')) y ejecutaremos los siguientes comandos:

 

> rs.initiate() – para configurar la base de datos en modo replicaSet

 

> rs.config() – para verificar configuración de replicaSet

 

Una vez hecho esto, volver a la herramienta "SERVICIOS", y presionar "REINICIAR EL SERVICIO" MongoDB Server (MongoDB).


NOTA: para acceder a la base de datos se podrá utilizar aplicaciones como Robo 3T o Studio 3T








BM - Instalación interactiva (Wizard)


IMPORTANTE

Bridge Manager cuenta con un usuario considerado como super usuario con todos los permisos.

usuario: suser,

contraseña: suser123

Este usuario no debería ser utilizado por el retailer sino por soporte interno de Napse. Para tal fin luego de la instalación se debería crear un usuario administrador propio para que utilice el retailer.


Si posee permisos de administrador del servidor puede iniciar la instalación haciendo doble click en el archivo instalador.

Si se realiza este paso y no tuviera permisos, se recibe el siguiente mensaje y no permite continuar la instalación.


Si no tuviera permisos de administrador, se necesita abrir la ventana de línea de comando en modo administrador:



Navegar hasta el directorio en donde se encuentre el archivo instalador.

Desde ese directorio, ejecutar el siguiente comando, indicando el nombre del archivo instalador disponible:

java –jar bridge-manager-installer-{version}.jar

Ejemplo: c:\Descargas\java –jar bridge-manager-installer-7.0.0.jar

En el caso de que se quiera forzar el idioma del instalador al español, agregar el parámetro del idioma: java -jar -Duser.language=es bridge-manager-installer-7.0.0.jar

Al ejecutar el instalador, comenzará a extraer los archivos necesarios para la instalación.

Paso a paso

Luego de la extracción de los archivos, se presentan una serie de pantallas donde son requeridos datos para completar la instalación.

En caso de requerir cancelar el proceso de instalación en cualquiera de las pantallas, se debe presionar el botón "Cancelar".

A continuación se presentan cada una y se detalla la información requerida.

(1) Paso: Opciones de instalación obligatorias


Completar:

  • Directorio de instalación: indicar el directorio en que se desee ubicar los archivos de la instalación. Puede ser un directorio nuevo o uno existente.
  • Directorio Java: se debe configurar con el directorio en el cual se encuentra instalada la máquina virtual de Java (INCLUYENDO el directorio bin dentro del directorio a configurar). Por ejemplo: c:\JDK\bin.
  • Host donde se está instalando Bridge Manager: se debe configurar la dirección IP o el nombre del server dentro del dominio de red (no localhost, el host en minúsculas).
  • Puerto de escucha del servidor: el puerto por defecto es el 8080, pero también se podrán optar por otros dentro de la lista de selección desplegable. Otras aplicaciones que se encuentren en el mismo servidor, no deben utilizar el mismo puerto que se desea configurar (por ejemplo si el Bridge Manager Central se encuentra instalado en el mismo servidor que Bridge Manager Tienda, ambos deberán instalarse en puertos diferentes) Se validará que no se encuentre en uso al momento de la instalación
    • 8080
    • 8180
    • 8280
    • 8380
  • Ubicación archivo client.zip: Este archivo contiene imágenes y recursos para un cliente en particular. 

Nota importante:

  • Directorio de instalación: si en el mismo servidor donde se instaló Bridge Manager Central se instalará Bridge Manager tienda, tener en cuenta la tienda se instale en un directorio diferente al definido para Central.
    • Ej:
      • c:\napse\bridge_Central
      • c:\napse\bridge_tienda1


Nota: si el directorio no existe, se informará con un mensaje.

  • Si confirma se crea el directorio, si no continúa sin crearlo

(2) Paso: Componentes a instalar


Completar:

  • Ubicación URL de Director: ruta de la ubicación URL de Director.
  • Tipo de instalación: de acuerdo al tipo de instalación solicitará distintas configuraciones posteriormente (tienda o central)
  • Integración con Teampleace: por defecto estará seteado en NO.

(3) Paso: Configuración de la base de datos de Bridge Manager - BM Central

En el caso de haber seleccionado Tipo de instalación = Central, solicita la siguiente información para la creación de la base de datos.


En el caso de que la base de datos indicada no exista, se creará y se creará el usuario con la contraseña indicada.

Completar:

  • Host de la base de datos: dirección IP del servidor de base de datos o el nombre del host (localhost en el caso en el cual resida en el mismo servidor) en donde se desee crear la base de datos o donde reside la base de datos existente.
  • Puerto de la base de datos: por defecto es el puerto 27017.
  • Nombre de la Base de datos: identificador de la base de datos existente, o se debe indicar el nombre con el que se desee crear la base.
  • Usuario de la base de datos: usuario de la base de datos existente o indicar un usuario a ser creado.
  • Contraseña de la base de datos: clave del usuario de la base de datos existente  o indicar la contraseña para el usuario indicado.
  • Mecanismo de autentificación: usuario contraseña (default) o por LDAP
  • Seleccione el conjunto de Datos de Central: país donde se instalara el sistema: 
    • Argentina
    • Uruguay
    • México
    • Honduras
    • Colombia
    • Chile (a partir de v7.3)

Utilizando de la opción "Verificar conexión con la base de datos" se pueden corroborar los datos ingresados, en caso de que exista la base de datos.

NOTA: los nombres de los hosts deben ser ingresados en letra minúscula

(3.b) Paso: Configuración de la base de datos de Bridge Manager - BM Tienda

En el caso de haber seleccionado Tipo de instalación = Tienda, solicita la siguiente información para la creación de la base de datos.

++ La base de datos de la Tienda tiene que ser diferente a la base de datos del Central ++ (si se instala en el mismo servidor de base de datos)


En el caso de que la base de datos indicada no exista, se creará y se creará el usuario con la contraseña indicada.

Además de los datos solicitados para Central, solicita completar:

  • Código de la tienda: indicar el código que se le asignará a la tienda. Este código será el que se requerirá al instalar los POS de la tienda. Debe ser único.
  • Nombre de la tienda: nombre de fantasía.

En caso de instalar la tienda en el mismo servidor que Central, se pueden:

  • Indicar los datos del usuario creado al instalar central (tener en cuenta que la contraseña será la existente): asignará permisos al usuario para operar sobre la nueva base.
  • Indicar un nombre de usuario/contraseña nuevo: creará un nuevo usuario en la BBDD.

Utilizando de la opción "Verificar conexión con la base de datos" se pueden corroborar los datos ingresados, en caso de que exista la base de datos.

NOTA: los nombres de los hosts deben ser ingresados en letra minúscula

(3.c) Paso: Bridge Manager config - BM Tienda

En el caso de haber seleccionado Tipo de instalación = Tienda, solicita la siguiente información para conectarse con el Bridge Manager Central.

Completar:

  • Protocolo: se podrá indicar si es con protocolo de seguridad o no (http o https)

  • Hostname del Central: dirección IP del servidor o el nombre del host donde se encuentra instalado el central.
  • Puerto del BM Central: puerto indicado en el paso "Opciones de instalación obligatorias" al instalar el central.
  • Puerto de Bridge Api Central: puerto de central, pero finalizado en 1. Por ejemplo, si el puerto de BMC era 8080, el de API se crea automáticamente en 8081.
  • Puerto de Bridge Core Central: puerto de central, pero finalizado en 2. Por ejemplo, si el puerto de BMC era 8080, el de API se crea automáticamente en 8081.
  • Url de Promo: para permitir la conexión con PROMO.

NOTA: los nombres de los hosts deben ser ingresados en letra minúscula

(4) Paso: Configuración algoritmo de Hashing de Contraseñas


Completar:

  • El archivo que se podrá seleccionar tiene algunas particularidades, a saber:
    • Nombre: scripts.zip (debe tener exactamente ese nombre y ser del tipo .zip)
    • Contenido del archivo scripts.zip  
      • a) Pueden ser archivos que permiten la ejecución de sentencias sobre la base de datos de Mongo
      • b) Pueden ser archivos json de colecciones a importar 
      • Ambos pudieran convivir dentro del mismo .zip (ver detalle en anexo)
  • Luego de seleccionar el archivo con el botón "Siguiente" continuará con la instalación


En el caso en el cual se haya incluido un archivo scripts.zip, se informará como uno de los pasos. 

  • En el paso clientScripts → se crea la tarea offline para la importación de tablas exportadas

  • Dependiendo de los archivos contenidos:
    • Los UPDATE, DELETE, INSERT.json
      • Estas sentencias se ejecutan como parte del proceso de instalación directo en la base de datos de la instalación. No tienen un orden estricto de ejecución sino que es aleatorio. 
      • NOTA: tener en consideración esto porque si luego en la replicación de maestros se enviaran registros que ya fueron impactados por algún update o insert, estos pudieran verse sobre escritos. 
    • Con los archivos que corresponden a Json de colecciones de Mongo, se creará una tarea offline para la importación de las tablas exportadas. 
      • Esto será posterior a la instalación 
      • Luego al instalar, como último paso se va a crear una tarea offline para la importación de dicho archivo (Borrando los datos de las tablas creadas por producto y remplazándola por las tablas que figuren en el ZIP)
      • Se puede comprobar ingresando al BM instalado, que se generó y ejecutó la tarea offline

image2022-9-23_16-35-55.png

  • Y verificar que los datos importados impactan en la instalación realizada.
  • En el ejemplo se modifica el nombre del ítem Anticipo, y se exporta la colección 'Item'



(5) Paso: Progreso de la instalación

Una vez completada toda la información de los pasos anteriores se accede a esta pantalla final.

También se acceda a esta pantalla en caso de NO haber tildado la opción de aceptación de términos y condiciones.

Seleccionar "Instalar" para iniciar la instalación.


Durante la instalación informa el progreso de la siguiente manera:

Durante y post instalación, al presionar "Enseñar det..." permite ver el log de la instalación y el detalle de los errores.


En caso de estar realizando una instalación de una tienda, se conecta automáticamente al central y se descarga todos los datos maestros requeridos.

Al finalizar la instalación informa:

(aviso) Al finalizar la instalación se debe verificar en la salida informada (solapa "salida"):

1) que no haya habido errores

2) que todos los logs de respuesta "ack" tengan código 0, por ejemplo: {"ack":0}


NOTA: En cualquier pantalla del instalador podrá solicitar la cancelación de la instalación con el botón "Cancelar".


BM - Instalación silenciosa

En esta modalidad de instalación, se puede pre configurar mediante un archivo de configuración, para que el instalador tome los valores precargados y no sean solicitados en forma interactiva con las diferentes pantallas gráficas del instalador estándar.

El archivo de configuración ant.install.properties que se haya generado de una instalación previa, podrá ser utilizado de base para próximas instalaciones ajustando aquellos parámetros requeridos para una nueva instalación tomando estos como parámetros por defecto.

A continuación se detallan los pasos para ejecutar este tipo de instalación.


Paso: Configurar parámetros

Para modificar los parámetros de la instalación se debe editar el archivo ant.install.properties que se encuentra en la carpeta en donde se encuentra el instalador.

Tomar el archivo correspondiente a la instalación que se quiere realizar (central o tienda, cada uno tiene su propio archivo).

PasoPropiedadant.install.propertiesValores

Términos y condiciones de uso (2/2)


Acepto los términos y condiciones de usolicense.acceptedtrue/false

Nombre completolicense.name

Correo electrónicolicense.email

Opciones de instalación obligatorias


Directorio de instalación

installDir



Directorio Java

javaH



Host donde se está instalando Bridge Manager

env.HOSTNAME



Puerto de escucha del servidor

ruleWebservicePos.host = NTK-NOELIAC
jbossPort =


Componentes a instalar


Archivo de configuración

config

true/false

Tipo de instalación

installType

  • central

Configuración de la base de datos de Bridge Manager - BM Central


Host de la base de datos

datasource.dbhost



Puerto de la base de datos

datasource.dbport



Nombre de la Base de datos

datasource.dbname



Usuario de la base de datos

datasource.username



Contraseña de la base de datos

#datasource.password


Configuración de la base de datos de Bridge Manager - BM Tienda


Host de la base de datos

datasource.dbhost



Puerto de la base de datos

datasource.dbport



Nombre de la Base de datos

datasource.dbname



Usuario de la base de datos

datasource.username



Contraseña de la base de datos

#datasource.password



Código de la tienda

storeCode



Nombre de la tienda

storeName


Bridge Manager config - BM Tienda


Hostname del Central

centralHost



Puerto del BM Central

centralPort



Puerto de Bridge Api Central

centralPortApi



Puerto de Bridge Core Central

centralPortBridgecore



Url de Promo

urlPromo


Configuración algoritmo de Hashing de Contraseñas


Algoritmoencryption
  • SHA-1

  • md5

Paso: Ejecutar instalación

Copiar el archivo en el directorio donde se encuentra el instalador y desde donde se ejecutará el mismo en modalidad silencioso.

Para iniciar la instalación, abrir la ventana de línea de comando en modo administrador:

Navegar hasta el directorio en donde se encuentre el archivo instalador.

Desde ese directorio, ejecutar el siguiente comando, indicando el nombre del archivo instalador disponible:

java –jar bridge-manager-installer-{version}.jar text-auto

Ejemplo: c:\Descargas\java –jar bridge-manager-installer-7.0.0-SNAPSHOT.jar text.auto

Se descomprimirá el archivo informando en la ventana de comando "Loading self extractor…" abriéndose un popUp donde irá informando el avance.

A medida que el instalador va ejecutando sus pasos, se irán informando en la ventana de comandos.

Al finalizar la instalación se informará en la ventana de comando como "Terminado"

BM - Resultado de la instalación


Log de proceso de instalación

El registro del log de la instalación se puede encontrar en el archivo ant.install.log, ubicado en el directorio del instalador.

Allí se puede acceder al detalle de toda la operatoria realizada al momento de la instalación.e

Log de configuración de instalación

Luego de haber completado el proceso de instalación, junto al archivo instalador, se podrá encontrar el archivo ant.install.properties en donde se encuentra detallada toda la configuración seleccionada durante la instalación y puede utilizarse en una instalación silenciosa.

Base de datos

Luego de la instalación se contará con el servidor de base de datos instalado (en caso de que no existiera previamente) de MongoDB con dos bases de datos:

  • "admin":
    • Se puede acceder con usuario "admin" con contraseña "Nosotros123", el cual posee permiso root.
    • Contiene los usuarios que pueden acceder a la base.
  • con datos de Bridge manager (con el nombre indicado en la instalación):
    • Se puede acceder con el usuario/contraseña indicado en la instalación.
    • Aqui residirán los datos maestros, configuraciones y datos transaccionales de la aplicación. En caso de una base de Tienda, contará con todos los datos maestros, importados automáticamente de central durante la instalación.

Servicios del sistema

Terminado el proceso de instalación, podrá chequearse en los servicios del sistema la existencia de nuevos servicios que ya estarán ejecutandose de manera automática, lo cual permite indicar la correcta instalación y puesta en funcionamiento:

  • MongoDB Server (MongoDB)
  • NapseBridgeApi_xxx: siendo xxx el nombre de la base de datos.
  • NapseBridgeCore_xxx: siendo xxx el nombre de la base de datos.
  • NapseBridgeManager_xxx: siendo xxx el nombre de la base de datos.


Ejemplo

Estructura de directorios

Luego de haber completado el proceso de instalación, quedará una estructura de directorios similar a la siguiente en el directorio de instalación:

  • bridgeapi
  • bridgecore
  • bridgemanager
    • log: contiene los archivos logs de la aplicación Bridge Manager.

Ejemplo de estructura de una instalación en Windows, realizada en el directorio BMT:

Datos maestros

Al finalizar la instalación de un Bridge Manager en modalidad Tienda, se importan del Central los datos maestros.

Desde la consola de administración, opción Monitoreo> Monitor de Importación se puede visualizar los errores que pudieron haberse generado durante la importación.




BM - Ejecución del sistema


Consola de administración

Al finalizar la instalación quedan automáticamente ejecutándose los servicios que hacen que esté disponible la consola de administración.

Para acceder, ingresar en un navegador web el nombre del servidor y el puerto indicado en la instalación. ej: http://10.4.201.54:8180/

Se accede a la pantalla de login:


NOTA: si la aplicación BRIDGE MANAGER no levanta automáticamente luego de la instalación, REINICIAR los servicios del sistema

Ejemplo:

(aviso) En caso de que se requiera inactivar la aplicación se deben detener los servicios (Ver: BM - Resultado de la instalación, sección Servicios).


NOTA: para el login el super usuario: suser, contraseña: suser123

Este usuario no debería ser utilizado por el retailer sino por soporte interno de Napse. Para tal fin de se aconseja crear un usuario administrador propio para que utilice el retailer.




Versión de Bridge Manager

Para poder identificar la versión de Bridge Manager se podrá hacer doble click sobre el texto que se encuentra en el área superior derecha de la pantalla. Se abrirá un popUp indicando la versión y fecha de Bridge Manager como de Bridge API


En el ejemplo, la versión de Bridge Manager es la compilación 554 del día 22/02/2022 y la de API compilación 1059 del día 22/02/2022 






BM - Desinstalación

Detalle de los pasos a realizar para desinstalar la aplicación.


Paso: Dar de baja los servicios

Para iniciar la desinstalación, abrir la ventana de línea de comando en modo administrador:

Navegar hasta el directorio en donde se haya realizado la instalación.

Se dispone de un desintalador por componente instalado, correspondiente a una carpeta.

Desde cada una de las carpetas ejecutar su desinstalador indicando: removeService.bat

De esta forma, se irán dando de baja los servicios que se encuentran ejecutándose.

Ejemplo:

Si la instalación del BM Central fue en el siguiente directorio C:\Users\carla.escalera\AMBIENTES\BRIDGE71\BMC

En cada una de las siguientes carpetas se instalará un removeService.bat

  • bridgeapi
  • bridgecore
  • bridgemanager

Para eliminar el servicio se deberá ir hasta dicha carpeta y ejecutar el removeService.bat

El ejecutarse se cerrará en forma automática la ventana de cmd y se eliminará el servicio.

Paso: Base de datos

Se requiere remover manualmente las bases de datos creadas en la instalación.

En el caso de no utilizar el motor de base de datos para otros fines, se sugiere desinstalarla:

2) Desinstalar MongoDB (desde la opción del sistema operativo para quitar aplicaciones).

3) Borrar la carpeta donde se encuentra instalado MongoDB, dado que mantiene configuraciones previas y no se elimina automáticamente al desintalar.

Paso: Eliminar archivos

Eliminar manualmente los archivos que se generaron en el directorio de instalación.



BM - Configuraciones

Luego de haber realizado la instalación de la aplicación Bridge Manager, puede ser requerido algún cambio en los parámetros de configuración o ajustar algún parámetro por default del sistema.


Base de datos

La modificación de los datos de acceso a la base de datos se realiza desde cada uno de los componentes de Bridge Manager, en el directorio de instalación.

Para que sea tomada la nueva configuración se requiere reiniciar los servicios. (Ver BM - Resultado de la instalación> Servicios)


API

Core

Manager

Archivobridgeapi> config> default.jsonbridgecore> hibernate.cfg.xmlbridgemanager> start.bat
Host

 "app"> "db" > "mongoUrl:

mongodb://USUARIO:CONTRASEÑA@HOST:PUERTO/NOMBRE?authSource=admin

hibernate.ogm.datastore.hostSERVERDB=localhost
Puerto

 "app"> "db" > "mongoUrl:

mongodb://USUARIO:CONTRASEÑA@HOST:PUERTO/NOMBRE?authSource=admin
hibernate.ogm.datastore.portDBPORT=27017
Nombre

 

 "app"> "db" > "mongoUrl:

mongodb://USUARIO:CONTRASEÑA@HOST:PUERTO/NOMBRE?authSource=admin

hibernate.ogm.datastore.databaseDBNAME=BBDDcentralNOE
Usuario

 "app"> "db" > "mongoUrl:

mongodb://USUARIO:CONTRASEÑA@HOST:PUERTO/NOMBRE?authSource=admin
connection.usernameDBUSER=adminnoe
Contraseña

 "app"> "db" > "mongoUrl:

mongodb://USUARIO:CONTRASEÑA@HOST:PUERTO/NOMBRE?authSource=admin
connection.password

DBPWD=nosotros

Configuración de logs

La política de logeo es propia e independiente de cada componente de Bridge:

Manager (consola)

  • Genera 1 archivo por día de hasta 10MB, superado ese tamaño, genera un nuevo archivo con un secuencial.
  • Almacena hasta 60 archivos o 20GB.
  • No es configurable

CORE

El archivo log4j.xml es el archivo que contiene la configuración de los archivos log, ubicado en el directorio directorio de instalación\bridgecore\config

En este archivo se puede modificar la configuración de:

  • Directorio de logs: en el parámetro File se podrá configurar/modificar el directorio donde se grabarán los archivos logs.
  • Nombre del archivo de log:
    • Por defecto está definido como: log.YYYY-MM-DD
    • Se define en el parámetro File
  • Nivel de log
    • Se puede configurar/modificar con qué nivel de detalle se registrarán las excepciones en el archivo de log.
    • Los niveles de log soportados son, en orden descendente:
      1. ALL
      2. DEBUG
      3. INFO
      4. WARN
      5. ERROR
      6. FATAL
      7. OFF
      8. TRACE

API

Puede modificarse la configuración del nivel de loggueo desde bridgeapi\config\default.json

Replicación

De Central a Tiendas

La colección ImportTypePriority detalla las entidades que se reciben desde sistemas externos y si se deben replicar a las tiendas o no.

Para la entidad requerida (dataFileType), setear en false el atributo que indica si debe replicarse (replicateOnWizard) en la base de Central.

De Tienda a Central

REPLICACIÓN POR TIPOS DE TRANSACCIONES DE TIENDA A CENTRAL

La colección TransactionSubType contiene el detalle de los tipos de transacciones existentes.

Allí se puede definir a través del flag mustReplicate (tipo boolean) si el mismo debe replicarse de tienda a central. 




BM - Mantenimiento


Archivos de logs

Para poder analizar determinados comportamientos de la aplicación, se registran los archivos logs en los cuales se podrá obtener información que permita diagnosticar diversos problemas que pudieran generarse en la operación diaria de tienda o en Central.

El sistema genera archivos por componente (api, core, bridge consola), los cuales se ubican dentro de la carpeta "log" de la carpeta de cada componente, dentro del directorio de instalación.

Por ejemplo, para API tenemos los archivos de log en:

directorio instalación\bridgeapi\log

Todos los archivos de logs pueden eliminarse sin afectar el comportamiento de la aplicación.

Procesos de depuración

Para liberar espacio, periódicamente se depuran los datos de la base de datos de tienda y de central.

Desde la consolta de administración del BM en la sección Configuración> Sistema, seleccionando la opción Tienda y luego depuración, se pueden configurar el tiempo que se mantendrá la información de las entidades a ser depuradas, en el paramétro:

  • Cant. de días en los que se guardan los reg. de importación/replicación procesados correctamente (id store.ImportDepurationDays)
  • Cant. de períodos en los que se guardan transacciones (id store.periodDepurationQty)

Las entidades que se depuran son:

  • Replicación de datos:
    1. DataReplication
    2. DataReplicationResult
    3. DataImport
    4. DataExport
  • Transacciones:
    1. Transaction
    2. TransactionRetail
    3. TransactionRetailItem
    4. TransactionRetailPayment
  • Negocio:
    1. BusinessDay
    2. CalendarPeriod
    3. SubordinatedPeriod
  • Acumuladas:
    1. TillHistory
    2. TillTenderHistory
    3. TillSecondaryHistory
    4. TillSecondaryTenderHistory
    5. ItemSalesSummary
    6. StoreHistory
    7. StoreTenderHistory
    8. ItemStockSummary
  • Stock:
    1. ItemInventoryJournalEntry
    2. ItemReservedJournalEntry





BM - Troubleshooting

A continuación se presentan una serie de problemas que pueden ocurrir durante la instalación y las soluciones frecuentes.


Error: Errores durante la instalación

En general, lor problemas durante la instalación corresponde a problemas con compatibilidad de la base de datos (en caso de haber una base previa).

Se recomienda realizar una desintalación de la aplicación, incluyendo la desinstalación de la base de datos (ver: BM - Desinstalación).

Error: No se observa la pantalla de login de la consola de administración

Si al conectarse desde un browser, no se observa la primer pantalla de inicio de sesión de usuario lo más probable es que se ha generado algún error en la instalación. Verifique el archivo con el log de la instalación como primer paso.

Puede deberse a que se haya iniciado la aplicación antes de haber finalizado la instalación y configuración de la base de datos. En este caso, se deberá reiniciar los servicios (Ver: BM - Resultado de la instalación, sección Servicios) y para asegurarse de que se hayan levantado, verificar en el log de bridge manager (ubicado en bridgemanager\log) que se encuentre levantado tomcat (buscar "Tomcat started on port(s)").


Error: No se puede conectar a la consola de MongoDB


Si al abrir la consola de MongoDB, da el siguiente error:


es porque falta la autenticación del usuario admin

Los pasos a seguir son:


  •  El servicio de Mongo debe encontrarse detenido y luego reiniciado
  • Abrir un CMD y ejecutar mongo.exe (Si se ejecuta mongo.exe directamente desde el explorador de archivos también abrirá la consola)

> use admin – para cambiar a la BD admin

switched to db admin


  • Para poder crear el usuario es necesario que el archivo mongod.cfg tenga configurada la seguridad

security:

authorization: "enabled"

 

 > db.createUser({user:'admin',pwd:'Nosotros123',roles:['root']}) – para crear el usuario en la base admin

Successfully added user: { "user" : "admin", "roles" : [ "root" ] }

 

> db.createUser({user:'bridge',pwd:'nosotros',roles:[{role:'dbOwner',db:'bridgeOffline'}]}) – para crear el usuario en la base a utilizar con BRIDGE POS offline

Successfully added user: {

"user" : "bridge",

"roles" : [

{

"role" : "dbOwner",

"db" : "bridgeOffline"

}

]

}

> exit

bye


  • Luego de parametrizar la seguridad -> Autenticarse

db.auth('admin','Nosotros123') – para autenticarse con el usuario admin ---- > Este paso es importante sino da el error comentado arriba

 

  • Detener el servicio
  •  Agregar  replicaset (Ver Configuracion de ReplicaSet)

replication:

replSetName: 'rs'


  • Reiniciar servicio
  •  Autenticarse

db.auth('admin','Nosotros123') – para autenticarse con el usuario admin ---- > Este paso es importante sino da el error comentado arriba


  • Ejecutar desde la consola

> rs.initiate() – para configurar la base de datos en modo replicaSet

> rs.config() – para verificar configuración de replicaSet




Luego de esta forma, debe poder accederse a la consola de MongoDB correctamente







Anexo


Configuración de variable JAVA_HOME


La variable Java Home, generalmente escrita como JAVA_HOME se configura en la ruta de instalación de Java. Los pasos para configurar JAVA_HOME en Windows:


Paso 1:

Asumiendo que la ruta para el Kit de Desarrollo de Java durante la instalación no cambie, estará en la ruta:

 C:\Program Files\Java.

Esta ruta tendrá el JRE. Supongamos que tiene JDK1.8.0_25. Entonces la ruta de instalación es:

C:\Program Files\Java\JDK1.8.0_25

Esta ruta va a ser la que vamos a utilizar para configurar la maquina virtual de JAVA. (Paso 2.3)



Paso 2:


2.1: Abrir  “Configuración Avanzada del Sistema”.


2.2: Seleccionar “Variables de Entorno”.



Se abrirá este PopUp de “Variables de Entorno”:


2.3: Seleccionamos “Nueva” y abrirá una pequeña sección de configuración en donde agregamos los valores:

Name: JAVA_HOME

Variable value: C:\Program Files\Java\jdk.8.0_25

(siendo esta la ruta que copiamos en el Paso 1)


Paso 3:

Una vez realizada esta operacion, debemos agregar el BIM a su Path para que pueda ser ejecutado.

3.1 En la misma ventana de “Variables de Entorno” seleccionamos “Path” y lo editamos.



3.2 Agregamos el Path “  %JAVA_HOME%\bin ” y lo dejamos en primer lugar de ejecución.






Contenido del archivo scripts.zip

Ejemplo de archivo y contenido: scripts.zip

A continuación se detalla mayor información sobre los tipos de archivos contenidos como personalización de una instalación 

  • Ambos pudieran convivir dentro del mismo .zip

Archivos que permiten la ejecución de sentencias sobre la base de datos de Mongo

a) Los tipos de sentencias que se pueden ejecutar son:

  • UPDATE
  • DELETE
  • INSERT


b) Nombre de los archivos:

SENTENCIA_NombreDeCollection.json

  • El nombre de la tabla o collection debe ser exactamente el mismo del modelo de datos de Mongo.


Ejemplo de como deben ser los nombres de los archivos:



c) Contenido ejemplo de cada archivo/sentencia 

  • Los json deben encontrarse bajo mongoExportFormat (el utilizado por API)
  • NO es válido en simpleFormat

INSERT_SystemProperty

  • Registros a insertar con todos sus datos  de la tabla mencionada en el titulo del archivo

INSERT

[
  { "_id" : { "$oid" : "630e187fb981e12b64a99aad" }, "key" : "prop1", "name" : "Central: se encuentra habilitado el depurador MODIFICADO", "description" : "Central: se encuentra habilitado el depurador", "propertyCategory" : { "$oid" : "5ea556535604c8593c60272c" }, "propertyModule" : { "$oid" : "5ea556535604c8593c60273d" }, "propertyType" : { "$oid" : "5ea556535604c8593c60273f" }, "createdAt" : { "$date" : "2021-08-12T11:20:37.020+0000" }, "updatedAt" : { "$date" : "2021-08-12T11:20:37.020+0000" }, "version" : 0 },
  { "_id" : { "$oid" : "630e187fb981e12b64a99aae" }, "key" : "prop2", "name" : "Central: información de importación y replicación (DataReplication y DataImport). Cantidad de dias que NO depura.", "description" : "Central: información de importación y replicación (DataReplication y DataImport). Cantidad de dias que NO depura.", "propertyCategory" : { "$oid" : "5ea556535604c8593c60272c" }, "propertyModule" : { "$oid" : "5ea556535604c8593c60273d" }, "propertyType" : { "$oid" : "5ea556535604c8593c602740" }, "createdAt" : { "$date" : "2021-08-12T11:20:37.027+0000" }, "updatedAt" : { "$date" : "2021-08-12T11:20:37.027+0000" }, "version" : 0 }
]

UPDATE_SystemProperty

  • El archivo UPDATE es un JSON donde cada línea tiene el WHERE y el SET para cada modificación de registros que queramos modificar con respecto a la instalación que deja producto.
    • Registro que se quiere actualizar de la tabla mencionada en el titulo del archivo 
    • Valor con lo que se quiere actualizar el o los atributos particulares de la collection (set)

UPDATE

[
[{"_id" : { "$oid" : "5ea556545604c8593c60274c" }}, {"$set": {"prop":1}}],
[{"_id" : { "$oid" : "5ea556545604c8593c60274d" }}, {"$set": {"prop":2}}]
]


DELETE_SystemProperty

  • El archivo DELETE es un JSON donde cada línea tiene el WHERE que ejecutaría para borrar los registros de la tabla que indique el nombre del archivo
  • Contiene Ids de registros a eliminar de la tabla mencionada en el titulo del archivo o según condición where

DELETE

[
    { "_id" : { "$oid" : "5ea556545604c8593c602757" } },
    { "_id" : { "$oid" : "5ea556545604c8593c602765" } }
]

--------------------------------------------------------

Archivos json de colecciones a importar 

  • Desde el modulo de Configuración → Tareas Offline → "Nueva exportación de tablas" se podrá exportar tablas de un entorno para que puedan ser utilizados en uno nuevo a instalar. 
  • NOTA: deben considerarse tener misma versión de API (para no tener problemas de incompatibilidad de modelo de datos por diferencia en versiones) 
    • Los json deben encontrarse bajo mongoExportFormat (el utilizado por API) NO es válido en simpleFormat


Para utilizar esta funcionalidad los pasos serian:

  • 1) Configurar ambiente con las configuraciones particulares que requiera el proyecto.
  • 2) Ingresar en Configuración → Tareas Offline → "Nueva exportación de tablas" y exportar todas las tablas modificadas. (En el ejemplo se modifica el nombre del ítem Anticipo, y se exporta la colección 'Item')

  • Se accede a la siguiente pantalla