Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

From the management of communication templates, the administrator user can create different types of communication templates and use the most appropriate one for each mailing.

To access the communication template management, it is necessary that the site has the "Communication template management" functionality activated. If the site has the functionality activated, only the site administrator user can access it from the "Organisation details" page. There you will find a link "Communication template management

Desde la gestión de plantillas de comunicación, el usuario administrador puede confeccionar distintos tipos de plantillas de comunicación y usar la mas indicada para cada envío.

Para acceder a la gestión de plantillas de comunicación, es necesario que el sitio tenga activada la funcionalidad "Gestión de plantillas de comunicaciones". Si el sitio tiene la funcionalidad activada, solo el usuario administrador del sitio puede acceder desde la página "Datos de la organización". Ahí encontrará un enlace "Gestión de plantillas de comunicaciones". 


Crear nueva plantilla

Pulsando el botón Image Removed 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.

Image RemovedImage Removed

  • 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 Image Removed.

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 Image Removed. En ese momento el sistema renderiaza el HTML del contenido, sustituye las variables por los valores de prueba y se muestra por pantalla.

Image Removed

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 Image Removed 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 Image Removed de la plantilla o entrando en editar plantilla Image Removed y pulsando el botón eliminar Image Removed

Image Removed

Image Removed

  • 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 Image Removed o dentro del detalle de la misma Image Removed, pulsando el botón Image Removed

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".

Image Removed

Las plantillas se pueden desactivar directamente desde el Grid mediante el icono Image Removed o entrando en el detalle de la plantilla Image Removed y pulsando en el botón Image Removed.  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.

Image Removed

Expand
titleDescripción de la pantalla "Gestión de plantillas de comunicaciones"Description of the "Communication template management" screen

Description of the "Communication template management" screen


The screen consists of:

  • 6 tabs that represent the states that a template can have, these states can be:
    • Active Image Added :  It has been approved and is available for use.
    • Draft Image Added : It is in the process of being developed, it has not been sent for approval. It is not available for use.
    • Pending  Image Added : It is in the process of being approved. It is not available for use.
    • Deactivated Image Added: It has been approved but has been disabled by the site administrator user. It is not available for use.
    • Rejected Image Added: It has not passed the approval process, in its detail the reasons are shown. Not available for use.
  • Button to create new template Image Added
    • This button allows you to start the creation of a new template.Rejilla con las plantillas creadas.
    • This grid varies in columns depending on the active tab.
    • Draft: 
      • Type: Displays the type of communication associated with the template (can be Signature Request, Reminder Request, Final Notification or Progress Notification).

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 Image Removed :  Ha sido aprobada y está disponible para su uso.
    • Borrador Image Removed : Esta en proceso de elaboración, no ha sido enviada para su aprobación. No esta disponible para su uso.
    • Pendientes Image Removed : Está en proceso de ser aprobada. No está disponible para su uso.
    • Desactivadas Image Removed: Ha sido aprobada pero el usuario administrador del sitio la ha desactivado. No esta disponible para su uso.
    • Rechazadas Image Removed: 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 Image Removed
    • 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.
      • Last modification: Displays the date and time of the last template update.
      • Edit: Allows you to edit the template.
      • Delete: Allows you to delete a templateEliminar: Permite eliminar una plantilla.

    • PendientesPendings:
      • 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.

Image Removed

    • 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.

Image Removed

    • 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.

Image Removed

    • 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.

Image Removed

Expand
titleCrear nueva plantilla
Expand
titleEliminar plantilla
Expand
titleDesactivar una plantilla
      • Type: Displays the type of communication associated with the template (can be Signature Request, Final Notification or Progress Notification).
      • Identifier: Shows the unique identifier of the template, in a site there cannot be two equal identifiers, it is used to make reference to the template from the API.
      • Approval request date: Shows the date and time the template was sent for approval.
      • View template: Access icon to view the template detail, the template cannot be modified.

Image Added

    • Active :
      • Type: Displays the type of communication associated with the template (can be Signature Request, Final Notification or Progress Notification).
      • Identifier: Shows the unique identifier of the template, in a site there cannot be two equal identifiers, it is used to make reference to the template from the API.
      • Activation date: Shows the date and time when the template was approved.
      • View template: Access icon to view the template detail, the template cannot be modified.
      • Deactivate: Allows you to deactivate a certain template.

