Page History

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 envian a 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 asignadnoles un 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 expecificos de 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 maximo 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 perioro 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 

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>

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 paramétros 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.evicertia.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}}"}