Variables en plantillasin templatesLas variables se dividen en variables de entonno y de usuario. Variables de entorno: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 type |
---|
Variable name | Description | Signature request | Final notification | Progress | Reminders | {{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 plantilla | Tipo plantilla EviSign | Nombre variable | Descripción | Solicitud de firma | Notificación final | Progreso | Recordatorios | {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 | {DeliveryUrl} | 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 | {EvidenceUrl} | Url de acceso a los documentos generados durante el proceso de firma |
|
|
|
| {{Outcome}} | Informa del resultado final de la evidencia (firmado, rechazado, expiradoReports the final result of the evidence (signed, rejected, expired...) |
|
|
|
| {{State}} | Informa del estado en el que se encuentra la evidencia (Enviado, recibido, firmadoReports the status of the evidence (Sent, Received, Signed...) |
|
|
|
| {{PartyRole}} | Informa del role que tiene el destinatario del correo (interesado, revisor o firmante) |
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: Informs the role of the recipient of the mail (interested party, reviewer or signer). |
|
|
|
|
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.
- 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 Removed Image 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}.
- 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 Added Image 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 variablesA continuación se muestra un pequeño ejemplo que usa variables de sistema y de usuario. Code Block |
---|
language | xml |
---|
title | ejemplo example user variable usuario |
---|
| <html>
<head>
</head>
<p>Solicitud<p>Request defor firmasignature deof <b>{{Issuer}}</b> , sobreabout <b>{{Subject}} </b></p>
<table><tr><td>Nombre del<table><tr><td>Signer firmantename: </td><td>{{Signer}}</td></tr></table>
<table><tr><td>Dirección<table><tr><td>Signer del firmanteAddress: </td><td><b>{{variables.PostalAddress}}</b> CP: {{variables.PostalCode}} </td></tr></table>
<a href="{{DeliveryURL}}" class="buttonread">FIRMA>Sign DE DOCUMENTACIÓN<documentation</a>
</html> |
|