Image Added

    • Deactivated:
      • Type: Displays the type of communication associated with the template (can be Signature Request, Final Notification or Progress Notification).
      • Identifier: Shows the unique identifier of the template, in a site there cannot be two equal identifiers, it is used to make reference to the template from the API.
      • Deactivation Date: Shows the date and time when the template was deactivated.
      • View template: Access icon to view the template detail, the template cannot be modified.
      • Activate: Allows to activate a certain template.
      • Delete: Allows the deletion of a template, two months after its deactivation.

Image Added

    • Rejected:
      • Type: Displays the type of communication associated with the template (can be Signature Request, Final Notification or Progress Notification).
      • Identifier: Shows the unique identifier of the template, in a site there cannot be two equal identifiers, it is used to make reference to the template from the API.
      • Rejection date: Shows the date and time when the template was rejected.
      • Rejection date: Shows the date and time when the template was rejected.
      • Draft: Allows the deletion of a template, two months after its deactivation.

Image Added


Expand
titleCreate new template

Create new template


Pressing the buttonImage Added a modal window opens, allowing the creation of a new template.

The modal screen consists of two tabs: detail and preview. 

  • Detail: Tab where the template is configured, with the following data Template type, identifier, content and variables (system and user).
  • Preview: Tab where the user checks if the configuration is correct, before sending the template for approval. It is necessary to save the template data before going to the preview tab.

Image AddedImage Added


  • Template Type : This selection field allows the user to select the type of template, this type informs about the use that will be given to the email generated with the template. The types of templates that a user can select are the following:
    • SignatureRequest (SignatureRequest): For signature request emails sent to EviSign signers.
    • Final Notification (FInalNotification): For final notification emails sent to signatories of an EviSign.
    • Progress (Progress): For email communications that inform the signer and sender about the progress of an EviSign (Rejections, Signatures, Expirations).
    • SignatureReminder (SignatureReminder): For signature reminder emails.
    • Notification Template (NotificationTemplate): To customize EviNotice notification e-mails
  • Template identifier: This field allows the user to set an identifier to the template, this identifier is necessary to inform to make use of the template, for a site there cannot be two equal identifiers.
  • Template content: This field is where the user will create the communication template, this template will be defined with HTML, and may include Liquid programming language content.
  • Variables: The content of templates can contain variables, which during output can be reported by assigning them a value. There are two types of variables
    • Environment variables: These are variables that are currently used by the environment to compose a template, these variables contain specific data of the issued evidence. See more details of this type of variables in the section "Template variables".
    • User variables: These variables are created by the user when creating the template. They are used within the template content to report data that system variables can report. 

Once the user has selected the type of template, entered an identifier, configured the content of the template with the appropriate variables, the result can be previewed by pressing the save button. Image Added.

In the preview screen, a Grid will appear, with the mandatory system variables for that type of template and the user variables that have been previously configured. Next to these variables a text box allows you to edit values to see how the result would look like when rendering the template. 

To view the template, the user must click on the preview button. Image Added. At this point the system will render the HTML of the content, replace the variables with the test values and display it on the screen.

Image Added

At this point the user can decide whether to make any further modifications to the template or "Request Approval".  Pressing the button Image Added a validation process starts in which there will be an automatic validation and a manual validation.

  • Automatic validation: The system checks that the content of the template is correctly configured, that the mandatory system variables have been used for that type of template, and that no non-allowed components are being used (see restricted components).
  • Manual validation: Our support staff checks in an exhaustive way, supported by documentation, that the content of the template is in accordance with the type of template selected. Once the template has been checked and found to be correct, the support staff approves the template and it becomes active.


Expand
titleDelete template

Delete template


A template can be deleted when it is in draft or deactivated status, in the case of deactivated status it can only be deleted when a period of two months has passed, as this is the maximum life time of an EviSign.

  • Draft: A template can be deleted as long as it is in draft status. To do so, it can be deleted directly from the Grid by clicking on the icon Image Added of the template or by going to edit template Image Added  and pressing the delete button Image Added

Image Added


Image Added

  • Deactivated: A deactivated template can only be deleted when it has been deactivated for a period of two months. A template can be deleted from the Template Grid, by clicking on the iconImage Added or within the detail of the same Image Added, by pressing the button Image Added



