Configuración General - Properties

Revisión: 28-ago-2022

En esta guía te explicamos todas las opciones de configuración del producto Viafirma Documents. Recuerda que en el KIT DE INSTALACIÓN te entregamos un config.properties con configuración básica de inicio.

Si tienes alguna duda sobre alguna de las propiedades aquí descritas contacta con nosotros escribiéndonos a [email protected] indicando en tu correo la versión exacta del producto que tienes.

URL_PROTOCOL

  • Los posibles valores son http o https.
  • Valor por defecto: "https"

JDBC_URL

  • Cadena de conexión a la base de datos.
  • Obligatorio
Ejemplo Postgresql: jdbc:postgresql://127.0.0.1:5432/documents
Ejemplo Oracle:  jdbc:oracle:thin:@localhost:1521:ORCL

JDBC_DRIVER

  • Indica el driver que utilizará la aplicación para acceder a la base de datos. Los valores disponibles son org.postgresql.Driver o oracle.jdbc.driver.OracleDriver.
  • Obligatorio

JDBC_USER

  • Define el usuario de la base de datos.
  • Obligatorio

JDBC_PASSWORD

  • Define la contraseña de la base de datos.
  • Obligatorio

AUTHENTICATOR_CHAIN

  • Implementación del sistema de control de acceso utilizado.
  • Valor por defecto: com.viafirma.mobile.services.security.DocumentsAuthenticator
  • Opcional

Proveedores de Identidad (identities providers - IDPS)

Para la gestión de usuarios Viafirma Documents permite inyectar implementaciones de distintos proveedores. Por defecto se hace uso de la Base de Datos propia del producto, definido de la siguiente forma:IDPS=DATABASE:database.

Para añadir configuración de un proveedor adicional tendrás que hacer uso de todas las propiedades relacionadas con IDPS y te describimos a continuación:

IDPS

  • Valor por defecto: DATABASE:database
  • Opcional

Aquí podrás definir la lista de proveedores de identidad separados por coma.

IDPS=provider1,provider2,providerN

Un proveedor se nombra con el siguiente patrón:

provider_type:provider_name

Los tipo de proveedores de identidad soportados en Viafirma Documents hasta el momento son los siguientes:

  • LDAP
  • SEUS3
  • SEUS4

Y para cada tipo de proveedor podrás definir tantas instancias como quieras, debiendo identificarlas con un nombre distinto en cada caso y separadas por coma, por ejemplo:

IDPS=LDAP:ldap1,LDAP:ldap2

Si quieres activar la autenticación basada en LDAP/Active Directory echa un vistazo al siguiente enlace donde te explicamos la configuración específica que debes seguir:

Configuración LDAP / Active Directory

Ajustes del Correo Electrónico

MAIL_HOST_NAME

  • Host del servidor de correo electrónico
  • Opcional

MAIL_PORT

  • Puerto por el que se realizará la conexión al servidor de correo
  • Opcional

MAIL_SMTP_USER

  • Usuario del servidor de correo electrónico
  • Obligatorio = no
  • Disponible desde versiones anteriores a la 3.5

MAIL_SMTP_PASS

  • Contraseña del servidor de correo electrónico
  • Opcional

MAIL_FROM

  • Cuenta de email que aparecerá como remitente de los correos.
  • Opcional

MAIL_FROM_NAME

  • Nombre del remitente de las notificaciones por correo electrónico que reciben los usuarios.
  • Valor por defecto: Si no viene indicado el remitente se utiliza el nombre del usuario, y en su defecto se usará el título de la aplicación solicitante (API o APP).
  • Opcional

Info adicional: aqui podrás definir el "from_name" por defecto de todos los correos remitidos desde Viafirma Documents, pero ten en cuenta que esta propiedad "from" también se puede configurar de forma explícita en la configuración de los grupos y en la configuración incluso de cada proceso de firma. Por tanto, el valor del "from_name" definido en este properties global de configuración solo tendrá en cuenta en los siguientes casos:

  • en todos los correos automatizados del sistema para tareas como informes, sondas de monitorización de sistemas, etc.
  • en aquellas notificaciones a usuarios finales cuyo grupo o configuración específica no incluya un "from_name".

MAIL_SSL

  • Indica si la conexión con el servidor de correo electrónico es mediante SSL. Los posibles valores son true o false
  • Valor por defecto: false
  • Opcional

MAIL_TLS

  • Indica si la conexión con el servidor de correo electrónico es mediante TLS. Los posibles valores son true o false
  • Valor por defecto: false
  • Opcional

