...
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".
...
Expand | ||
---|---|---|
| ||
Description of the "Communication template management" screenThe screen consists of:
|
Expand | ||
---|---|---|
| ||
Create new templatePressing the button a modal window opens, allowing the creation of a new template. The modal screen consists of two tabs: detail and preview.
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. . 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. . 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. At this point the user can decide whether to make any further modifications to the template or "Request Approval". Pressing the button a validation process starts in which there will be an automatic validation and a manual validation.
|
Expand | ||
---|---|---|
| ||
Delete templateA 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.
|
Expand | ||
---|---|---|
| ||
State flow of a templateA linear diagram of the states through which a template can pass is shown below. |
Expand | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
Best practice guide for creating a templateTo create a new template and have it approved, the following aspects should be taken into account:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Variables in templatesThe 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.
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 a row is added to the Grid allowing you to enter a user variable, to define a user variable you must configure:
To delete a variable entered by mistake or for any other reason, click on the icon that appears in the Grid line corresponding to the variable to be deleted. 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:
The following is a small example using system and user variables. example user variable
|
Expand | ||
---|---|---|
| ||
Use of Liquid programming language in templatesAn 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 | ||||
---|---|---|---|---|
| ||||
Using templates from Web ServiceHere is how to reference a template at the time of issuance. EviSignFor 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.
Code Block | | |||
language | text |
Code Block | ||
---|---|---|
| ||
POST /api/EviSign/Submit HTTP/1.1
Host: app.ecertia.com
Authorization: Basic *******************
Content-Type: application/json
{
"subject":"EviSign Basic one signatory",
"issuer":"Demo evisign basic",
"signingParties":[
{
"name":"Lara Lor Van",
"legalName":"123456789A",
"address":"recipient01@mailtest.es",
"signingMethod":"EmailPIN",
"SigningOrder": "1",
"SignatureRequestTemplate":"Template01",
"SignatureRequestTemplateValues" : {"postalAddress":"C/ Luna 01 Tierra3 29334", "jobOffered":"Analista"},
"FinalNotificationTemplate":"Template02",
"FinalNotificationTemplateValues" : {"postalAddress":"C/ Luna 01 Tierra3 29334", "jobOffered":"Analista"},
"ProgressNotificationTemplate":"Template04",
"ProgressNotificationTemplateValues" : {"postalAddress":"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.
Using templates from Web Service
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples of templatesIn this section, you can download sample templates for each of the types of templates named in this help.
EviSignFinalNotificationTemplateEN.htm | height | 150height | 150 |
EviSignFinalNotificationTemplateES.htm | height | 150
EviSignFinalNotificationTemplateCA.htm | height | 150 |
EviSignFinalNotificationTemplateDE.htm | height | 150
EviSignFinalNotificationTemplateFR.htm | height | 150
EviSignFinalNotificationTemplateIT.htm | height | 150 |
EviSignFinalNotificationTemplatePT.htm | height | 150 |
EviSignFinalNotificationTemplateRO.htm |
150 |
150 |
height | 150
height | 150
height | 150
150 |
150 |
height | 150height | 150 |
EviSignRequestTemplateEN.htm | height | 150
EviSignRequestTemplateES.htm | height | 150 |
EviSignRequestTemplateCA.htm | height | 150
EviSignRequestTemplateDE.htm | height | 150
EviSignRequestTemplateFR.htm | height | 150 |
EviSignRequestTemplateIT.htm | height | 150
EviSignRequestTemplatePT.htm | height | 150 |
EviSignRequestTemplateRO.htm | height | 150
EviSignSignatureReminderTemplateEN.htm | height | 150
EviSignSignatureReminderTemplateES.htm | height | 150 |
EviSignSignatureReminderTemplateCA.htm | height | 150
EviSignSignatureReminderTemplateDE.htm | height | 150 |
EviSignSignatureReminderTemplateFR.htm | height | 150
EviSignSignatureReminderTemplateIT.htm | height | 150
EviSignSignatureReminderTemplatePT.htm | height | 150 |
EviSignSignatureReminderTemplateRO.htm | height | 150 |
EviNoticeNotificationTemplateEN.htm | height | 150
EviNoticeNotificationTemplateES.htm | height | 150 |
EviNoticeNotificationTemplateCA.htm | height | 150 |
EviNoticeNotificationTemplateDE.htm | height | 150 |
EviNoticeNotificationTemplateFR.htm | height | 150 |
EviNoticeNotificationTemplateIT.htm | height | 150 |
EviNoticeNotificationTemplatePT.htm | height | 150
EviNoticeNotificationTemplateRO.htm |
|