Manual técnico

Visión general#

Este documento está dirigido a personal técnico de implantación y soporte. Su objetivo es indicar cómo instalar, validar y diagnosticar el módulo Sit.a3ERP.Disclaimer en entornos de cliente.

El módulo muestra en a3ERP un mensaje informativo con acceso a la Declaración Responsable de aplicaciones Esofitec, de acuerdo con el Reglamento de Sistemas Informáticos de Facturación.

Todos los módulos a medida de Esofitec para a3ERP deberán ir acompañados de este módulo en aquellas empresas en las que la programación esté activada.

Cambios relevantes desde la versión 2.2.0.0#

A partir de la versión 2.2.0.0, el módulo incorpora estos cambios relevantes para implantación y soporte:

• la interfaz del aviso está implementada con Windows Forms, sin dependencias de WPF
• se generan logs de diagnóstico en C:\Logs
• el fichero de log usa el formato del paquete Sit.Framework.Logging.Log con la cabecera Sit.a3ERP.Disclaimer
• los errores internos del módulo se registran sin propagarse a a3ERP
• si appdata.json está corrupto, el módulo intenta crear un backup antes de guardar una nueva preferencia

Qué instala el módulo#

El paquete contiene:

• binarios del módulo
• binarios de dependencias necesarias para la ejecución
• fichero de registro de DLL
• menú de a3ERP
• icono del menú
• diccionario DSIT_A3ERP_DISCLAIMER

El diccionario no añade tablas ni campos de negocio. Solamente registra la librería del módulo en la tabla DLLS de la empresa a3ERP, si no existe previamente.

Requisitos#

Requisitos del sistema#

• Windows
• a3ERP
• .NET Framework 4.8
• permisos suficientes para copiar ficheros en las carpetas servidor de a3ERP
• despliegue de a3ERP operativo para publicar las extensiones a los clientes
• acceso a la empresa a3ERP donde se instalará el diccionario
• permisos de escritura en C:\Logs para generar trazas de diagnóstico

Requisitos de a3ERP#

La versión de a3ERP no es relevante para la DLL.

El diccionario fue creado en a3ERP 14.05.02. Al no crear estructura propia, la versión del diccionario no debería condicionar la instalación. Si fuera necesario por compatibilidad con una instalación concreta, se puede ajustar la numeración del diccionario.

Ubicación de los ficheros#

Los ficheros del módulo se distribuyen como Sit.a3ERP.Disclaimer o como extensión Sit_a3ERP_Disclaimer.

La extensión debe quedar instalada bajo la estructura de extensiones de las carpetas servidor de a3ERP con estos elementos:

Extensiones\Sofitec\Sit_a3ERP_Disclaimer\
  binarios\
  diccionarios\DSIT_A3ERP_DISCLAIMER\
  imágenes\
  menús\

El icono esperado por el módulo es:

Extensiones\Sofitec\Sit_a3ERP_Disclaimer\imágenes\ribbonIcon.png

A partir de la versión 2.2.0.0, en la carpeta de binarios deben desplegarse también las dependencias del logger:

Sit.Framework.Logging.Abstraction_1.0.4.0.dll
Sit.Framework.Logging.Log_1.0.4.0.dll

El despliegue de a3ERP publicará estos ficheros en la carpeta de red correspondiente. Al abrir la aplicación cliente, a3ERP comprobará si hay ficheros nuevos o actualizados, los descargará y registrará automáticamente las DLLs indicadas en los regDlls.ini encontrados en las carpetas binarios de las extensiones.

Instalación#

1. Copiar los ficheros del módulo en la estructura de extensiones de las carpetas servidor de a3ERP.
2. Ejecutar el despliegue de a3ERP con Solo Actualizar para publicar la extensión.
3. Abrir el cliente de a3ERP para que descargue los ficheros actualizados y registre automáticamente la DLL.
4. Aplicar el diccionario DSIT_A3ERP_DISCLAIMER en la empresa a3ERP.
5. Verificar que el menú Módulos Esofitec > Información > Declaración Responsable aparece en a3ERP.
6. Cerrar y volver a abrir a3ERP o volver a entrar en la empresa para confirmar la carga del módulo.

