Management of communication templates

Descripción de la pantalla "Gestión de plantillas de comunicaciones"

La pantalla se compone de:

• 6 pestañas que representan los estados que puede tener una plantillas, estos estados pueden ser:
  • Activa  :  Ha sido aprobada y está disponible para su uso.
  • Borrador  : Esta en proceso de elaboración, no ha sido enviada para su aprobación. No esta disponible para su uso.
  • Pendientes  : Está en proceso de ser aprobada. No está disponible para su uso.
  • Desactivadas : Ha sido aprobada pero el usuario administrador del sitio la ha desactivado. No esta disponible para su uso.
  • Rechazadas : No ha pasado el proceso de aprobación, en su detalle se muestran los motivos. No está disponible para su uso.
• Botón para crear nueva plantilla
  • Este botón permite iniciar la creación de una nueva plantilla.
• Rejilla con las plantillas creadas.
  • Esta rejilla varia en columnas dependiendo de la pestaña activa.
  • Borrador: 
    • Tipo: Muestra el tipo de comunicación asociada a la plantilla. (Puede ser Solicitud de firma, Notificación final o de progreso)
    • Identificador: Muestra el identificador único de la plantilla, en un sitio no puede haber dos identificadores iguales, se usa para hacer referencia a la plantilla desde el API.
    • Última modificación: Muestra la fecha y hora de la última actualización de la plantilla.
    • Editar: Permite editar la plantilla.
    • Eliminar: Permite eliminar una plantilla.

• • Pendientes:
    
    • Tipo: Muestra el tipo de comunicación asociada a la plantilla. (Puede ser Solicitud de firma, Notificación final o de progreso)
    • Identificador: Muestra el identificador único de la plantilla, en un sitio no puede haber dos identificadores iguales, se usa para hacer referencia a la plantilla desde el API.
    • Fecha solicitúd de aprobación: Muestra la fecha y hora en la que se envió la plantilla para su aprobación.
    • Ver plantilla: Icono de acceso para ver el detalle de la plantilla, la plantilla no puede ser modificada.

• • Activas:
    • Tipo: Muestra el tipo de comunicación asociada a la plantilla. (Puede ser Solicitud de firma, Notificación final o de progreso)
    • Identificador: Muestra el identificador único de la plantilla, en un sitio no puede haber dos identificadores iguales, se usa para hacer referencia a la plantilla desde el API.
    • Fecha de activación: Muestra la fecha y hora en la que se aprobó la plantilla.
    • Ver plantilla: Icono de acceso para ver el detalle de la plantilla, la plantilla no puede ser modificada.
    • Desactivar: Permite desactivar una determinada plantilla.

• • Desactivadas:
    • Tipo: Muestra el tipo de comunicación asociada a la plantilla. (Puede ser Solicitud de firma, Notificación final o de progreso)
    • Identificador: Muestra el identificador único de la plantilla, en un sitio no puede haber dos identificadores iguales, se usa para hacer referencia a la plantilla desde el API.
    • Fecha de Desactivación: Muestra la fecha y hora en la que la plantilla fue desactivada.
    • Ver plantilla: Icono de acceso para ver el detalle de la plantilla, la plantilla no puede ser modificada.
    • Activar: Permite Activar una determinada plantilla.
    • Eliminar: Permite eliminar una plantilla, transcurrido dos meses desde su desactivación.

• • Rechazadas:
    • Tipo: Muestra el tipo de comunicación asociada a la plantilla. (Puede ser Solicitud de firma, Notificación final o de progreso)
    • Identificador: Muestra el identificador único de la plantilla, en un sitio no puede haber dos identificadores iguales, se usa para hacer referencia a la plantilla desde el API.
    • Fecha de rechazo: Muestra la fecha y hora en la que la plantilla fue rechazada.
    • Ver plantilla: Icono de acceso para ver el detalle de la plantilla, la plantilla no puede ser modificada.
    • Borrador: Permite eliminar una plantilla, transcurrido dos meses desde su desactivación.

Crear nueva plantilla

Pulsando el botón se abre una ventana modal, que permite la creación de una nueva plantilla.