MAIL_CALLBACK_SENT_STATUS

  • Esta propiedad te permite definir, a nivel global, en qué estados del ciclo de vida del proceso de firma enviaremos de forma automática un correo electrónico.
  • Valores por defecto: EXPIRED,ERROR,REJECTED,RESPONSED,WAITING_CHECK,FINISHED,WAITING_CLIENT_SIGNATURE,MAX_ERROR_REACHED,TRANSFER_CANCELED
  • Opcional
  • Info adicional: esta configuración solo se tendrá en cuenta para aquellos casos en los que el grupo afectado no haya definido en sus propiedades cuáles son los estados en los que se desea enviar correos electrónicos automáticos, en caso contrario prevalecerá la configuración del grupo.

SMS_FROM_NAME

  • Nombre del remitente de las notificaciones SMS que reciben los usuarios.
  • Valor por defecto: Si no viene indicado el remitente se utiliza el título de la aplicación solicitante.
  • Opcional
  • Info adicional: esta configuración solo se tendrá en cuenta para aquellos casos en los que la notificación SMS, la plantilla o el grupo afectado no incluyan configuración explícita al respecto.

CREATE_TEMPLATE_EXAMPLES

  • Carga automática de plantillas de ejemplo, útil para entornos de QA. Se recomienda desactivar en entornos de producción. Los posibles valores son true o false.
  • Valor por defecto: false
  • Opcional

TERCEROS DE CONFIANZA

TRUSTED_JKS_PATH

  • Acceso al KeyStore que contiene las claves públicas de las CA en las que confia la plataforma.
  • Valor por defecto: "{ruta de documents-home}/trusted_cacerts.jks"
  • Opcional

TRUSTED_JKS_PASSWORD

  • Contraseña del KeyStore que contiene las claves públicas de las CA en las que confia la plataforma.
  • Opcional

SIGNATURE_JKS_PATH

  • Acceso al KeyStore que contiene los certificados utilizados por la plataforma para la firma de documentos, evidencias o cifrado de datos.
  • Valor por defecto: "{ruta de documents-home}/cacerts.jks"
  • Opcional

SIGNATURE_JKS_PASSWORD

  • Contraseña del KeyStore que contiene los certificados utilizados por la plataforma para la firma de documentos, evidencias o cifrado de datos.
  • Opcional

DEFAULT_ENCRYPTION_KEY_ALIAS

  • Alias de la clave pública de cifrado de datos biométricos existentes en KeyStore de firma.
  • Obligatorio si la licencia no incluye un certificado de cifrado por defecto.
  • Si la licencia tiene un certificado de cifrado no es necesario indicar este atributo salvo que se quiera utilizar un certificado de cifrado incluido en el cacerts en lugar del de la licencia.

DEFAULT_CERTIFICATE_ALIAS

  • Alias del certificado utilizado por defecto para firmar los xml de las evidencias y los documentos pdf generados por el sistema.
  • Obligatorio si la licencia no incluye un certificado de firma por defecto.
  • Si la licencia tiene un certificado de firma no es necesario indicar este atributo salvo que se quiera utilizar un certificado de firma incluido en el cacerts en lugar del de la licencia.

DEFAULT_CERTIFICATE_PASS

  • Contraseña del certificado utilizado por defecto para firmar los xml de las evidencias y los documentos pdf generados por el sistema.
  • Obligatorio si la licencia no incluye un certificado de firma por defecto.
  • Si la licencia tiene un certificado de firma no es necesario indicar este atributo salvo que se quiera utilizar un certificado de firma incluido en el cacerts en lugar del de la licencia.

Validación de Certificados

Viafirma permite varios mecanismos para la validación de certificados digitales, validación realizada NO solo sobre el certificado que se desea utilizar para la firma, sino de todos los certificados que hubieran participado en firmas previamente realizadas sobre el mismo documento.

Uno de los mecanismos soportados es CA Support, recomendado, un servicio ofrecido por Viafirma encargado de publicar una lista de prestadores autorizados y que simplifica esta gestión. Para ello debes hacer uso de los siguientes PARMAS en tu properties de configuración:

CASUPPORT_URL

CASUPPORT_URL=https://casupport.viafirma.com

Este param es opcional, y en caso de no usarlo tendrás que gestionar la confianza de prestadores de certificados de manera local, a través de trusted cacert configurado en tu instalación.

CASUPPORT_PATH

El servicio te permite filtrar la lista de prestadores en los que deseas confiar como se muestra en los siguientes ejemplos:

Ejemplo todos los prestadores Europeos (eIDAS):

