- Criado por Rodrigo Nicolás González em dez 06, 2023
PE - Agente: Instalación con wizard
Versión 1.1
Versión | Fecha | Descripcion | Autor |
---|---|---|---|
1.0 |
| Creación del documento |
1. Objetivo
El objetivo de este documento es ofrecer una guía completa del proceso de instalación del agente de Fiscal Flow en el punto de venta, para poder comunicarse con el servidos de FF para poder operar.
2. Pre-requisitos del Sistema
Previo a la instalación se require verificar y cumplir con los siguientes pre-requisitos del sistema:
2.1 Requerimientos de Software
Detalle de los requisitos mínimos para la utilización del agente en el punto de venta:
- 256 MB de memoria libre para el proceso (agente).
- 512 MB de espacio en disco disponible.
- Sistema operativo:
- Windows 7 en adelante
- Sistema operativo Linux SUSE
- CentOS.
- Node.js
- Java 1.8
2.2 Instalación de Node JS
SISTEMA OPERATIVO WINDOWS:
Ingresar en: Node.js e instalar la opción recomendada (LTS).
La instalación es estandard, es decir, hay que ir presionando siguiente, salvo en este paso en donde hay que marcar la opción, tal como se ve en la siguiente pantalla:
SISTEMA OPERATIVO LINUX:
Antes de continuar con este tutorial, hay que asegurar de haber iniciado sesión como usuario con privilegios de sudo.
- Agregar el repositorio NodeSource yum ejecutar:
- curl -sL https://rpm.nodesource.com/setup_10.x | sudo bash -
Instalar Node.js and npm ejecutar:
sudo yum install nodejs
Para verificar que la instalación de nodejs y npm fue exitosa ejecutar:
node --version (debería informar la versión de node, por ej: v10.13.0)
npm --version (devería informar la versión de npm, por ej: 6.4.1
2.3 Instalación de Java
SISTEMA OPERATIVO WINDOWS:
Ingresar en Java, dirijirse a la seccion Descargas/Downloads y descargar la version estrable y ultima que aparezca.
La instalación es estandard, es decir, hay que ir presionando siguiente.
SISTEMA OPERATIVO LINUX:
Ingresar en Java, descagar la version acorde a sus sistema y seguir los siguientes pasos Java Manual Linux
3. Instalación
Validacion de datos necesarios para la instalacion y paso a paso de la misma
Para realizar la instalación se requiere contar con los siguientes datos:
- URL del servidor de FF del ambiente al que se quiere acceder (test o producción).
- Si se utilizará proxy:
- URL del proxy
- Puerto del proxy
- Si hubo una instalación previa, el directorio de instalación esta utilizado.
- Si lo que se quiere es la reinstalacion pero sin realizar una desinstalacion, tener en cuenta que los datos de las carpetas logs y data no seran modificados.
Paso a paso:
- Abrir una ventana de comandos de DOS en modo administrador.
- Dirigirse al directorio en donde se encuentra el instalador.
Ejecutar el siguiente comando, siendo "fiscalflowagent.exe" el instalador:
java -jar fiscalflowagent.jar Nota: en caso de que el archivo no se llame fiscalflowagent.exe, renombrarlo o cambiar en el comando por el nombre que tiene dicho archivo.
- En este paso, internamente se realiza la validacion de la version de NodeJS instalada en el equipo
- Si la version de NodeJS no es la ultima del tipo LTS mostrara este mensaje
- Si no se tiene instalado NodeJS se mostrara este mensaje
- Si la version de NodeJS no es la ultima del tipo LTS mostrara este mensaje
Al ejecutar esta sentencia, se descomprime el archivo.
Se presentará la pantalla de bienvenida del instalador. Oprimir el botón "Siguiente"
A continuación, se deberá seleccionar el directorio de instalación e ingresar el puerto del servidor WEB con la posibilidad de verificar si la URL ingresada responde correctamente. Caso afirmativa oprimir el botón "Siguiente".
Se muestra ejemplos de mensajes:
Formato no válido:
Servicio no disponible:
Servicio disponible:
IMPORTANTE: Al ingresar la URL del Server de Fiscal Flow no colocar la barra final. Se debe ingresar exactamente como se muestra en la imagen, por ejemplo: http://www.fiscalflow.com.ar o http://10.4.201.52:8100En caso de que el directorio no exista, se ofrecerá crearlo.
En la siguiente pantalla se deberá:
Seleccionar el directorio de Java: Tener en cuenta que se deberá llegar hasta la carpeta bin, tal como muestra la imagen a continuación.
- Ingresar:
- Código de Compañía (sin restriccion de cantidad de caracteres)
- Código de Tienda (sin restriccion de cantidad de caracteres)
- Código de Terminal (sin restriccion de cantidad de caracteres):
- Para modo de integración MULTITERMINAL: Ingrese código 9999
- Puerto del Agente
- Paso siguiente será identificar la IP y Puerto que usa Director Server.
9. Presionar "Instalar" para ejecutar el proceso de instalación
10. Para poder ver los detalles de la instalacion, hacer click en ShowDetails
11. La finalización de la instalación se informa mediante un mensaje de "Terminado". Oprimir "Aceptar".
Presionar el botón "Exit" para salir del instalador.
4. Resultado de la instalación
Detalle de las validaciones que se pueden realizar para validar una instalación.
4.1 Archivos de programa
En el directorio indicado en la instalación se debe encontrar los siguientes directorios:
4.2 Servicio de windows
Dentro de la consola, se deberán ver los siguientes, debe encontrar en estado "En ejecución" los servicios :
- napse-fiscal-flow-agent_${idUnico}
- Napse_BridgeFiscalFlowDirector_${idUnico}
Siendo ${idUnico} la combinación de storeCode_terminalCode
4.3 Log de la instalación
En el directorio donde se encuentra el instalador se puede encontrar los siguientes archivos con el log del proceso de la instalación:
- ant.install.log
- ant.install.properties: el detalle de la configuración ingresada al realizar la instalación.
4.4 Log de la aplicación
En el archivo de log de la aplicación que se puede encontrar en directorio_instalación\log\info.log se debe visualizar la siguiente información:
En la última línea, se puede ver el numero de versión de la aplicación y su fecha de compilación.
4.5 Log de errores
El archivo de log de errores de la aplicación, que se puede encontrar en directorio_instalación\log\error.log se debe encontrar vacío si la instalación fue exitosa.
Si hubo problemas, tendrá el detalle de los mismos. A continuación se mencionan algunos errores comunes y su solución:
Error | Causa | Solución |
---|---|---|
sayHi: Error: getaddrinfo ENOTFOUND http | La URL del servidor no se encuentra bien formada. | Las opciones son:
|
sayHi: Error: connect ETIMEDOUT - http://10.4.201.52 | Al momento de realizar la instalación no había conexión con la VPN. | Este error no require ningún ajuste. No es requerido tener conexión con la VPN al momento de instalar. |
5. Verificación de funcionamiento
Validaciones a realizar para verificar que el Agente se instalo de manera correcta
Para verificar si el agente se encuentra funcionando se puede invocar al servicio utilizado para obtener un token.
Para utilizar el servicio se requiere conocer el id y secret de la compañía.
URL: http://ip_terminal:puerto/api/v1/oauth2/authenticate (reemplazar ip_terminal con la ip de la terminal en la que se instaló el agente y en puerto el puerto del mismo).
Ejemplo:
6. Funcionalidad de proxy
Pasos a seguir para la configuracion del proxy en el Agente de ser necesario
Para habilitar la opción y funcionalidad de proxy en el agente, hay que modificar el archivo de configuración del agente llamado default.json.
Para modificar dicha configuración lo primero que hay que hacer es:
- Detener el servicio napse-fiscal-flow-agent_10_101
- Ingresar a la carpeta de instalación del agente y C:/…./app/config/default.json
- Modificar dicho archivo (default.json) para habilitar el proxy del agente
a. Poner en true el valor de “useProxy”
b. Ingresar el host del proxy “proxyHost”
c. Ingresar el puerto del proxy “proxyPort”
4. Guardar los cambios
5. Iniciar el servicio napse-fiscal-flow-agent nuevamente
Ejemplo de configuración del agente habilitando la funcionalidad proxy
{ "app": { "credentials": { "companyCode": "napse", "storeCode": "1001", "terminalCode": "1001" }, "server": { "endPoint": "http://10.4.201.52:80", "port": "9100", "useProxy": true, "proxyHost": "11.22.33.44", "proxyPort": "88" }, "serverFtp": { "endPointIP": "10.4.201.52", "endPointPort": "22" } } }
7. Desinstalacion del Agente
Pasos a seguir para realizar la desinstalacion del agente
En el caso de que se quiera realizar la desisntalacion del agente, hay que realizar los siguientes pasos, respetando el orden.
- Ubicar correctamente el directorio donde esta instalado el agente y donde esta alojado el instalador para borrar los archivos ant.install.log y ant.install.properties
- Tener el nombre correcto y exacto de los dos servicios que se generaron a la hora de haberlo instalado
- Dirigirse a los Servicios del sistema operativo y buscar los servicios que comiencen con napse
- Realizaremos la detencion de los servicios antes mencionados con el comando net stop service, siendo service el servicio a detener con el nombre exacto (ejecutar esta linea de comando con permisos de administrador y una vez por cada servicio)
- Por ej tenemos los siguientes servicios y vamos a detener a Napse_BridgeFiscalFlowDirector_TQ1_tt1 y napse-fiscal-flow-agent_TQ1_tt1
- Ejecutamos el comando anterior en CMD y este nos devolvera los siguientes mensajes
- Por ej tenemos los siguientes servicios y vamos a detener a Napse_BridgeFiscalFlowDirector_TQ1_tt1 y napse-fiscal-flow-agent_TQ1_tt1
- Revisar que los servicios se hayan detenido correctamente desde la consola de servicios
- Eliminaremos los servicios con el comando sc delete service siendo service el servicio a detener con el nombre exacto (ejecutar esta linea de comando con permisos de administrador y una vez por cada servicio)
- Por ej tenemos los siguientes servicios y vamos a borrar a Napse_BridgeFiscalFlowDirector_TQ1_tt1 y napse-fiscal-flow-agent_TQ1_tt1
- Ejecutamos el comando anterior en CMD y este nos devolvera los siguientes mensajes
- Por ej tenemos los siguientes servicios y vamos a borrar a Napse_BridgeFiscalFlowDirector_TQ1_tt1 y napse-fiscal-flow-agent_TQ1_tt1
- Revisar que los servicios se hayan borrado correctamente desde la consola de servicios
- Con esto ya realizado, procederemos a realizar el borrado de la carpetra donde se instalo el agente y no nos deberia salir ningun error.
- Sem rótulos