Campos Personalizados
Última revisión: 07 septiembre 2023
Se trata de configuración genérica que podrá usarse para distintos propósitos a nivel de grupo. Su uso está basado en parámetros de configuración compuestos por pares “clave/valor”, que podrán ser añadidos manualmente o bien importados desde fichero de importación basado en excel y cuya plantilla podrás descargar desde la propia pantalla de configuración.
Solo un ADMIN global podrá añadir campos “privados”, no visibles para usuarios ADMIN-GROUP. Para ello el ADMIN global solo tendrá que marcar el check “Admin” durante la creación del campo personalizado.
¿Cómo se añaden campos personalizados?
CLAVE: siempre debes indicar una clave en mayúsculas, y no debes usar espacios en blanco, tildes, ni otros signos de puntuación o caracteres distintos a números y letras. Por ejemplo:
COD_DEPARTAMENTO
.VALOR: podrás indicar el valor que corresponda y necesites para cada caso, teniendo en cuenta que para CLAVES internas de sistema el valor que necesitas usar debe ser, explícitamente, el que se indique en cada caso para conseguir una funcionalidad específica.
No exportable: si marcamos este check, estos campos personalizados no serán heredables si creamos subgrupos con el botón "Nuevo grupo" que encontrarás al final de esta misma sección.
NOTA: consulta cuáles son las claves internas de sistema para conocer qué funcionalidades extra puedes automatizar.
¿Dónde puedo usar un campo personalizado?
Podrás hacer uso del campo personalizado como una variable dinámica a definir en los distintos puntos de configuración del sistema utilizando el prefijo SYS_GROUP_
, tal y como te explicamos en los siguientes ejemplos.
Uso de campos personalizados en plantillas
- Título y Descripción:, por ejemplo:
Contrato de alta asociado al departamento {{SYS_GROUP_COD_DEPARTAMENTO}}
.
- Notificaciones: en cualquiera de las configuraciones disponibles para todo el ciclo de vida de notificaciones del documento, por ejemplo:
Hola {{cliente}}
, aquí tienes el contrato emitido por el departamento {{SYS_GROUP_COD_DEPARTAMENTO}}
listo para su revisión y firma.
- Políticas: cualquier evidencia, firma, adjunto o aprobación que permita incluir textos de ayuda podrán incluir variables dinámicas, y también variables asociadas a campos personalizados de grupo. Por ejemplo, en la firma desatendida con certificado digital se podría incluir el siguiente texto:
Aprobado por el departamento {{SYS_GROUP_COD_DEPARTAMENTO}}
.
- Configuración: podrás incluir campos personalizados de grupo como variables dinámicas en distintos elementos de configuración a nivel de plantilla, por ejemplo, definir la URL a la que se hará una petición POST una vez finalizada la operación de firma = `````` .
En ejemplo anterior, para un supuesto grupo “G1”, todas las plantillas asignadas a dicho grupo podría incluir en su configuración una URL de respuesta automática al CRM de la compañía. Y de esta forma, el “editor” de la plantilla no tendría que conocer cuál es exactamente el valor del la URL, solo tendría que indicar el campo personalizado, que haría uso del valor indicado por su administrador.
Funcionalidades específicas
Podrás hacer uso de campos personalizados especiales para activar ciertas funcionalidades en tu grupo. A continuación te listamos algunas de ellas.
Configuraciones Opcionales para el envío de correos electrónicos (EMAIL / SMTP)
El grupo tiene configurado por defecto un servicio de correo electrónico gestionado por Viafirma. Si necesitas hacer uso de un servidor privado, o aplicar configuraciones adicionales sobre el mismo, revisa cuáles son las opciones que tienes para hacerlo a nivel de grupo. En la siguiente tabla encontrarás todos los campos personalizados disponibles.
Campo | Descripción | Valores |
---|---|---|
MAIL_CALLBACK_ATTACHMENT_AUDIT | Adjuntar el audit-trail (PDF) en el correo de respuesta automática tras la finalización del proceso de firma. | true |
MAIL_CALLBACK_ATTACHMENT_PDF | Adjuntar el PDF firmado en el correo de respuesta automática tras la finalización del proceso de firma. | true |
MAIL_CALLBACK_ATTACHMENT_XML | Adjuntar el XML de la soliciud en el correo de respuesta automática tras la finalización del proceso de firma. | true |
MAIL_HOST_NAME | url o IP del servidor de correos | |
MAIL_PORT | puerto utilizado por el servidor de correos | |
MAIL_SSL | activa o desactiva la seguridad SSL para el envío de correos | true,false |
MAIL_TLS | activa o desactiva la verificación TLS en la configuración del servidor de correos | true,false |
MAIL_SSL_PORT | puerto utilizado por el SSL del servidor de correos | |
MAIL_START_TLS | activa o desactiva la propiedad START TLS disponible en algunos servicios de correos | true,false |
MAIL_SMTP_USER | usuario de las credenciales del servicio de correos | |
MAIL_SMTP_PASS | contraseña del servidor de correo. | |
MAIL_FROM | valor para la propiedad "From" mostrada en los clientes de correo. | |
MAIL_FROM_NAME | valor para la propiedad "From Name" gestionada en algunos clientes de correo. | |
MAIL_BCC | por defecto los destinatarios van en copia oculta. Para evitarlo puedes incluir esta configuración con valor false. | true,false |
Configuraciones Opcionales Logo de Grupo
Campo | Descripción | Valor de Ejemplo |
---|---|---|
CUSTOM_LOGO_TITLE | Título asociado al logo personalizado del grupo | My Title Logo |
CUSTOM_LOGO_URL | URI del logo personalizado del grupo. | http://mycustomlogo.png |
Configuración Descarga Documentos Firmados
Campo | Descripción | Valor de Ejemplo |
---|---|---|
DOWNLOAD_EXPIRE_MINUTES | El link generado para la descarga de documentos firmados tiene una caducidad por defecto de 10 minutos. | 5 |
Configuración del formato de firma por defecto
Las firmas con certificado digital, a nivel cliente y a nivel servidor, hacen uso de formatos por defecto:
- para la firma de PDF: PADES_B
- para la firma de XML: XADES_B
- para la firma de los XML donde se consolidan las evidencias electrónicas: XADES_B
- para la firma de otros documentos binarios: CADES_B
- para la firma de los adjuntos (vídeo, audio, imágenes): CADES_B
Para que tu grupo haga uso de otros formatos por defecto puedes aplicar las siguientes variables de configuración.
Campo | Descripción | Valor de Ejemplo |
---|---|---|
TYPE_FORMAT_SIGN_PDF | Formato de firma para PDF. | PADES_B,PADES_T,PADES_LT,PADES_LTA |
TYPE_FORMAT_SIGN_XML | Formato de firma para XML y firma de evidencias electrónicas. | XADES_B,XADES_T,XADES_LT,XADES_LTA |
TYPE_FORMAT_SIGN_CADES | Formato de firma para adjuntos de tipo imagen, vídeo y audio. | CADES_B,CADES_T,CADES_LT,CADES_LTA |
Firma desatendida con certificado centralizado en Fortress
En Documents puedes hacer uso de un certificado centralizado en Fortress en tus procesos de firma desatendida, ideal para sellos electrónicos de tu compañía. Para ello solo debes agregar en los campos personalizados de tu grupo la siguiente propiedad:
Campo | Descripción | Valor de Ejemplo |
---|---|---|
FORTRESS_CERTIFICATE_ID | Código del certificado instalado en un grupo o sistema cliente de Fortress | 432e4b336c2771e8 (debe coincidir con el valor el código del certificado que previamente has debido instalar en Fortress, a nivel de grupo o sistema cliente) |
Configuración de un certificado asociado a un sistema cliente en Fortress:
Con esta configuración, todos los documentos gestionados en tu grupo serán firmados automáticamente con este certificado, a excepción de aquellos en los que hayas definido de forma explícita el uso de otro certificado, ya sea centralizado o cliente.
IMPORTANTE: para hacer uso de esta funcionalidad tu grupo debe estar configurado previamente con un sistema cliente en Fortress. En la sección "Configuración de Fortress" te explicamos cómo hacerlo.
Integración con Viafirma Inbox
Campo | Descripción | Valor de Ejemplo |
---|---|---|
inbox.apikey | API key generada por un administrador de Inbox | - |
inbox.apipass | API pass generada por un administrador de Inbox | - |
inbox.crm.callback | URL del servicio al que Documents hará callback. | (https://sandbox.viafirma.com/documents-crm-example/inboxCrmResponse) |
inbox.crm.process | Por defecto implementamos el proceso GENERIC. | GENERIC |
inbox.notificationUrl | URL del servicio al que Inbox hará callback. Este servicio puede ser expuesto por una aplicación de terceros o incluso por Viafirma Documents, quien dispone de un servicio "connect". | https://sandbox.viafirma.com/documents-web/connect |
inbox.restApiPathBase | - | https://testservices.viafirma.com/inbox/api/v3/ |
Configuración de integraciones con Terceros
Si tu grupo hace uso de evidencias electrónicas que hacen uso de servicios externos como CIFIN, LISIM, Experian, Gradiant, Addalia, Rubricall, etc., aquí podrás agregar la parametrización necesaria y que te haya facilitado el proveedor. Para cada caso deberás usar el nombre del propiedad que te hayan confirmado debas usar. Consulta cuál es tu caso y recibirás información detallada.
Configuración Servicio Firma Centralizada con ANDES CA (Colombia)
Campo | Descripción | Valor de Ejemplo |
---|---|---|
ANDES_URL | URL del servicio facilitado por el proveedor ANDES CA. | https://ra.andesscd.com.co/test/WebService/soap-server_new.php |
ANDES_USER | API User facilitado por el proveedor ANDES CA. | - |
ANDES_PASSWORD | API Password facilitado por el proveedor ANDES CA. | - |
Nota: además de agregar esta configuración es necesario incluir cambios en el JSON de configuración de estilos de la página de firma asociada al grupo.
"allowedSignType" : "ANDES_CA"
En esta guía te explicamo cómo hacerlo: Configuracion de Estilos
LISIM (Colombia)
Campo | Descripción | Valor de Ejemplo |
---|---|---|
LISIM_SERVICE_URL | URL facilitada por el proveedor LISIM. | https://yourserviceprovider.com |
results matching ""
No results matching ""