Manual de instalación de Viafirma Documents

Configuración General - Properties

Revisión: 30-jul-2019

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 helpdesk@viafirma.com e indicando en tu correo la versión exacta del producto que tienes.

URL_PROTOCOL

  • Indica el protocolo de la url de la aplicación. Los posibles valores son http o https.
  • Valor por defecto: "https"
  • No obligatorio desde la versión 3.5.125 (se incluye valor por defecto)
  • Disponible desde versiones anteriores a la 3.5

JDBC_URL

  • Indica la cadena de conexión a la base de datos. Ejemplo Postgresql: jdbc:postgresql://127.0.0.1:5432/documents Ejemplo Oracle: jdbc:oracle:thin:@localhost:1521:ORCL
  • Obligatorio
  • Disponible desde la versión 3.5.90

JDBC_DRIVER

  • Indica el driver que utilizara la aplicación para acceder a la base de datos. Los valores mas utilizados son org.postgresql.Driver o oracle.jdbc.driver.OracleDriver.
  • Obligatorio
  • Disponible desde la versión 3.5.90

JDBC_USER

  • Indica el usuario de la base de datos.
  • Obligatorio
  • Disponible desde la versión 3.5.90

JDBC_PASSWORD

  • Indica la contraseña de la base de datos.
  • Obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_CHAIN

  • Implementación del sistema de control de acceso utilizado.
  • Valor por defecto: com.viafirma.mobile.services.security.DocumentsAuthenticator
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

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 en la (IDPS=DATABASE:database).

Para añadir configuración de un proveedor de usuarios 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
  • Obligatorio: NO

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:


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, por ejemplo:

IDPS=LDAP:ldap1,LDAP:ldap2


En el siguiente enlace te explicamos la configuración específica para el proveedor de identidad LDAP (Active Directory):

[Configuración LDAP / Active Directory](ldapconfig.md)

## Configuración Correo Electrónico

### MAIL_HOST_NAME

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

### MAIL_PORT

* Puerto por el que se realizará la conexión al servidor de correo
* Obligatorio = no
* Disponible desde versiones anteriores a la 3.5

### 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
* Obligatorio = no
* Disponible desde versiones anteriores a la 3.5

### MAIL_FROM

* Remitente de los correos
* Obligatorio = no
* Disponible desde versiones anteriores a la 3.5

### 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
* Obligatorio = no
* Disponible desde versiones anteriores a la 3.5

### 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
* Obligatorio = no
* Disponible desde la versión 3.5.10

### 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).
* Obligatorio = no
* Disponible desde la versión 3.5.120

nota: también podrás configurarlo en las propiedades de cada plantilla o en su defecto en las propiedades de cada proceso de firma.

### MAIL_CALLBACK_SENT_STATUS

* Estados en los que se enviará el correo eléctronico de respuesta (email de callback) en caso de tener el mensaje informado un correo de respuesta.
* Valores por defecto: ```EXPIRED,ERROR,REJECTED,RESPONSED,WAITING_CHECK,FINISHED,WAITING_CLIENT_SIGNATURE,MAX_ERROR_REACHED,TRANSFER_CANCELED
  • Obligatorio = no
  • Disponible desde la versión 3.5.120

nota: también podrás configurarlo en las propiedades del Grupo de Trabajo, desde el Panel de Configuración de Viafirma Documents.

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.
  • No obligatorio
  • Disponible desde la versión 3.5.120

nota: también podrás configurarlo en las propiedades de cada plantilla o en su defecto en las propiedades de cada proceso de firma.

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
  • Obligatorio = no
  • Disponible desde versiones anteriores a la 3.5

REPOSITORIO_IMPL

  • Obligatorio = no
  • Disponible desde versiones anteriores a la 3.5
  • Ejemplo = REPOSITORIO_IMPL=

Con Viafirma Documents podrás automatizar la transferencia de documentos firmados a un Repositorio Externo. Para ello es necesario contar con una implementación a medida que consuma los servicios de cada proveedor.

Una vez implementado el sistema, sólo tendrás que definirlo en esta propiedad, tal y como te explicamos a continuación.

Patrón utilizado:


y podrás definir varias al mismo tiempo, separadas por coma ```,```.

Por ejemplo:

```implementationType1:implementationName1,implementationType2:implementationName2,implementationType3:implementationName3