Expand
titleState flow of a template

State flow of a template


A linear diagram of the states through which a template can pass is shown below.


Image Added



Expand
titleBest practice guide for creating a template

Best practice guide for creating a template


To create a new template and have it approved, the following aspects should be taken into account:

  • Avoid excessive images:  Excessive use of images can affect the ability of the template to load in the email, which in turn can decrease the open rate. Therefore, it is recommended to have a limited number of images and keep their size under control. As for the request to convert images to "inline" in base64, this helps to reduce the overall size of the email, which makes it easier to load and render the email.

    • Convert 'inline' (base64) images to reduce rendering overhead.

      Code Block
      languagexml
      titleEjemplo imagen base 64 inline
      <html>
        <body>
          <h1>Bienvenido</h1>
          <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIA..." alt="imagen">
          <p>This is an example of an e-mail with an image
Expand
titleGuía de buenas prácticas para crear una plantilla

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.

      Code Block
      languagexml
      titleEjemplo 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.

Image Removed


    • Templates must not contain more than 3 images larger than 48x48 pixels.
    • templates must not contain more than 8 images smaller than 48x48 pixels (usually used for social network icons). 
    • The sum of images and content must not exceed a file size of 1MB.
  • Restricted components: The following content cannot be used in templates to prevent mail managers from blocking emails on suspicion.
    • javascript
    • animated gifs (whenever possible)
    • <iframe>
    • embedded audio
    • embedded video
    • forms.
  • Suspicious links: Suspicious links should not be used in the template.

  • Appropriate text for the type of notification of the template:  It is important that the template text is clear, concise and appropriate for the type of template being created.  It should be easy to understand and not confusing to the recipient. Below are the different types of templates separated by product:
    • EviSign 
      • Signature Request/Signature Reminder:
        • The text should refer to the issuer's request for a signature.
        • It must contain the mandatory variables for this type of template. 
      • Final Notification: The text must be clear that it is a final notification of the signing process, where the guidelines for obtaining the Affidavits are given..
        • Text indicating that it is a final notification.
        • Steps for accessing generated evidence
        • Link to the evidence generated.
        • It must contain the mandatory variables for this type of template. 
      • Progress: Using Liquid programming code, this type of template can be used to communicate the following statuses (Rejected, Signed, and Expired)
        • Rejected: The text must be clear informing that there has been a rejection of the main document by one of the signatories. It must contain the mandatory variables for this type of template. 
        • Signed: The text must be clear informing that there has been an acceptance of the main document by one of the signatories. It must contain the mandatory variables for this type of template. 
        • Expired: The text must be clear informing that a signature process has expired without being signed. It must contain the mandatory variables for this type of template.
    • EviNotice
      • Notification Template:
        • Text stating that a notification has been sent and that the recipient can access it from a button or link.
        • It must contain the mandatory variables for this type of template. 
  • Text that avoids being labeled as spam or suspected of phishing: To avoid being labeled as spam, it is important to use clear and simple language in the content of emails, and avoid excessive use of suspicious or sensationalist words. In addition, it is important not to use words that may trick recipients into opening the email, as this may be considered phishing or deceptive practices.

  • The signature button (read document) must be visible to the signer: In the case of EviSign and the signature request template type, the signature process access button must be clearly visible to the recipient, so that they can easily identify how to proceed with the signature. The button must have a link that is set with system variables.