CASUPPORT_PATH=/prod/eu/

Ejemplo solo prestadores de España (eIDAS):

CASUPPORT_PATH=/prod/eu/es

Ejemplo solo prestadores de España y Portugal (eIDAS):

CASUPPORT_PATH=/prod/eu/es,/prod/eu/pt

Podrás agregar de forma explícita tantos países como desees en tu filtro, y para ambientes de sandbox o pruebas puedes incluir la rama de prestadores TEST de la siguiente forma, pero asegúrate de no tenerlo habilitado en entornos de producción:

CASUPPORT_PATH=/prod/eu/es,/prod/eu/pt,/test

Configuración TSA

Esta configuración en opcional. Si defines una configuración de TSA en el properties se aplicará a nivel global, y si el grupo de trabajo cuenta con una configuración específica de TSA prevalecerá sobre la definida en el properties.


En caso de que la TSA cuente con algún mecanismo de seguridad debes **agregar** la parametrización adecuada con algunas de las distintas opciones disponibles:

**Basic Auth**

TSA_USER=xxx TSA_USER_PASSWORD=xxx


**Autenticación con Certificado Digital**

TSA_ALIAS=xxx TSA_USER_PASSWORD=xxx TSA_AUTH_TLS=true/false

Este certificado debe estar incluido en el fichero cacert definido en la variable **SIGNATURE_JKS_PATH**.

**Extensiones opcionales**

Algunos servicios de TSA requieren extensiones adicionales que podrás informar con los siguientes parámetros:

TSA_POLICY_ID=xxx TSA_EXTENSION_OID=xxx TSA_EXTENSION_VALUE=xxx


Ejemplo de configuración de la TSA a través de la Red Sara:

TSA_POLICY_ID=2.16.724.1.3.1.1.4.2.1.2 TSA_EXTENSION_OID=1.3.4.6.1.3.4.6 TSA_EXTENSION_VALUE=your_application_id SA_AUTH_TLS=true



## OTRA CONFIGURACIÓN

### SYSTEM_STATUS_ERROR_THREAD_TIMER_DELAY

* Tiempo en milisegundos que indica el tiempo de demora desde el inicio del sistema, con el que se empieza a comprobar el estado del sistema.
* Valor por defecto: 600000
* Opcional

### SYSTEM_STATUS_ERROR_THREAD_TIMER_PERIOD

* Tiempo en milisegundos que indica cada cuanto tiempo se comprueba el estado del sistema.
* Valor por defecto: 600000
* Opcional

### DEFAULT_CUSTODY_CODE

* Código de custodia de documentos firmados.
* Valor por defecto: CKRD
* Opcional

### ONE_SESSION_PER_USER

* Indica queremos limitar el número de sesiones de un usuario a una en el backend.
* Valor por defecto: "false"
* Opcional

### MAX_PREVIEW_NUM_PAGES

* Número máximo de páginas que se muestran en el visor de PDF de la página de firma.
* Valor por defecto: 100
* Opcional

### BACKEND_NAME

* Nombre del path del contexto definido en el tomcat que tiene el backend.
* Valor por defecto: "/documents"
* Opcional

### SUPPORTED_LANGUAGES

* Opcional

Podrás indicar qué idiomas podrá elegir el usuario cuando navega por las páginas del panel de gestión (backend) y página de firma.

Podrás elegir uno o todos de la lista de idiomas actualmente soportados:

es_ES_Español,en_EN_English,pt_PT_Portugues,de_DE_Deutsch,fr_FR_Français


**¿Cuál es el comportamiento por defecto?**

Si el idioma navegador del usuario no coincide con alguno de los configurados por defecto se mostrará en inglés. Si se trata de una variante del español, por ejemplo, CA_ES (catalán), entonces se mostrará por defecto en es_ES.

Si necesitas incorporar nuevos idiomas en el producto ponte en contacto con nosotros en [email protected]


### INPUT_PHONE_DEFAULT_COUNTRY

* País por defecto que se muestra en los input de los teléfonos.
* Valor por defecto: "es"
* Opcional

### INPUT_PHONE_PREFERRED_COUNTRIES

* Países preferidos que aparecen como destacados en el listado de paises de los input de los teléfonos.
* Valor por defecto: "es,pt,gb,us"
* Opcional


## MICROSERVICIOS

### SMS_SERVICE_URL

* URL del servicio web de Viafirma SimpleSign-OTP
* Opcional

### SMS_SERVICE_USER

* user del servicio web de Viafirma SimpleSign-OTP
* Opcional

