Manual de ecoSignature LaunchPC

Sobre este documento #

Este documento tiene el objetivo de describir técnicamente la configuración e instalación de la solución ecoSignature Launch from PC desarrollada por edatalia.

Introducción #

El documento muestra:

• los requerimientos mínimos de funcionamiento.
• las características del producto.
• la instalación de la solución.
• la configuración general de la solución, a través de un fichero de texto de configuración de parámetros denominado ecoSignatureLaunchPC.ini, donde se describen todas las posibles opciones de configuración, que permiten adecuar el comportamiento de la solución.

Requerimientos #

Los requisitos mínimos del funcionamiento de ecoSignature Launch from PC son:

• Puesto PC:
  • Sistema operativo Windows 7 o superior.
  • Java 1.7+.

Características de producto #

La solución ecoSignature Launch from PC permite la comunicación externa con un websocket para el lanzamiento de terceras soluciones de edatalia para la realización de procesos:

• de firmado.
• de obtención de pin.

Entrega #

La solución ecoSignature Launch from PC se entrega en un fichero zip (Windows) o tar.gz (Linux) que presenta el siguiente formato en su nombre:

ecoSignatureLaunchPC_ SO _v y . y . y _ xxxxxxxx, siendo:

• SO: sistema operativo.
• vy.y.y: versión.
• xxxxxxxx: fecha de lanzamiento

Instalación #

SO Windows #

Para la instalación de la solución ecoSignature Launch from PC en un entorno Windows se deben realizar los siguientes pasos:

1. Descomprimir el archivo .zip entregado.
   Dentro de la carpeta “ ecoSignatureLaunchPC ” podemos observar los siguientes ficheros, estructurados de la siguiente forma:
   • módulo de aplicación : contiene los ficheros de lanzamiento de la solución, de configuración y de log, este último optativo.
   • ecoSignatureJWS_LaunchPC.exe : fichero de lanzamiento de la solución.
   • ecoSignatureLaunchPC.ini : fichero de configuración de la solución.
   • log4jLaunchPC_ejemplo.properties : fichero de configuración de log para usuarios avanzados. Se comenta posteriormente.
   • carpeta “ log ”: donde se genera el log de la solución.
   • documentación de la solución .

1. Copiar carpeta “ecoSignatureLaunchPC” en la ruta “C:/”.
2. Si se desea ejecutar inicialmente la solución con la configuración por defecto, ejecutar el archivo ecoSignature_LaunchPC.exe .

Configuración general #

La configuración general de la solución se realiza a través del fichero de configuración ecoSignatureLaunchPC.ini , el cual por defecto se debe encontrar en la carpeta donde se encuentra el .exe de lanzamiento.

A continuación se presentan todos los parámetros configurables a través de este archivo.

Parámetros de configuración #

Parámetros de log de la solución #

 A continuación se describen los parámetros relacionados con los log de la solución.

;(Booleano) Activación de log. Por defecto 0.
log-activate=1
;(Cadena de texto) Ruta de log de la aplicación. Por defecto donde se encuentre el .EXE.
;Nombre por defecto “ecoSignatureLaunchPC.log”.
log-file=log/ecoSignatureLaunchPC.log
;Nivel de log de la aplicación. Por defecto nivel INFO.
;Niveles:
;TRACE: Se usa para información más detallada que el nivel debug.
;DEBUG: Se utiliza para mensajes de información detallada que son útiles para debugear la aplicación.
;INFO: Se utiliza para mensajes de información que resaltan el progreso de la aplicación de una forma general.
;WARN: Se utiliza para situaciones de aviso.
;ERROR: Se usa para eventos de error.
;FATAL: Se usa para errores muy graves.
levelLog=TRACE

>> Nota

La generación de log se realiza a través de Log4j que es una biblioteca open source desarrollada en Java por la Apache Software Foundation que permite a los desarrolladores de software escribir mensajes de registro, cuyo propósito es dejar constancia de una determinada transacción en tiempo de ejecución. Log4j permite filtrar los mensajes en función de su importancia. La configuración de salida y granularidad de los mensajes es realizada en tiempo de ejecución mediante el uso de archivos de configuración externos.

Se presentan los siguientes niveles de log (parámetro “ levelLog” ): #