La pantalla modal se compone de dos pestañas, detalle y previsualización. 

• Detalle: Pestaña donde se configura la plantilla, con los siguientes datos Tipo de plantilla, identificador, contenido y variables (de sistema y de usuario).
• Previsualización: Pestaña donde el usuario comprueba si la configuración es correcta, antes de enviar la plantilla para su aprobación. Es necesario guardar los datos de la plantilla antes de pasar a la pestaña de previsualización.

• Tipo de plantilla :  Este campo de selección permite al usuario seleccionar el tipo de plantilla, este tipo informa sobre el uso que se dará al correo electrónico generado con la plantilla. Los tipos de plantillas que puede seleccionar un usuario son los siguientes
  • Solicitúd de firma (SignatureRequest): Para los emails de solicitud de firma (y recordatorios) que se envían a los firmantes de EviSign.
  • Notificación final (FinalNotification): Para los email de notificación  final que se envían a los firmantes de un EviSign
  • Progress (Progress): Para los email de comunicaciones que informan al firmante y emisor sobre el progreso de un EviSign (Rechazos, Firmas, Expiraciones)
• Identificador de plantilla: Este campo permite al usuario, establecer un identificador a la plantilla, este identificador es necesario informar para hacer uso de la plantilla, para un sitio no puede haber dos identificadores iguales.
• Contenido de plantilla: Este campo es donde el usuario creará la plantilla de la comunicación, esta plantilla estará definida con HTML, y puede incluir contenido de lenguaje de programación Liquid.
• Variables: El contenido de plantillas puede contener variables, que durante la emisión pueden informarse asignándoles un valor. Hay dos tipos de variables
  • Variables de sistema: Son variables que usa el sistema actualmente para compone una plantilla, estas variables contienen datos específicos de la evidencia emitida. Ver más detalle de este tipo de variables en el apartado "Variables de plantillas".
  • Variables de usuario: Estas variables son creadas por el usuario al confeccionar la plantilla. Se usan dentro del contenido de la plantilla para informar datos que las variables de sistema pueden informar. 

Una vez que el usario ha seleccionado tipo de plantilla, introducido un identificador, configurado el contenido de la plantilla con las variables oportunas puede previsualizar el resultado, previamente pulsando el botón guardar .

En la pantalla de previsualización, aparecerá un Grid, con las variables de sistema obligatorias para ese tipo de plantilla y las variables de usuario que se hayan configurado anteriormente. Al lado de estas variables una caja de texto permite editar valores para ver como quedaría el resultado al renderizar la plantilla. 

Para visualizar la plantilla el usuario debe pulsar el botón previsualizar . En ese momento el sistema renderiaza el HTML del contenido, sustituye las variables por los valores de prueba y se muestra por pantalla.

En este punto el usuario, puede decidir si hacer alguna modificación mas a la plantilla o "Solicitar la aprobación".  Pulsando el botón se inicia un proceso de validación en el cual habrá una validación automática y una validación manual.

• Validación automática: El sistema comprueba que el contenido de la plantilla esta configurado correctamente, que se han usado las variables de sistema obligatorias para ese tipo de plantilla, y que no se esta usando componentes no permitidos. (Ver componentes restringidos)
• Validación manual: Nuestro personal de soporte comprueba de una manera exaustiva, apoyado por documentación, que el contenido de la plantilla es acorde al tipo de plantilla seleccionado. Una vez comprobado y visto que esta todo correcto, el personal de soporte da por aprobada la plantilla y esta pasa a estar activa.

Eliminar plantilla

Una plantilla puede ser eliminada cuando se encuentra en estado borrador o desactivada, en el caso del estado desactivada solo podrá eliminarse cuando ha pasado un periodo de dos meses, ya que es el tiempo máximo de vida de un EviSign.

• Borrador: Una plantilla puede ser eliminada siempre que se encuentre en estado borrador. Para ello se puede borrar directamente desde el Grid, pulsando en el icono  de la plantilla o entrando en editar plantilla y pulsando el botón eliminar

• Desactivada: Una plantilla desactivada solo puede ser eliminada cuando ha pasado en dicho estado por un periodo de dos meses. Se puede borrar una plantilla desde el Grid de plantillas, pulsando en el icono o dentro del detalle de la misma , pulsando el botón 