### SMS_SERVICE_PASSWORD

* password del servicio web de Viafirma SimpleSign-OTP
* Opcional

<!--
### OCR_URL_SERVICE

* URL del servicio OCR.
* Opcional

### OCR_TEMPLATE_PATH

* Ruta donde se almacenan las plantillas OCR.
* Opcional

### OCR_TEMPLATES_PROPERTIES_JSON

* Nombre del fichero JSON con las propiedades de las plantillas OCR
* Opcional
-->

## MÓDULO DE FIRMA

### SIGN_PAGE_SERVER

* Si el parámetro anterior es activado, debe establecerse la url del módulo de firma en este atributo.
* Valor por defecto: `https://{domain}/sign-page/` (donde domain es el dominio donde está alojado el módulo de firma).
* Opcional

### DEFAULT_CLIENT_SIGNATURE_APP

* Código de la aplicación por defecto para firma web.
* Valor por defecto: com.viafirma.documents
* Opcional

### DEFAULT_CLIENT_APP

* Código de la aplicación móvil por defecto a la que tendrán permiso de acceso los usuarios sin grupo asociado.
* Valor por defecto: com.viafirma.documents
* Opcional


### inbox.apikey

* Clave del API de inbox que utilizará la instancia de documents para la integración con Viafirma Inbox.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional

### inbox.apipass

* Contraseña del API de inbox que utilizará la instancia de documents para la integración con viafirma Inbox.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional

### inbox.restApiPathBase

* URL de viafirma inbox
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional

### inbox.restApiRequests

* URI relativa a partir del parámetro inbox.restApiPathBase donde se enviarán las peticiones al API de Viafirma Inbox.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Valor por defecto: requests
* Opcional

### inbox.notificationUrl

* URL donde notificará Viafirma Inbox trás un cambio de estado. En principio la configuración recomendada deberá ser {URL documents}/connect que es un servlet que se encarga de realizar los cambios oportunos en el mensaje de documents trás el cambio de estado y de notificar en caso de que sea necesario al CRM del cliente. Si no viene informado este parámetro, la integración con Viafirma Inbox termina en el momento en que se envía el documento a Inbox.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional

### inbox.subjectKey

* Nombre de la propiedad que podrá venir como metadato o campo del formulario del mensaje de documents que será enviada a viafirma Inbox como subject de la petición.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional

### inbox.crm.callback

* URL del CRM donde se enviará el aviso una vez firmado el documento en documents, rechazado y trás la notificación desde Viafirma Inbox a Documents. Este comportamiento será definido en cada una de las implementaciones del proceso de envío a los distintos CRM.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
* Opcional

### inbox.crm.callback.authorization

* Header authorization que se enviará en las peticiones al CRM donde se enviará el aviso una vez firmado el documento en documents, rechazado y trás la notificación desde Viafirma Inbox a Documents. Este comportamiento será definido en cada una de las implementaciones del proceso de envío a los distintos CRM.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje.
* Opcional


### inbox.crm.process

* Implementación del tratamiento de la respuesta dada por Viafirma Inbox para procesarla y llamar a un backend de terceros. Consulta las distintas implementaciones disponibles.
* Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
* Opcional
* Valor por defecto: GENERIC


### SHOW_LAST_DAYS

* Número de días que muestran los listados del backend por defecto.
* Opcional
* Valor por defecto: 31


### DEFAULT_TIME_ZONE_ID

* Opcional

Si usas sellos de firma en tus políticas de firma podrás acompañar junto a la fecha el time zone deseado. En el diseñador de políticas podrás elegir a partir de una lista, pero si lo defines en el properties global del sistema podrás usarlo por defecto.

Podrás usar tz database ICANN codes, por ejemplo:

DEFAULT_TIME_ZONE_ID=Europe/Madrid DEFAULT_TIME_ZONE_ID=America/Bogota DEFAULT_TIME_ZONE_ID=America/La_Paz DEFAULT_TIME_ZONE_ID=America/Buenos_Aires ```

WORKER_MONITORING_ENABLED

Se usa internamente para exponer métricas en el puerto 6312 para Prometheus. El puerto puede ser cambiado con el parámetro de configuración por WORKER_MONITORING_PORT.

  • Opcional
  • Disponible en versiones 3.7 y superior.

TAREAS AUTOMATIZADAS

En este fichero de configuración también se configuran las TASK y JOBS encargados de ciertas automatizaciones necesarias para el sistema, y te explicamos cómo hacerlo en el siguiente apartado: Task y JOBS.

results matching ""

    No results matching ""