Image Added

  • The link to the signature process should appear: In the case of EviSign and the signature request template type, in addition to the signature button it is also mandatory that the access link to the signature process appears. This link is established by using system variables.
  • GDPR policy text must appear:  This text should mention that Evicertia will act as Data Controller in direct communications to Notifyes and/or Signatories. The text should be something similar to the following

    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:

    Code Block
    languagexml
    titleGDPR
    Evicertia esis una servicioservice deof EVICERTIA S.L. (NIF ESB86021839) quethat comoas prestadora decertification serviciosservice de certificaciónprovider, asumeassumes elthe rolrole deof tercerotrusted dethird confianzaparty, segúnaccording to lasthe exigenciasrequirements deof lathe normativaEuropean europeaand yLatin latinoamericanaAmerican vigenteregulations enin materiaforce deregarding comercioelectronic ycommerce firmaand electrónicossignature.
    Evicertia estáis gestionadamanaged porby auditorescertified certificadosauditors yand expertosexperts enin seguridadcomputer informáticasecurity, quewho leprotect protegenit comoas testigosindependent independienteswitnesses deof lasthe comunicacionescommunications yand declaracionesdeclarations deof voluntadwill quethat seare realizanmade a través de ellathrough it.
    Evicertia hahas recibidobeen elrecognized reconocimientoas delegally pruebavalid conevidence validezby legalthe porSupreme elCourt Tribunalof Supremo deSpain España (autocassation deorder casación deof 21/03/2013 númno. 855/2010 deof lathe Sala1st Chamber).
    EVICERTIA S.L. leinforms informayou quethat susyour datospersonal personalesdata hanhave sidobeen obtenidosobtained athrough travésthe delissuer emisorof dethis estaelectronic comunicacióncommunication/notificaciónnotification electrónicaand ywill quebe seránprocessed tratadosfor conthe lasole únicapurpose finalidadof demaking poneravailable ato suyou disposiciónthe losdocuments documentosissued emitidosby porthe elissuer emisorfor parasignature suor firmanotification, oobtaining notificación,evidence obtenerof evidenciasthe delprocess procesoand ykeeping conservarlasthem durantefor elthe plazocontractual contractualand ylegally legalmenteestablished establecidoterm. ElThe destinatariorecipient puedemay ejercitarexercise sushis derechosrights dirigiendoby unwriting escritoto a support@evicertia.com, indicandoindicating enin lathe referenciareference “Protección de Datos”"Data Protection". PuedeAdditional consultarinformation informaciónabout adicionalyour sobrerights susor derechosthe oprocessing elof tratamientoyour dedata susis datosavailable enat 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 webYou can also contact the national authority if you consider that your rights have been violated. You can also obtain more information about the service on the website: www.evicertia.com.
    EsteThis mensajemessage vais dirigido,addressed deexclusively manerato exclusiva,the aaddressee suand destinatario,may ycontain puedeconfidential contenerinformation informaciónand/or confidencialinformation y/osubject sujetato aprofessional secreto profesionalsecrecy, cuyathe divulgacióndisclosure noof estáwhich permitidais por ley.
    En caso de haber recibido este mensaje pornot permitted by law.
    If you have received this message in error, oor tienehave cualquierany dudaquestions sobreabout lathe seguridadsecurity delof proceso, le rogamos quethe process, deplease formanotify inmediata,us nosimmediately loby comuniqueemail medianteto correoour electrónicoattention remitido a nuestra atención en at support.evicertia.com oor porby correoemail electrónicoto a support@evicertia.com.
    
      

    This text can be composed with the help of environment variables for links and e-mail addressesEste texto se puede componer con ayuda de variables de sistema para los enlaces y direcciones de correo electrónico.


{EvidenceUrl}
Expand
titleVariables

Variables

en plantillas

in templates

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.


The variables are divided into environment and user variables.

Environment variables:

These are variables that the application has configured and that obtain their value from sent evidence data or from global data that are shared by all the sites of the platform.

Leyenda

Optional, can be added, not mandatory. 

Required. It is mandatory to add in this type of template


Not available. Not available for this type of template




EviSign template typeEviNotice template type
Variable nameDescription Signature requestFinal notificationProgressRemindersNotification
{{Subject}}EviSign Subject





{{Issuer}}Issuer name






{{PartyName}}Name of signer, reviewer or interested party




{{PartyEmail}}Participant's email




{{SupportEmail}}Evicertia support team email address




{{ServiceName}}Name of the service established on the platform




{{ServiceLegalName}}Name / company name of the service defined in the platform




{{ServiceLegalId}}Service identifier defined in the platform




{{ServiceUrl}}Website of the service defined in the platform




{{ServiceLogoUrl}}Link to the platform logo




{{ServiceLogo}}Platform logo in base 64 for use as img inline




{{SupportUrl}}Support web page defined in the platform




{{GDPRUrl}}GDPR policy web page defined in the platform.




{{DeliveryUrl}}Url to access the signature process




{{InfoText}}Text reported by web service




{{ReminderNumber}}Signature request retry number




{{SubmittedOn}}Date of issue




{{OwnerFullName}}Full name of the issuing user




{{OwnerName}}Name of the issuer user




{{OwnerEmail}}Email address of the issuing user