Desactivar una plantilla

Una plantilla activa puede ser desactivada por el usuario administador. Cuando una plantilla está en estado Desactivada no puede ser usada en los envíos.

Para desactivar una plantillla se debe acceder a la pestaña "Activas".

Las plantillas se pueden desactivar directamente desde el Grid mediante el icono o entrando en el detalle de la plantilla y pulsando en el botón .  Al realizar una de las dos acciones, se informa al usuario que la plantilla en estado desactivada no podrá usarse en las comunicaciones y si ofrece la opción de continuar o cancelar la desactivación.

Guía de buenas prácticas para crear una plantilla

Para crear una una nueva plantilla y que sea aprobada, es conveniente tener en cuenta los siguientes aspectos:

• Evitar exceso de imágenes: El uso excesivo de imágenes puede afectar la capacidad de la plantilla de carga en el correo electrónico, lo que a su vez puede disminuir la tasa de apertura. Por lo tanto, se recomienda tener un número limitado de imágenes y mantener su tamaño bajo control. En cuanto a la solicitud de convertir las imágenes a "inline" en base64, esto ayuda a reducir el tamaño total del correo electrónico, lo que facilita la carga y la renderización del mismo.

  • Convertir ‘inline’ (en base64) las imágenes para reducir la carga de la renderización.

    Ejemplo imagen base 64 inline

    <html>
      <body>
        <h1>Bienvenido</h1>
        <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." alt="imagen">
        <p>Este es un ejemplo de correo electrónico con una imagen.</p>
      </body>
    </html> 

  • Las plantillas no deben contener más de 3 imágenes.
  • La suma de las imágenes y el contenido no debe superar el tamaño de archivo de 1MB.
• Componentes restringido: El siguiente contenido no se podrá usar en las plantillas para evitar que los gestores de correo bloqueen los correos electrónicos por sospechas.
  • javascript
  • gifs animados (siempre que sea posible)
  • <iframe>
  • audio incrustado
  • vídeo incrustado
  • formularios

• Enlaces sospechosos: No se debe hacer uso de enlaces sospechosos en la plantilla.

• Texto apropiado para el tipo de notificación de la plantilla:  Es importante que el texto de la plantilla sea claro, conciso y apropiado para el tipo de plantilla que se esta creando.  Debe ser fácil de entender y no generar confusión para el destinatario. A continuación se detallan los distintintos tipos de plantilla separados por producto:
  • EviSign 
    • Solicitud de firma/Recordatorio de firma: El texto debe hacer referencia a la solicitud de una firma por parte del emisor.
    • Notificación final: El texto debe ser claro indicando que es una notificación final del proceso de firma, donde se dan las pautas para obtener los Affidavits.
      • Texto que indica que es una notificación final
      • Pasos para el acceso a las evidencias generadas
      • Enlace a las evidencias generadas.
      • Debe contener las variables obligatorias para este tipo de plantilla. 
    • Progreso: Mediante uso de código de programación Liquid, se puede usar este tipo de plantilla para comunicar los siguientes estados (Rechazado, Firmado, y Expirado)
      • Rechazado: El texto debe ser claro informando que ha habido un rechazo del documento principal por uno de los firmantes. Debe contener las variables obligatorias para este tipo de plantilla. 
      • Firmado: El texto debe ser claro informando que ha habido una aceptación del documento principal por uno de los firmantes. Debe contener las variables obligatorias para este tipo de plantilla. 
      • Expirado: El texto debe ser claro informando que un proceso de firma ha expirado sin ser firmado. Debe contener las variables obligatorias para este tipo de plantilla.

• Texto que evite ser catalogado como spam o sospechoso de phising: Para evitar ser etiquetado como spam, es importante utilizar un lenguaje claro y sencillo en el contenido de los correos electrónicos, y evitar el uso excesivo de palabras sospechosas o sensacionalistas. Además, es importante no utilizar palabras que puedan engañar a los destinatarios para que abran el correo electrónico, ya que esto puede ser considerado como prácticas de phishing o engañosas.