Las implementaciones soportadas en Viafirma Documents hasta el momento son las siguientes:

org.hanuman.framework.external.repository.ComputecFileRepositoryImpl
org.hanuman.framework.external.repository.P8SuraFileRepositoryImpl
org.hanuman.framework.external.repository.OscFileRepositoryImpl
org.hanuman.framework.external.repository.InboxSafeFileRepositoryImpl
org.hanuman.framework.external.repository.HeinekenFileRepositoryImpl

Para cada implementación necesitarás definir sus propiedas propiedades:

implementationName.property1
implementationName.property2
etc.

Si vas a utilizar una de estas implementaciones para transferir tus documentos firmados escríbenos a helpdesk@viafirma.com e indícanos en tu correo la versión exacta del producto que tienes y cuál es la implementación de transferencias que deseas utilizar.

DEFAULT_REPOSITORY

  • Podrás definir un repositorio por defecto para transferir los documentos firmados en aquellos casos donde el proceso de firma no está asociado a un grupo de trabajo.
  • Valor por defecto: disabled
  • Obligatorio = no
  • Disponible desde la versión 3.5.90

SEGURIDAD

PASSWORD_POLICY_LEVEL

  • Nivel de seguridad en la política de contraseñas. Los valores permitidos son:
    • 0: Nivel por defecto, exige unicamente más de 5 caracteres.
    • 1: Nivel Medio, exige al menos 8 caracteres.
    • 2: Nivel Alto, exige al menos 8 caracteres incluyendo una mayúscula, una minúscula, un número y un carácter especial (@#$%)
  • Valor por defecto: 0.
  • No obligatorio
  • Disponible desde la versión 3.5.40

PASSWORD_HISTORY_LENGTH

  • Número de contraseñas del usuario historicas que no se pueden repetir cuando se módifica la contraseña. Si el valor es 5, el usuario no podrá repetir sus últimas 5 contraseñas cuando modifique su contraseña.
  • Esta utilidad solo esta disponible para nivel medio-alto de las politicas de contraseñas (PASSWORD_POLICY_LEVEL 1 o 2)
  • Valor por defecto: 5
  • No obligatorio
  • Disponible desde la versión 3.5.124

PASSWORD_MAX_LOGIN_ATTEMPTS

  • Número máximo de intentos para autenticarse de un usuario. En caso de superar este número de intentos tendrá que esperarse PASSWORD_RETRY_WAITING_TIME en minutos para poder volver autenticarse.
  • Valor por defecto: 90
  • No obligatorio
  • Disponible desde la versión 3.5.124

PASSWORD_RETRY_WAITING_TIME

  • Tiempo en minutos que tendrá que esperarse un usuario que haya superado el número máximo de intentos para autenticarse en la plataforma para poder autenticarse nuevamente en la plataforma.
  • Valor por defecto: 5
  • No obligatorio
  • Disponible desde la versión 3.5.124

DATA_PROTECTION_LEVEL

  • Nivel de protección de datos. Los valores permitidos son:
    • 0: Nivel Bajo no tiene efecto en los datos del mensaje.
    • 1: Nivel Medio, los datos sensibles del mensaje se muestran incluyendo * en la mitad última de los caracteres.
    • 2: Nivel Alto, los datos sensibles del mensaje se modifican y guardan incluyendo * en la mitad última de los caracteres.
  • Valor por defecto: 0
  • No obligatorio.
  • Disponible desde la versión 3.5.97

OAUTH_REQUEST_MAX_AGE

  • Tiempo en milisegundos, si se supera esta diferencia de tiempo entre la hora de la petición y la hora del servidor se rechaza la petición a la capa de servicios REST. Toma el valor 0 en caso de no querer aplicar esta restricción.
  • No obligatorio
  • Valor por defecto: 0

OAUTH_EXPIRE_TOKEN_MINUTES

  • Tiempo en minutos que indica la caducidad de tokens de acceso al API, un token caduca cuando pasan los minutos indicados en esta variable sin ningún acceso al API REST.
  • Valor por defecto: 10080
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

API_DOCS_ENABLED

  • Indica si se permite el acceso a swagger. Los valores permitidos son true (Habilitado) o false (No habilitado).
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.15

SEUS4_ENABLED

  • Indica si el sistema que gestionará la autenticación en la plataforma de documents será SEUS 4. En caso de estar este parámetro activo la única forma de ingresar en la plataforma será a traves de usuarios registrados en SEUS.
  • En caso de tener activo este sistema tendremos que indicar las siguientes variables de arranque en el tomcat:
-DSSO_SECRET=XXXXX 
-DTOKEN_PUBS_VALIDATION_SERVICE_URL=<HOST>/idp/validations/tokenPubs 
-DTOKEN_VALIDATION_SERVICE_URL=<HOST>/idp/validations/token 
-DAUTHORIZATION_SERVICE_URL=<HOST>/auth/authorization/app 
-DSIGNATURE_PRIVATE_KEY_ALIAS=<ALIAS>
-DAPP_COOKIE_NAME=appTag 
-DCONFIGURATION_SERVICE_URL=<HOST>/conf/configuration/sso-api
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.90

SEUS4_AUTOREGISTER

  • Indica si se registrarán automáticamente los usuarios del sistema seus 4 en caso de estar habilitado este sistema de autenticación.
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_SERVICE_ENABLED

  • Indica si se permite la autenticación en documents mediante certificado digital.
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_AUTOREGISTER

  • Indica si los usuarios que accedan mediante certificado digital se registrarán en la plataforma automáticamente.
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_SERVICE

  • URL del servicio de autenticación con certificado digital.
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_KEY

  • Clave del servicio de autenticación con certificado digital.
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTHENTICATOR_PASSWORD

  • Contraseña del servicio de autenticación con certificado digital.
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTOREGISTER

  • Indica si se permite el auto registro de usuarios a modo de prueba. Estos usuarios tendrán una caducidad limitada, se creará un grupo propio para el usuario para que el usuario pueda realizar pruebas.
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.90

AUTOREGISTER_DAYS

  • Indica el periodo de prueba de los usuarios de prueba auto registrados en la plataforma.
  • Valor por defecto: 15
  • No obligatorio
  • Disponible desde la versión 3.5.90

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"
  • No obligatorio desde la versión 3.5.90
  • Disponible desde versiones anteriores a la 3.5

TRUSTED_JKS_PASSWORD

  • Contraseña del KeyStore que contiene las claves públicas de las CA en las que confia la plataforma.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

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"
  • No obligatorio desde la versión 3.5.90
  • Disponible desde versiones anteriores a la 3.5

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.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

DEFAULT_ENCRYPTION_KEY_ALIAS

  • Alias de la clave pública de cifrado de datos biométricos existente 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.
  • Disponible desde versiones anteriores a la 3.5

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.
  • Disponible desde versiones anteriores a la 3.5

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.
  • Disponible desde versiones anteriores a la 3.5

CASUPPORT_URL

  • URL del servicio de soporte de autoridades de certificación de viafirma.
  • Valor por defecto: desactivado (Si no se indica este parámetro estará desactivado)
  • No obligatorio
  • Disponible desde la versión 3.5.92

CASUPPORT_PATH

  • Listado de rutas donde se buscará en el servicio de autoridades de certificación de viafirma. Ejemplo de las autoridades de producción de España: /prod/eu/es
  • Valor por defecto: ""
  • No obligatorio
  • Disponible desde la versión 3.5.92

TSA_URL

  • URL de acceso al servicio de sellos de tiempo TSA.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TSA_USER

  • Clave de acceso al servicio de sellos de tiempo TSA. Sólo necesario si la TSA requiere seguridad básica.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TSA_USER_PASSWORD

  • Clave de acceso al servicio de sellos de tiempo. Sólo necesario si la TSA requiere seguridad básica.
  • No obligatorio
  • Para versiones superiores a la 3.2.6 es reemplazado por la variable TSA_PASS
  • Disponible desde versiones anteriores a la 3.5

TSA_ALIAS

  • Alias del certificado utilizado para acceso al servicio de sellos de tiempo TSA. Este certificado debe estar incluido en el fichero cacert definido en la variable SIGNATURE_JKS_PATH
  • No obligatorio. Solo para entornos con TSA securizados mediante certificado.
  • Disponible desde versiones anteriores a la 3.5

TSA_AUTH_TLS

  • True para TSA que implementen seguridad basada en certificado/TLS.
  • No obligatorio.
  • Disponible desde versiones anteriores a la 3.5

TSA_PASS

  • Contraseña para el acceso al servicio de sellos de tiempo TSA. Dependiendo del tipo de conexión puede ser la contraseña para accesos con usuario/contraseña o la contraseña del certificado para accesos mediante certificado.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TSA_LOG_PATH

  • Ruta del directorio donde se almacenan los logs relacionados con la TSA. Desde el fichero logback.xml se indica que estos ficheros se almacenarán durante 30 días en el directorio logs-to-collect dentro del servidor de aplicaciones. Configurando esta variable y TSA_LOG_PREFIX se guardará la información capturada en el log a modo de auditoría en base de datos.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TSA_LOG_PREFIX

  • Prefijo de los ficheros de logs relacionados con la TSA almacenados en el directorio indicado por la variable TSA_LOG_PATH.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TSA_AUTH_TLS

  • Indica si la conexión con la TSA se realiza mediante TLS
  • Valor por defecto: false
  • No obligatorio
  • Disponible desde la versión 3.5.101

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
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

SYSTEM_STATUS_ERROR_THREAD_TIMER_PERIOD

  • Tiempo en milisegundos que indica cada cuanto tiempo se comprueba el estado del sistema.
  • Valor por defecto: 600000
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

DEFAULT_CUSTODY_CODE

  • Código de cutodia de documentos firmados.
  • No obligatorio desde la versión 3.2.0.
  • Valor por defecto: CKRD
  • Disponible desde versiones anteriores a la 3.5

TEMPORAL_PERSISTENCE_DATA_TYPE

  • Indica donde se almacenaran los datos temporales. Los valores permitidos son FILESYSTEM (la persistencia es en el sistema de ficheros), DATABASE (la persistencia es en la base de datos) o CACHE (los datos se persisten en Cache).
  • Valor por defecto FILESYSTEM
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TITLE_EDITABLE

  • Indica si el título de las peticiones es editable por el usuario o no.
  • Valor por defecto: "true"
  • No obligatorio
  • Disponible desde la versión 3.5.90

ONE_SESSION_PER_USER

  • Indica queremos limitar el número de sesiones de un usuario a una en el backend.
  • Valor por defecto: "false"
  • No obligatorio
  • Disponible desde la versión 3.5.40

PDF_PREVIEW_SERVICE_URL

  • URL del visor de PDF de la página de firma.
  • Valor por defecto: null (Se usa el visor de PDF de documents)
  • No obligatorio
  • Disponible desde la versión 3.5.90

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
  • No obligatorio
  • Disponible desde la versión 3.5.101

BACKEND_NAME

  • Nombre del path del contexto definido en el tomcat que tiene el backend.
  • Valor por defecto: "/documents"
  • No obligatorio
  • Disponible desde la versión 3.5.109

SUPPORTED_LANGUAGES

  • Indica los idiomas que aparecerán en la plataforma.
  • Valor por defecto: "es_ES_Español,en_EN_English"
  • No obligatorio
  • Disponible desde la versión 3.5.120

INPUT_PHONE_DEFAULT_COUNTRY

  • País por defecto que se muestra en los input de los teléfonos.
  • Valor por defecto: "es"
  • No obligatorio
  • Disponible desde la versión 3.5.121

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"
  • No obligatorio
  • Disponible desde la versión 3.5.121

MICROSERVICIOS

SMS_SERVICE_URL

  • Url del servicio de SMS.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

SMS_SERVICE_USER

  • Usuario del servicio de SMS.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

SMS_SERVICE_PASSWORD

  • Contraseña del servicio de SMS.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

OCR_URL_SERVICE

  • Url del servicio OCR.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

OCR_TEMPLATE_PATH

  • Ruta donde se almacenan las plantillas OCR.
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

OCR_TEMPLATES_PROPERTIES_JSON

  • Nombre del fichero JSON con las propiedades de las plantillas OCR
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

GESTDOC_SERVICE

  • Endpoint de acceso del servicio externo gestdoc para el consumo de peticiones externas.
  • No obligatorio
  • Disponible desde la versión 3.5.108

ZOHO_URL

  • Indica queremos suscribir en Zoho a los usuarios que se autoregistren en la plataforma. Este parámetro será la URL del servicio de Zoho.
  • Si se indica este parámetro es obligatorio indicar los parámetros:
    • ZOHO_AUTH_KEY: Clave del API de Zoho.
    • ZOHO_LIST_KEY: Clave de la lista a la que suscribiran los nuevos usuarios.
  • No obligatorio
  • Disponible desde la versión 3.5.110

GEOIP_SERVICE

  • Url del servicio de geolocalización de IP
  • Valor por defecto: null (No está activo)
  • No obligatorio
  • Disponible desde la versión 3.5.90

SHORT_URL_SERVICE_URL

  • Url del servicio de acortamiento de URLS de document
  • Valor por defecto: https://s.viafirma.com
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

SHORT_URL_SERVICE_USER

  • Usuario del servicio de acortamiento de URLS de document
  • Valor por defecto: admin
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

SHORT_URL_SERVICE_PASSWORD

  • Contraseña del servicio de acortamiento de URLS de document
  • Valor por defecto: admin
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

TAREAS AUTOMATIZADAS

JOBS_BACKEND_INTEGRATION

  • Indica si el backend arrancará una instancia del gestor de Jobs de la aplicación. Si esta opción se marca como "false" sería recomendable arrancar al menos una instancia del gestor de jobs como un hilo independiente del backend.
  • Valor por defecto: true
  • No obligatorio
  • Disponible desde la versión 3.5.90

JOB_IMPL

  • Indica el listado de tareas periódicas que se ejecutarán en la plataforma. Será un listado de tareas definidas como una lista separada por comas de pares claseImplementaJob:nombreJob
  • Valor recomendado:
JOB_IMPL=com.viafirma.documents.jobs.quartz.ReportsJob:monthlyreportsjob,com.viafirma.documents.jobs.quartz.ReportsJob:dailyreportjob,com.viafirma.documents.jobs.quartz.ReportsJob:weeklyreportjob,com.viafirma.documents.jobs.quartz.TransferReportJob:transferreportjob,com.viafirma.documents.jobs.quartz.CleanDataBaseJob:cleandatabasejob,com.viafirma.documents.jobs.quartz.TokenExpiredJob:tokenexpiredjob,com.viafirma.documents.jobs.quartz.CheckNotExecutedTaskJob:checknotexecutedtaskjob,com.viafirma.documents.jobs.quartz.CheckExpiredUserJob:checkexpireduserjob,com.viafirma.documents.jobs.quartz.CheckExpiredMessagesJob:checkexpiredmessagesjob,com.viafirma.documents.jobs.quartz.TSALogsJob:tsalogsjob,com.viafirma.documents.jobs.quartz.EmailReminderJob:emailreminderjob,com.viafirma.documents.jobs.quartz.SystemStatusJob:systemstatusjob
  • Valor por defecto: Será el valor recomendado a partir de la versión 3.5.125 (para versiones anteriores no tiene valor por defecto)
  • No obligatorio.
  • Disponible desde la versión 3.5.90

Los Jobs disponibles son:

com.viafirma.documents.jobs.quartz.ReportsJob

Encargado de ejecutar los informes incluidos en la carpeta "reports" de documents-home.

com.viafirma.documents.jobs.quartz.TransferReportJob

Encargado de ejecutar el informe de transferencias.

com.viafirma.documents.jobs.quartz.CleanDataBaseJob

Eliminará documentos y peticiones que correspondan según configuración.

com.viafirma.documents.jobs.quartz.TokenExpiredJob

Marca como expirados los token de acceso que correspondan según configuración.

com.viafirma.documents.jobs.quartz.CheckNotExecutedTaskJob

Comprueba si hay alguna petición que deba ser incluida en el sistema de tareas que debido a algún error no controlado por la plataforma no haya sido añadida anteriormente.

com.viafirma.documents.jobs.quartz.CheckExpiredUserJob

Marca como expirados los usuarios de la plataforma según configuración.

com.viafirma.documents.jobs.quartz.CheckExpiredMessagesJob

Marca como expirados los mensajes correspondientes según configuración.

com.viafirma.documents.jobs.quartz.EmailReminderJob

Encargado de enviar recordatorios a las peticiones según configuración.

com.viafirma.documents.jobs.quartz.TSALogsJob

Encargado de gestionar los logs de peticiones a la TSA.

com.viafirma.documents.jobs.quartz.SystemStatusJob

Encargado de generar información del sistema consultable desde panel de control.

Una vez definidos las diferentes tareas periódicas que serán ejecutadas hay que definir cuando se ejecutarán estas tareas (cron):

Valores recomendados:

systemstatusjob.cron=0 0/10 * * * ?
transferreportjob.cron=0 0 14 * * ?
cleandatabasejob.cron=0 0 0/12 * * ?
tokenexpiredjob.cron=0 0/10 * * * ?
checknotexecutedtaskjob.cron=0 0 0/1 * * ?
checkexpireduserjob.cron=0 0/10 * * * ?
checkexpiredmessagesjob.cron=0 0/1 * * * ?
tsalogsjob.cron=0 0 0/6 * * ?
emailreminderjob.cron=0 0/1 * * * ?
emailreminderjob.jobmap=code:com.viafirma.documents
dailyreportjob.cron=0 15 10 * * ?
dailyreportjob.jobmap=code:daily
weeklyreportjob.cron=0 15 7 ? * MON
weeklyreportjob.jobmap=code:weekly
monthlyreportsjob.cron=0 0 0 1 * ?
monthlyreportsjob.jobmap=code:monthly

TASK_HIKARICP_TIMEOUT

  • Timeout de respuesta del sistema de gestión de tareas
  • Valor por defecto: 20000
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_EXEC_TIMEOUT

  • Timeout de ejecución del sistema de gestión de tareas
  • Valor por defecto: 240
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_CLEAN_PERIOD

  • Tiempo que se mantiene la tarea en BBDD una vez finalizada en el sistema de gestión de tareas
  • Valor por defecto: 3600
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_BATCH_SIZE

  • Valor del batch en el tratamiento de las tareas el sistema de gestión de tareas
  • Valor por defecto: 50
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_ASSIGN_SIZE

  • Número de tareas que asigna a la vez el sistema de gestión de tareas
  • Valor por defecto: 1
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_MAX_IDLE_TIME

  • Tiempo máximo en el que libera del pool una conexión a la base de datos que no este activa en el sistema de gestión de tareas
  • Valor por defecto: 5
  • No obligatorio
  • Disponible desde la versión 3.5.120

TASK_HIKARICP_INMEDIATE_CLEANUP

  • Indica si el borrado de las tareas finalizadas dentro del sistema de gestión de tareas se borran inmediatamente
  • Valor por defecto: true
  • No obligatorio
  • Disponible desde la versión 3.5.120

DEFAULT_CLIENT_SIGNATURE_APP

  • Código de la aplicación por defecto para firma web.
  • Valor por defecto: com.viafirma.documents
  • No obligatorio
  • Disponible desde versiones anteriores a la 3.5

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
  • No obligatorio
  • Disponible desde la versión 3.5.127

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
  • No obligatorio
  • Disponible desde la versión 3.5.142

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
  • No obligatorio
  • Disponible desde la versión 3.5.142

inbox.restApiPathBase

  • URL de viafirma inbox
  • Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
  • No obligatorio
  • Disponible desde la versión 3.5.142

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
  • No obligatorio
  • Valor por defecto: requests
  • Disponible desde la versión 3.5.142

inbox.notificationUrl

  • Url donde notificará Viafirma Inbox trás un cambio de estado. En principio la configuración recomendada debería 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
  • No obligatorio
  • Disponible desde la versión 3.5.142

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
  • No obligatorio
  • Disponible desde la versión 3.5.142

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. Actualmente tenemos las opciones MANDATOS,CONSUM,GENERIC.
  • Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
  • No obligatorio
  • Disponible desde la versión 3.5.142

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. Actualmente tenemos las opciones MANDATOS,CONSUM,GENERIC.
  • Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
  • No obligatorio
  • Disponible desde la versión 3.5.142

inbox.crm.process

  • Implementacion que utilizará para el proceso de envío a los distintos CRM. Actualmente tenemos las opciones MANDATOS,CONSUM,GENERIC.
  • Este parámetro podrá especificarse también como propiedad del grupo y en los metadatos del mensaje
  • No obligatorio
  • Valor por defecto: GENERIC
  • Disponible desde la versión 3.5.142