El fichero regDlls.ini del paquete indica a a3ERP qué DLL debe registrar durante la actualización del cliente:

[REGASM_4.0]
Sit.a3ERP.Disclaimer.dll

Validación después de instalar#

Comprobar en la empresa a3ERP:

• que el cliente ha descargado la extensión desde la carpeta de red de despliegue
• que en Acerca de > Información adicional > Dlls de terceros aparece Sit.a3ERP.Disclaimer.Escuchador (COM) con el evento INICIARGENERAL
• que aparece la opción de menú Declaración Responsable
• que la opción de menú abre el mensaje informativo
• que el enlace abre el navegador predeterminado en https://esofitec.com/declaracion-responsable
• que el icono se visualiza correctamente

La entrada registrada en DLLS debe corresponder al producto Sit_a3ERP_Disclaimer y fabricante Sofitec.

Validación funcional recomendada#

Antes de dar la instalación por buena, se recomienda realizar una prueba funcional con un usuario sin licencia ActiveX/NAX y sin aceptación previa:

• entrar en la empresa y confirmar que aparece el aviso automático
• comprobar que se cierra a los 30 segundos
• marcar No volver a mostrar este mensaje la próxima vez y confirmar que no vuelve a aparecer en la siguiente entrada
• abrir el aviso desde el menú y confirmar que no se cierra automáticamente
• pulsar el enlace y confirmar que abre el navegador
• revisar C:\Logs para comprobar que no hay errores inesperados

Capturas de referencia:

• aviso automático
• menú de Declaración Responsable
• aviso manual

Comportamiento en cliente#

Al entrar en una empresa a3ERP, el módulo puede mostrar el aviso de forma automática.

A partir de la versión 2.2.0.0, la ventana del aviso está implementada con Windows Forms y no utiliza WPF.

El mensaje automático:

• se cierra solo a los 30 segundos
• permite marcar No volver a mostrar este mensaje la próxima vez
• no modifica datos de negocio de la empresa
• solo guarda una preferencia local si el usuario marca la casilla

Si el usuario abre el mensaje desde el menú, la ventana no se cerrará automáticamente y deberá pulsar Aceptar.

Programaciones desasistidas#

El módulo está diseñado para no bloquear programaciones desasistidas.

No debería impedir su ejecución por dos motivos:

• si el usuario actual tiene licencia ActiveX/NAX vigente, el mensaje no se muestra automáticamente
• si el mensaje llegara a mostrarse, se cierra automáticamente a los 30 segundos

En el peor caso, una programación podría retrasar su inicio hasta 30 segundos, pero no debería quedar bloqueada indefinidamente por la ventana.

Preferencia de no volver a mostrar#

La preferencia no se guarda en la base de datos de a3ERP. Se guarda localmente en el terminal Windows.

Ruta:

%appdata%\Esofitec\Sit.a3ERP.Disclaimer\appdata.json

El fichero guarda combinaciones de:

• base de datos de empresa
• usuario de a3ERP
• fecha en la que se marcó la opción

Ejemplo:

{
  "NotShowAgainDisclaimers": [
    {
      "CompanyDb": "ZDEMO",
      "UserName": "sandra",
      "NotShowAgainDate": "2025-09-19T10:15:50.7738318+02:00"
    },
    {
      "CompanyDb": "ZDEMO",
      "UserName": "sa",
      "NotShowAgainDate": "2025-09-19T10:22:26.4931656+02:00"
    }
  ]
}

Para volver a mostrar el aviso automático a un usuario que lo había ocultado, se puede eliminar su entrada del JSON. También puede borrarse el fichero completo para restablecer la visualización de todos los usuarios y empresas guardados en ese terminal.