• TRACE: Se usa para información más detallada que el nivel debug.
• DEBUG: Se utiliza para mensajes de información detallada que son útiles para depuración de la aplicación.
• INFO: Se utiliza para mensajes de información que resaltan el progreso de la aplicación de una forma general.
• WARN: Se utiliza para situaciones de aviso.
• ERROR: Se usa para eventos de error.
• FATAL: Se usa para errores muy graves.

IMPORTANTE : Los parámetros “log-activate”, “log-file” y “levelLog” no se tienen en cuenta si tenemos un archivo de configuración de log’s llamado ” log4jLaunchPC.properties ” en la ruta donde se encuentre el .exe de la solución.

Parámetros de websocket externo #

A continuación se describen los parámetros relacionados con la comunicación con el websocket externo.

IMPORTANTE: En el parámetro “websocket-external-url” se permiten los protocolos web (http y https) y web socket (ws y wss). El parámetro debe comenzar por algún protocolo.

IMPORTANTE: En los parámetros de alias y niveles solo están permitidos caracteres numéricos [0-9], minúsculas [a-z], mayúsculas [A-Z] y los caracteres “_” y “-” y un máximo de 30 caracteres.

(Cadena de texto) Url del websocket externo de comunicación.

Ejemplos:

• http://[servidor]/ecoSignatureWebSocket
• https://[servidor]/ecoSignatureWebSocket
• ws://[servidor]/ecoSignatureWebSocket
• wss://[servidor]/ecoSignatureWebSocket

websocket-external-url=https://efirma.ecosignature.com/ecoSignatureWebSocket<br>websocket-external-url=wss://efirma.ecosignature.com/ecoSignatureWebSocket<br>(Cadena de texto) Alias del cliente externo en el websocket.<br>websocket-external-alias=Edatalia-PC<br>Estructura organizativa<br>(Cadena de texto) Nivel 1.<br>websocket-external-nivel1=Edatalia<br>(Cadena de texto) Nivel 2.<br>websocket-external-nivel2=Software<br>(Cadeba de texto) Nivel 3.<br>websocket-external-nivel3=Desarrollo

Parámetro de websocket local #

A continuación se describe el parámetro relacionado con la comunicación con el websocket local.

(Entero) Puerto del websocket local levantado para el proceso de comunicación y firmado con la aplicación tercera de firma. Por defecto 8181. <br>websocket-internal-port=8282

Parámetros de lanzamiento de solución tercera #

A continuación se describe el parámetro relacionado con la comunicación con el websocket local.

(Cadena de texto) Ruta absoluta de despliegue de ecoSignatureJWS Desktop.<br>path-ecoSignatureJWSDesktop=C:\ecoSignatureJWS\ecoSignatureJWS_Desktop.exe

(Cadena de texto) Ruta absoluta de despliegue de ecoPINpad.
path-ecoPINpad=C:\ecoPINpad\ecoPINpad.exe

(Booleano) Activar una notificación sonora al recibir un documento. Por defecto 1.
sound-notification=0

Funcionamiento #

Para un correcto funcionamiento de la solución ecoSignature Launch from PC realizar los siguientes pasos:

1. Configurar url de websocket externo de comunicación (parámetro “websocket-external-url”).
2. Configurar alias (nombre amigable) de cliente de websocket externo (parámetro “websocket-external-alias”).
3. Opcionalmente introducir los niveles de cliente de websocket externo (parámetros de la forma “websocket-external-nivelX”).
4. Verificar que el puerto seleccionado para levantamiento de websocket local para un proceso de firmado este libre (parámetro “websocket-internal-port”).
5. Configurar ruta absoluta de la solución tercera de Edatalia a lanzar:
   • ecoSignatureJWS Desktop (parámetro “ path-ecoSignatureJWSDesktop ”).
   • ecoPINpad (parámetro “ path-ecoPINpad ”).

6. Opcionalmente configurar el log de la solución.
7. Lanzar solución :

Una vez lanzada la aplicación aparece en la bandeja un icono asociado a la solución

(Tray Icon):

• color verde : el cliente de la solución está conectado a un websocket externo.
• color rojo : el cliente de la solución no está conectado a un websocket externo.

La solución presenta un menú contextual donde se pueden

realizar las siguientes operaciones:

• Datos cliente : ver los datos configurados del cliente.
• Reiniciar : reinicio de la solución.
• Cerrar : cierre de la solución.

Errores #

La solución ecoSignature Launch from PC puede presentar los siguientes errores debido al sistema operativo donde se ejecute o a una incorrecta configuración de la solución.