{{IssuerLogoHtml}}Html tag (<Image>) with embedded logo




{{LegalTermsUrl}}Url of where to find the legal terms 




{{AdditionalInfo}}Text information whether a reminder or not




{{ActionName}}Informs whether the e-mail is a Signature or a Validation e-mail.




{{PartyDisplayName}}Variable containing the full name of the recipient




{{UnsubscribeUrl}}Url where to perform the unsubscribe process




{{EvidenceUrl}}
Leyenda
Opcional, Se puede añadir no es obligatoria. 

Requerida. Es obligatoria añadir en ese tipo de plantilla

No disponible. No esta disponible para ese tipo de plantillaTipo plantilla EviSign
Nombre variableDescripción Solicitud de firmaNotificación finalProgreso
{Subject}Asunto del EviSign{Issuer}Nombre del emisor{PartyName}Nombre del firmante, revisor o interesado{PartyEmail}Email del participante{SupportEmail}Correo electrónico del equipo de soporte de Evicertia{ServiceName}Nombre del servicio establecido en la plataforma{ServiceLegalName}Nombre / razón social del servicio definido en la plataforma{ServiceLegalId}Identificador del servicio definido en la plataforma{ServiceUrl}Página web del servicio definido en la plataforma{ServiceLogoUrl}Link al logo de la plataforma{ServiceLogo}Logo de la plataforma en base 64 para usar como img inline{SupportUrl}Página web de soporte definido en la plataforma{GDPRUrl}Página web de la política GDPR definido en la plataforma{DisplayUrl}Url de acceso al proceso de firma{InfoText}Texto que se informa por servicio web{ReminderNumber}Número de reintento de envío de la solicitud de firma{SubmittedOn}Fecha de emisión{OwnerFullName}Nombre completo del usuario emisor{OwnerName}Nombre del usuario emisor{OwnerEmail}Dirección de email del usuario emisor{IssuerLogoHtml}Etiqueta html (<Image>) con el logo incrustado{LegalTermsUrl}Url de donde encontrar los términos legales {AdditionalInfo}Información de texto si es un recordatorio o no{ActionName}Informa si el correo electrónico es de Firma o de Validación{PartyDisplayName}Variable que contiene el nombre completo del destinatario{UnsubscribeUrl}Url donde realizar el proceso de desuscribirse
Url de acceso a los documentos generados durante el proceso de firma

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ó Image Removed 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 Image Removed que aparece en la linea del Grid correspondiente a la variable que se desea eliminar.

Image RemovedImage Removed

 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.

Code Block
languagexml
titleejemplo variable 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>
Expand
titleUso de lenguaje de programción Liquid en las plantillas

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.






{{Outcome}}Reports the final result of the evidence (signed, rejected, expired...)




{{State}}Reports the status of the evidence (Sent, Received, Signed...)




{{PartyRole}}Informs the role of the recipient of the mail (interested party, reviewer or signer).




{{Recipient}}Name of the recipient of the notification




{{RecipientEmail}}Email of notification recipient




{{ActionText}}Text appearing on the button to access the notification content




{{Language}}Notification language




{{CopyrightDate}}Platform copyright date




{{CertificationLevel}}Appearance of the notification 




{{CbUrl}}Url that communicates the opening of a notification.




User variables:

They are variables that the user declares during the creation of the template. These variables can be used in the content of the template you are creating and when using the template via web service the variables and their value are reported.

These variables can only be created at template design time, when the template is in draft state. In the detail tab at the bottom there is initially a table of variables. Pressing the button Image Added a row is added to the Grid allowing you to enter a user variable, to define a user variable you must configure:

  • Variable : Variable name, to be used in the content and in the call to the Web Service.
  • Value: A default value should be set, so that the site administrator user and the support team person can preview the result.Requerido: Este check indica si la variable debe ser informada siempre. 
    • True: Must be reported in each request
    • False: It is not mandatory to report on every request.

To delete a variable entered by mistake or for any other reason, click on the icon Image Added that appears in the Grid line corresponding to the variable to be deleted.

Image AddedImage Added


 Once the variables have been declared, they can be used in the HTML content of the template. In order to distinguish user variables from system variables, the variable name must contain the preface variables and be between keys {{}}, e.g:

  • We declare the variables PostalAddress, PostalCode and we want to make reference to them in the content, for this in the part of the content that interests to introduce the postal code we would write {{variables.PostalCode}}  and in the part where you want to enter the postal address type  {{variables.PostalAddress}}.