A partir de la versión 2.2.0.0, si el fichero appdata.json está corrupto, el módulo lo trata como si no existiera aceptación previa. Al guardar una nueva aceptación intentará mover el fichero corrupto a un backup con este formato:

appdata.corrupt.yyyyMMdd_HHmmss.json

Si no puede leer, escribir o crear el backup del fichero, la incidencia se registra en el log y no se muestra ningún error al usuario.

Logs de diagnóstico#

A partir de la versión 2.2.0.0, el módulo genera trazas en el equipo cliente en:

C:\Logs

El nombre del fichero de log usa el formato del paquete Sit.Framework.Logging.Log con la cabecera Sit.a3ERP.Disclaimer.

Estas trazas sirven para diagnosticar incidencias sin interrumpir el uso de a3ERP. Si el sistema de logging no puede escribir, el módulo continúa funcionando y no muestra errores al usuario.

A partir de la versión 2.2.0.0, los errores no controlados de las entradas principales del módulo se capturan y se registran en el log para evitar que suban a a3ERP.

En los logs se puede revisar:

• inicio automático del módulo al entrar en empresa
• usuario y base de datos recibidos desde a3ERP
• detección de licencia ActiveX/NAX
• decisión de mostrar o no mostrar el aviso automático
• apertura manual desde el menú
• cierre del formulario y valor de la opción No volver a mostrar este mensaje la próxima vez
• guardado correcto o fallido de la preferencia local
• problemas de lectura, escritura, permisos o corrupción de appdata.json
• creación correcta o fallida del backup de un JSON corrupto
• ausencia o error de carga del icono
• error al abrir el enlace web
• errores no controlados durante la carga del módulo

Diagnóstico de incidencias#

El aviso no aparece automáticamente#

Revisar:

• que el cliente haya descargado los ficheros actualizados de la extensión
• que Sit.a3ERP.Disclaimer.dll esté en la carpeta binarios de la extensión en el cliente
• que el fichero regDlls.ini esté presente en la carpeta binarios
• que la DLL aparezca registrada en Acerca de > Información adicional > Dlls de terceros
• que exista Sit.a3ERP.Disclaimer.Escuchador en la tabla DLLS
• que a3ERP se haya reiniciado o que se haya vuelto a entrar en la empresa después de instalar
• que el usuario no tenga licencia ActiveX/NAX vigente
• que no exista una entrada previa para ese usuario y esa empresa en appdata.json
• que se esté ejecutando a3ERP de forma normal y no desde un proceso externo distinto
• los logs en C:\Logs para confirmar la decisión de visualización

El aviso aparece repetidamente#

Revisar:

• que el usuario haya marcado No volver a mostrar este mensaje la próxima vez
• que el usuario tenga permisos de escritura en %appdata%
• que exista la carpeta %appdata%\Esofitec\Sit.a3ERP.Disclaimer
• que el fichero appdata.json no esté bloqueado o dañado
• que el usuario y la base de datos coincidan con los valores guardados en el JSON
• los logs para comprobar si el guardado de la preferencia ha fallado por permisos, bloqueo o JSON corrupto

El menú no aparece#

Revisar:

• que el fichero de menú esté copiado en la carpeta de menús de la extensión en servidor
• que el despliegue haya publicado la extensión en la carpeta de red
• que el cliente haya descargado la versión actualizada de la extensión
• que a3ERP se haya reiniciado después de copiar el menú

El icono no aparece#

Revisar que exista:

Extensiones\Sofitec\Sit_a3ERP_Disclaimer\imágenes\ribbonIcon.png

Si el fichero no existe en el cliente o no se puede cargar, el módulo lo registra en C:\Logs.

El enlace no abre el navegador#

Revisar:

• que el equipo tenga navegador predeterminado configurado
• que Windows permita abrir enlaces web desde aplicaciones de escritorio
• que la URL https://esofitec.com/declaracion-responsable sea accesible desde el equipo
• los logs para ver si Windows ha devuelto algún error al intentar abrir la URL