• El botón de firma debe estar visible para el firmante: En el caso de EviSign y el tipo de plantilla solicitud de firma, el botón de acceso al proceso de firma debe estar claramente visible para el destinatario, de modo que pueda identificar fácilmente cómo proceder con la firma. El botón debe tener un enlace que se establece con variables de sistema.

• Debe aparecer el enlace al proceso de firma: En el caso de EviSign y el tipo de plantilla solicitud de firma, además del botón de firma también es obligatorio que aparezca el enlace de acceso al proceso de firma. Este enlace se establece mediante el uso de variables de sistema.

• Debe aparecer texto con la política GDPR:  Este texto debe mencionar que Evicertia actuará como Responsable de tratamiento en comunicaciones directas a notificados y/o firmantes. El texto debe ser algo similiar al siguiente:

  GDPR

  Evicertia es un servicio de EVICERTIA S.L. (NIF ESB86021839) que como prestador de servicios de certificación, asume el rol de tercero de confianza, según las exigencias de la normativa europea y latinoamericana vigente en materia de comercio y firma electrónicos.
  Evicertia está gestionada por auditores certificados y expertos en seguridad informática, que le protegen como testigos independientes de las comunicaciones y declaraciones de voluntad que se realizan a través de ella.
  Evicertia ha recibido el reconocimiento de prueba con validez legal por el Tribunal Supremo de España (auto de casación de 21/03/2013 núm. 855/2010 de la Sala 1ª).
  EVICERTIA S.L. le informa que sus datos personales han sido obtenidos a través del emisor de esta comunicación/notificación electrónica y que serán tratados con la única finalidad de poner a su disposición los documentos emitidos por el emisor para su firma o notificación, obtener evidencias del proceso y conservarlas durante el plazo contractual y legalmente establecido. El destinatario puede ejercitar sus derechos dirigiendo un escrito a support@evicertia.com, indicando en la referencia “Protección de Datos”. Puede consultar información adicional sobre sus derechos o el tratamiento de sus datos en https://www.evicertia.com/en/privacy-policy. Asimismo, puede dirigirse a la autoridad nacional si considera que sus derechos han sido vulnerados. Igualmente, puede obtener más información del servicio en la web: www.evicertia.com.
  Este mensaje va dirigido, de manera exclusiva, a su destinatario, y puede contener información confidencial y/o sujeta a secreto profesional, cuya divulgación no está permitida por ley.
  En caso de haber recibido este mensaje por error, o tiene cualquier duda sobre la seguridad del proceso, le rogamos que, de forma inmediata, nos lo comunique mediante correo electrónico remitido a nuestra atención en support.evicertia.com o por correo electrónico a support@evicertia.com.
  
  

  Este texto se puede componer con ayuda de variables de sistema para los enlaces y direcciones de correo electrónico.

Variables en plantillas

Las variables se dividen en variables de sistema y de usuario.

Variables de sistema:

Son variables que tiene configurada la aplicación y que obtienen su valor de datos de evidencia enviada o de datos globales que son compartidos por todos los sites de la plataforma.

Variables de usuario:

Son variables que declara el usuario durante la creación de la plantilla. Estas variables pueden ser usadas en el contenido de la plantilla que esta creando y a la hora de hacer uso de la plantilla mediante servicio web se informan las variables y su valor.

Estas variables solo se pueden crear en tiempo de diseño de la plantilla, cuando esta en estado borrador. En la pestaña de detalle en la parte inferior aparece inicialmente una tabla de variables. Pulsando el botó se añade una fila al Grid permitiendo introducir una variable de usuario, para definir una variable de usuario debe configurar:

• Variable : Nombre de la variable, con el que hacer referencia en el contenido y en la llamada al Servicio Web.
• Valor: Se debe establecer una valor de prueba, para que el usuario administrador del site y la persona del equipo de soporte puedan previsualizar el resultado.
• Requerido: Este check indica si la variable debe ser informada siempre. 
  • True: Debe ser informada en cada petición
  • False: No es obligatorio informar en cada petición.