The following is a small example using system and user variables.

Code Block
languagexml
titleexample user variable
<html>
<head>
</head>
<p>Request for signature of <b>{{Issuer}}</b> , about <b>{{Subject}} </b></p>
<table><tr><td>Signer name: </td><td>{{Signer}}</td></tr></table>
<table><tr><td>Signer Address: </td><td><b>{{variables.PostalAddress}}</b> CP: {{variables.PostalCode}} </td></tr></table>
<a href="{{DeliveryURL}}" class="buttonread">Sign documentation</a>
</html>



Expand
titleUse of Liquid programming language in templates

Use of Liquid programming language in templates


An important part of template customization is that you can use Liquid programming language when defining the content of the template, this will allow the same template to be dynamic and change depending on the values of the variables.

To learn something about this programming language we recommend you to visit the following links.


Expand
titleUsing templates from Web Service

Using templates from Web Service


Here is how to reference a template at the time of issuance. 

EviSign

For this product a number of different templates can be set per Signer/Reviewer. For this purpose the following parameters have been created in the EviSignSubmit API within the SigningParties object. 

  • For the use of signature request type templates: 
    • SignatureRequestTemplate: Contains the identifier of the template to be used in the communication.
    • SignatureRequestTemplateValues: It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported. 
  • For the use of signature reminder type templates:
    • SignatureReminderTemplate: Contains the identifier of the template to be used in the communication.
    • SignatureReminderTemplateValues:  It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported. 
  • For the use of final notification type templates:
    • FinalNotificacionTemplate: Contains the identifier of the template to be used in the communication.
    • FinalNotificacionTemplateValues:  It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported. 
  • For the use of progress type templates:
    • ProgressNotificationTemplate: Contains the identifier of the template to be used in the communication..
    • ProgressNotificationTemplateValues:  It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported. 


Code Block
languagetext
titleUse of templates via Web Service
POST /api/EviSign/Submit HTTP/1.1
Host: app.ecertia.com
Expand
titleUsar las plantillas desde Servicio Web

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. 
Code Block
languagetext
titleUso de plantillas mediante Servicio Web
POST /api/EviSign/Submit HTTP/1.1
Host: app.ecertia.com
Authorization: Basic *******************
Content-Type: application/json

