Variables in templates
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 | EviNotice template type |
---|
Variable name | Description | Signature request | Final notification | Progress | Reminders | Notification | {{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}} | Url de acceso a los documentos generados durante el proceso de firma | | | | | | {{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 Removed 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.
To delete a variable entered by mistake or for any other reason, click on the icon Image Removed Image Added that appears in the Grid line corresponding to the variable to be deleted. Image Added Image RemovedImage RemovedImage 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. example user variable Code Block |
---|
language | xml | title | example 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> |
|