Para eliminar una variable introducida por error o por cualquier otro motivo, se debe pulsar en el icono que aparece en la linea del Grid correspondiente a la variable que se desea eliminar.

 Una vez declaradas las variables, se puden hacer uso de ellas en el contenido HTML de la plantilla. Para distinguir las variables de usuario de las de sistema el nombre de la variable debe contener el prefico variables y estar entre llaves, ejemplo:

• Se declaran la variables PostalAddress, PostalCode y se quiere hacer referencia de ellas en el contenido, para ello en el parte del contenido que interese introducir el codigo postal se escribiria {variables.PostalCode}  y en la partque interese introduir la dirección postal se escribirá  {variables.PostalAddress}.

A continuación se muestra un pequeño ejemplo que usa variables de sistema y de usuario.

<html>
<head>
</head>
<p>Solicitud de firma de <b>{Issuer}</b> , sobre <b>{Subject} </b></p>
<table><tr><td>Nombre del firmante: </td><td>{Signer}</td></tr></table>
<table><tr><td>Dirección del firmante: </td><td><b>{variables.PostalAddress}</b> CP: {variables.PostalCode} </td></tr></table>
<a href="{DeliveryURL}" class="buttonread">FIRMA DE DOCUMENTACIÓN</a>
</html>

Uso de lenguaje de programción Liquid en las plantillas

Una parte importante de la customización de plantillas es que se puede usar lenguaje de programción Liquid a la hora de definir el contenido de la plantilla, esto va a permitir que una misma plantilla sea dinamica y cambie dependiendo de los valores de las variables.

Para aprender algo sobre este lenguajde de programación te recomendamos visitar los siguientes enlaces.

• https://shopify.github.io/liquid/
• https://github.com/dotliquid/dotliquid/

Usar plantillas desde Servicio Web

A continuación se detalla como hacer referencia a una plantilla en el momento de la emisión. 

EviSign

Para este producto se puede establecer una serie de plantillas diferentes por Firmante/Revisor. Para ello en el  API  EviSignSubmit se ha creado los siguientes parámetros dentro del objeto SigningParties. 

• Para el uso de plantillas de tipo solicitud de firma: 
  • SignatureRequestTemplateName: Contiene el identificador de la plantilla que se desea usar en la comunicación.
  • SignatureRequestTemplateValues: Contiene un array de claves valor, donde se informan las variables definidas en el contenido de la plantilla y el valor que recibe en la emisión. 
• Para el uso de plantillas de tipo notificación final:
  • FinalNotificacionTemplateName: Contiene el identificador de la plantilla que se desea usar en la comunicación.
  • FinalNotificacionTemplateValues:  Contiene un array de claves valor, donde se informan las variables definidas en el contenido de la plantilla y el valor que recibe en la emisión. 
• Para el uso de plantillas de tipo progreso:
  • ProgressNotificationTemplateName: Contiene el identificador de la plantilla que se desea usar en la comunicación.
  • ProgressNotificationTemplateValues:  Contiene un array de claves valor, donde se informan las variables definidas en el contenido de la plantilla y el valor que recibe en la emisión. 

POST /api/EviSign/Submit HTTP/1.1
Host: app.ecertia.com
Authorization: Basic *******************
Content-Type: application/json

{
"subject":"EviSign Básico un firmante",
"issuer":"Demo evisign basico",
"signingParties":[
{
    "name":"Lara Lor Van",
    "legalName":"123456789A",
    "address":"LaraLorVan@mailtest.es",
    "signingMethod":"EmailPIN",
    "SigningOrder": "1",
    "SignatureRequestTemplateName":"Template01",
    "SignatureRequestTemplateValues" : [{"postalAddress":"C/ Luna 01 Tierra3 29334"},{"jobOffered":"Analista"}],
    "FinalNotificacionTemplateName":"Template02",
    "FinalNotificacionTemplateValues" : [{"postalAddress":"C/ Luna 01 Tierra3 29334"},{"jobOffered":"Analista"}],
    "ProgressNotificationTemplateName":"Template04",
    "ProgressNotificationTemplateValues" : [{"postalAddress":"C/ Luna 01 Tierra3”}],
"document":"{{documento principal en Base 64}}"}