{
"subject":"EviSign BásicoBasic unone firmantesignatory",
"issuer":"Demo evisign basicobasic",
"signingParties":[
{
    "name":"Lara Lor Van",
    "legalName":"123456789A",
    "address":"LaraLorVan@mailtestrecipient01@mailtest.es",
    "signingMethod":"EmailPIN",
    "SigningOrder": "1",
    "SignatureRequestTemplateNameSignatureRequestTemplate":"Template01",
    "SignatureRequestTemplateValues" : [{"postalAddress":"C/ Luna 01 Tierra3 29334"},{ "jobOffered":"Analista"}],
    "FinalNotificacionTemplateNameFinalNotificacionTemplate":"Template02",
    "FinalNotificacionTemplateValues" : [{"postalAddress":"C/ Luna 01 Tierra3 29334"},{ "jobOffered":"Analista"}],
    "ProgressNotificationTemplateNameProgressNotificationTemplate":"Template04",
    "ProgressNotificationTemplateValues" : {"postalAddress": [{"postalAddress":"C/ Luna 01 Tierra3”}],
"document":"{{documento principal en Base 64}}"} 

Ejemplos de plantillas

"C/ Luna 01 Tierra3”},
 	"SignatureReminderTemplate":"Template02",
    "SignatureReminderTemplateValues" : {"postalAddress":"C/ Luna 01 Tierra3 29334", "jobOffered":"Analista"}
}]
"document":"{{documento principal en Base 64}}"} 

EviNotice

  • For the use of a notification:
    • NotificationTemplate: Contains the identifier of the template to be used in the communication..
    • NotificationTemplateValues:  It contains an array of value keys, where the variables defined in the template content and the value it receives in the emission are reported. 


Code Block
languagetext
titleUsing templates from Web Service
POST /api/v2/evinotice/submit HTTP/1.1
Host: app.ecertia.com
Content-Type: application/json
Authorization: Basic 
{
    "Body": "We inform you that your car insurance fee has increased by 5% for the reports sent during the year 2022",
    "Subject": "notification about your insurance car",
    "RecipientAddress": "recipient01@mailtest.com",
    "RecipientLegalName": "recipient name",
    "IssuerLegalName": "Company test Insurance",
    "CertificationLevel": "Advanced",
    "TimeToLive": 365,
    "HideBanners": false,
    "PushNotificationFilter": [
        "Processed",
        "Sent",
        "Dispatched",
        "Delivered",
        "Read",
        "Replied"
    ],
    "PushNotificationUrl": "https://en8ok0mpw5r43.x.pipedream.net/",
    "CommitmentChoice": "AcceptOrReject",
    "CommitmentCommentsAllowed": true,
    "DeliverySignMethod": "MobilePIN",
    "DeliverySignFixedMobile": "+3464555656",
    "Language": "en",
     "NotificationTemplate": "Template01:AsIt",
      "NotificationTemplateValues" : {"recipientCountry":"Spain"}
}



Expand
titleExamples of templates

Examples of templates


In this section, you can download sample templates for each of the types of templates named in this help.

Language/ Templates KindEnglishSpanishCatalan DeutschFrenchItalianPortugueseRomanian
EviSign:  Final Notification Template

View file
nameEviSignFinalNotificationTemplateEN.htm
height150

View file
nameEviSignFinalNotificationTemplateES.htm
height150

View file
nameEviSignFinalNotificationTemplateCA.htm
height150

View file
nameEviSignFinalNotificationTemplateDE.htm
height150

View file
nameEviSignFinalNotificationTemplateFR.htm
height150

View file
nameEviSignFinalNotificationTemplateIT.htm
height150

View file
nameEviSignFinalNotificationTemplatePT.htm
height150

View file
nameEviSignFinalNotificationTemplateRO.htm
height150

EviSign: Progress Notification Template

View file
nameEviSignProgressNotificationTemplateEN.htm
height150

View file
nameEviSignProgressNotificationTemplateES.htm
height150

View file
nameEviSignProgressNotificationTemplateCA.htm
height150

View file
nameEviSignProgressNotificationTemplateDE.htm
height150

View file
nameEviSignProgressNotificationTemplateFR.htm
height150

View file
nameEviSignProgressNotificationTemplateIT.htm
height150

View file
nameEviSignProgressNotificationTemplatePT.htm
height150

View file
nameEviSignProgressNotificationTemplateRO.htm
height150

EviSign: Request Template

View file
nameEviSignRequestTemplateEN.htm
height150

View file
nameEviSignRequestTemplateES.htm
height150

View file
nameEviSignRequestTemplateCA.htm
height150

View file
nameEviSignRequestTemplateDE.htm
height150

View file
nameEviSignRequestTemplateFR.htm
height150

View file
nameEviSignRequestTemplateIT.htm
height150

View file
nameEviSignRequestTemplatePT.htm
height150

View file
nameEviSignRequestTemplateRO.htm
height150

EviSign:

Signature Reminder Template

View file
nameEviSignSignatureReminderTemplateEN.htm
height150

View file
nameEviSignSignatureReminderTemplateES.htm
height150

View file
nameEviSignSignatureReminderTemplateCA.htm
height150

View file
nameEviSignSignatureReminderTemplateDE.htm
height150

View file
nameEviSignSignatureReminderTemplateFR.htm
height150

View file
nameEviSignSignatureReminderTemplateIT.htm
height150

View file
nameEviSignSignatureReminderTemplatePT.htm
height150

View file
nameEviSignSignatureReminderTemplateRO.htm
height150

EviNotice : Notification Template

View file
nameEviNoticeNotificationTemplateEN.htm
height150

View file
nameEviNoticeNotificationTemplateES.htm
height150

View file
nameEviNoticeNotificationTemplateCA.htm
height150

View file
nameEviNoticeNotificationTemplateDE.htm
height150

View file
nameEviNoticeNotificationTemplateFR.htm
height150

View file
nameEviNoticeNotificationTemplateIT.htm
height150

View file
nameEviNoticeNotificationTemplatePT.htm
height150

View file
nameEviNoticeNotificationTemplateRO.htm
height150

...