Dichos errores se pueden presentar en pantalla a través de un diálogo o una notificación.

1. Error en la bandeja del sistema: en algunos sistemas operativos, es posible que labandeja del sistema no esté presente o no sea compatible.

Mensaje : SystemTray no soportado

Resolución :

• Compruebe la compatibilidad de su sistema operativo con la bandeja delsistema (SystemTray).

2. Error en sistema operativo: la solución solamente se ejecuta en Windows.

Mensaje : Sistema operativo no soportado

Resolución :

• Compruebe que su sistema operativo sea Windows.

3. Error en ejecución de la aplicación.

Mensaje : Aplicación en ejecución

Resolución :

• Compruebe que la aplicación ya se encuentra en ejecución.
• Observe el icono asociado a la solución en la bandeja.

4. Error en generación de identificador.

Mensaje : Identificador único no generado correctamente

Resolución :

• Consulte con su administrador.

5. Error en url de websocket externo: la url está vacía o mal formada.

Mensajes :

• Url de websocket vacía
• Url de websocket no válida

Resolución :

• Compruebe que ha introducido una url correcta en el archivo de configuración

(parámetro “websocket-external-url”).

• Modifique la url y guarde el archivo.
• Compruebe que la solución se ha conectado al websocket externo a través del icono asociado a la solución en la bandeja.
• En su defecto, reinicie la solución a través del menú contextual que presenta la solución.

6. Error en alias.

Mensajes :

• Alias no válido (solo se permiten 30 caracteres como máximo)
• Alias no válido (solo se permiten los caracteres [0-9a-zA-Z_-]

Resolución :

• Compruebe que ha introducido una alias correcto en el archivo de configuración (parámetro “websocket-external-alias”).

• Modifique el alias y guarde el archivo.
• Compruebe que la solución se ha conectado al websocket externo a través del icono asociado a la solución en la bandeja.

7. Error en nivel 1.

Mensajes :

• Nivel 1 no válido (solo se permiten 30 caracteres como máximo)
• Nivel 1 no válido (solo se permiten los caracteres [0-9a-zA-Z_-]

Resolución :

• Compruebe que ha introducido un nivel 1 correcto en el archivo de configuración (parámetro “websocket-external-nivel1”).
• Modifique el nivel 1 y guarde el archivo.
• Compruebe que la solución se ha conectado al websocket externo a través del icono asociado a la solución en la bandeja.

8. Error en nivel 2.

Mensajes :

• Nivel 2 no válido (solo se permiten 30 caracteres como máximo)
• Nivel 2 no válido (solo se permiten los caracteres [0-9a-zA-Z_-]

Resolución :

• Compruebe que ha introducido un nivel 2 correcto en el archivo de configuración (parámetro “websocket-external-nivel2”).

• Modifique el nivel 2 y guarde el archivo.
• Compruebe que la solución se ha conectado al websocket externo a través del icono asociado a la solución en la bandeja.

9. Error en nivel 3.

Mensajes :

• Nivel 3 no válido (solo se permiten 30 caracteres como máximo)
• Nivel 3 no válido (solo se permiten los caracteres [0-9a-zA-Z_-]

Resolución :

• Compruebe que ha introducido un nivel 3 correcto en el archivo de configuración (parámetro “websocket-external-nivel3”).
• Modifique el nivel 3 y guarde el archivo.
• Compruebe que la solución se ha conectado al websocket externo a través del icono asociado a la solución en la bandeja.

10. Error en servidor websocket interno.

Mensajes :

• Websocket interno: Address already in use: bind
• Servidor websocket interno no levantado

Resolución :

• Compruebe que el puerto para el levantamiento del websocket interno no esté ocupado por otra aplicación.
• Modifique el puerto en el archivo de configuración (parámetro “websocket-internal-port”).
• En su defecto, reinicie la solución a través del menú contextual que presenta la solución.
• Lance un nuevo proceso de firma.

11. Error en ruta de lanzamiento de la solución tercera para el proceso de firmado.

Mensaje : No encontrado archivo de lanzamiento en la ruta especificada

Resolución :

• Compruebe la ruta absoluta de despliegue de la solución tercera para el proceso de firmado en el archivo de configuración (parámetro “path-ecoSignatureJWSDesktop”).
• Modifique y guarde el archivo.
• Lance un nuevo proceso de firma.