Versions Compared

Key

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

...

Requirements

To access and use this functionality, The site must have a Flag activated for each of the services you want to use and the billing mode “By Submission”. The flags will be activated by the support team upon request of the sales representative.

...

The first step is to click on the EviNotice icon image-20241216-160438.png of the section “New Submission”. A submenu is displayed, in this submenu you can see the option "New EviNotice Batch".

image-20241216-160124.pngImage Modified

When clicking on this option, the application displays the "New Batch" screen, informing that the process consists of 4 steps.

...

To define the recipients you have the option of doing it manually, by copying and pasting into the text field, or by using a CSV file. In both ways, the first row with the headers that make up the list of recipients must be respected. This header is composed of mandatory columns and then additional columns that function as variables when composing the message to the recipient.

  • EviNotice columnas obligatoriasmandatory columns:

    • address* : Contains the recipient's email address or mobile phone number (with country code). It is used to send the notification to the recipient

    • legalname: Company name of the recipient.

    • lookupkey: Client identifier. Contains a unique identifier of the customer to facilitate the search in your systems.

    • displayname*: Name of the recipient. Contains the name of the recipient to be displayed in the notifications.

    • evidenceaccesscontrolchallenge: In case of configuring the evinotice with access to custody through "Challenge", this field contains the question to be answered by the recipient in order to access the evidence generated in the process.

    • evidenceaccesscontrolchallengeresponse: If the evinotice EviNotice is configured with access to custody through "Challenge", this field contains the response that the recipient must give in order to access the evidence generated in the process.

    • deliverysignchallenge: This column must be accompanied by a value in deliverysignchallengeresponse and sets the EviNotice signature method to "Challenge". It contains the question that the recipient must answer to access the notification message. If this column is informed, the following columns must be empty deliverysignfixedemail, deliverysignfixedmobile. Since only one signature method can be set per recipient.

    • deliverysignchallengeresponse: This column must be accompanied by a value in deliverysignchallenge and sets the EviNotice signature method to "Challenge". It contains the response to be given by the recipient to access the notification message. If this column is informed, the following columns must be empty deliverysignfixedemail, deliverysignfixedmobile. Since only one signature method can be set per recipient.

    • deliverysignfixedemail: Sets the signature method as "PIN to email". The recipient will receive a PIN code to the email address set in this field. If this column is informed, the following columns must be empty deliverysignchallenge, deliverysignchallengeresponse, deliverysignfixedmobile. Since only one signature method can be set per recipient.

    • deliverysignfixedmobile: Set the signature method as "PIN to mobile". The recipient will receive a PIN code to the phone number set in this field. The phone number must contain the country code (e.g. +34666000888). If this column is filled in, the following columns must be empty: deliverysignchallenge, deliverysignchallengeresponse, deliverysignfixedemail. Since only one signature method can be set per recipient.

* These fields are required to be informed in each record.

NotasNotes:

  1. If none of the delivery* fields are reported, the EviNotice signature method will be set to "WebClick", so the user will see the notification message without first identifying himself/herself.

  2. If evidenceaccescontrolchallenge is not reported, the method of access to the evidence will be "AutoChallenge", where a data known by the recipient is requested, such as the sender's e-mail address.

  3. An EviNotice can be sent by SMS or Email. But when building a Batch all the recipients must have the same communication channel, all by email or all by SMS.

...

Variables can be system variables or user variables.

  • Variables de sistema, son las que que estan predefinidas en la aplicación y contienen valores genericos de la plataformaSystem variables are those that are predefined in the application and contain generic values of the platform.

  • User variables are those defined by the user when composing the list of recipients. To create user variables, just add more headers, apart from the mandatory ones, when creating the list of recipients, these new headers will be considered as variables and the value is set record by record.

    • In the following example in bold are the fields added as variables:

      • address|legalname|lookupkey|displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|deliverysignchallenge|deliverysignchallengeresponse|deliverysignfixedemail|deliverysignfixedmobile|varexample01|varexample02

...

This last step allows you to review the batch configuration and set a future shipment execution date or set the shipment to be executed as soon as possible. Once the data has been confirmed and the execution date has been set, click on the continue button to finish creating the batch.

...

Final Step

This screen displays a summary of the configured batch, along with charts showing the progress of the shipment and the status of the completed shipments. By clicking the 'Close' button, you will be taken to the screen with the batch shipment list.

...

Create a new EviMail batch

Step 1:

The first step is to click on the EviMail icon image-20250120-111549.pngImage Added of the section “New Submission”. A submenu is displayed, in this submenu you can see the option "New EviMail Batch".

image-20250120-113017.pngImage Added

When clicking on this option, the application displays the "New Batch" screen, informing that the process consists of 4 steps.

In this first step, a brief description of the lot must be configured in order to find it quickly in the list of lots. In the next field you define the recipients that make up the batch.

To define the recipients you have the option of doing it manually, by copying and pasting into the text field, or by using a CSV file. In both ways, the first row with the headers that make up the list of recipients must be respected. This header is composed of mandatory columns and then additional columns that function as variables when composing the message to the recipient.

  • EviMail mandatory columns:

    • lookupkey: Client identifier. Contains a unique identifier of the customer to facilitate the search in your systems.

    • EmailAddress* : Contains the recipient's email address. It is used to send the notification to the recipient

    • legalname*: Company name of the recipient.

    • evidenceaccesscontrolchallenge: In case of configuring the evinotice with access to custody through "Challenge", this field contains the question to be answered by the recipient in order to access the evidence generated in the process.

    • evidenceaccesscontrolchallengeresponse: If the EviMail is configured with access to custody through "Challenge", this field contains the response that the recipient must give in order to access the evidence generated in the process.

  • * These fields are required to be informed in each record.

Notas:

  1. If evidenceaccescontrolchallenge is not reported, the method of access to the evidence will be "AutoChallenge", where a data known by the recipient is requested, such as the sender's e-mail address.

...

Step 2:

This step allows you to configure the subject of the email notification that the recipient receives and the body of the message that the sender wishes to communicate to the recipient.

Both the subject and the content of the message can be composed using variables.

Variables can be system variables or user variables.

  • System variables are those that are predefined in the application and contain generic values of the platform.

  • User variables are those defined by the user when composing the list of recipients. To create user variables, just add more headers, apart from the mandatory ones, when creating the list of recipients, these new headers will be considered as variables and the value is set record by record.

    • In the following example in bold are the fields added as variables:

      • lookupkey|emailAddress|legalname||displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|varexample01|varexample02

When using these variables in the subject or in the body of the message, it should be done in the following way, taking the previous variables as an example,{{@varexample01}}

In this step you can also add attachments. All recipients of the Batch will receive the same attachments.

...

Step 3

This step allows the configuration of the EviMail features. These characteristics are shared for all the shipments that make up the batch.

  • Email to use as sender: This is the email that will be used to configure the FROM header of the notification email.

    • Do not send the Sender header in notifications emails: This field informs that the EviMail will not carry the Sender header that we use to track the EviMail.

  • Cost Centre: Cost center for billing grouping.

  • AffidavitKinds: List of affidavit types to be generated.

  • Notification Language : Language for the email.

  • Affidavit Language : Language for the generated affidavits.

  • Url for event notification : URL to receive status change notifications of the evidence.

  • Notification filter : List of push notifications expected by the client.

  • PushNotificationExtraData : Additional data that the sender wishes to include in each push notification.

  • Agreement possibilities : Allows configuration of whether the recipient can accept/reject the message.

    • Disabled

    • Accept:

    • Reject:

    • AcceptOrReject:

  • Comments are allowed (bool, optional): Allows the recipient to add comments upon accepting/rejecting.

  • Reasons for rejection : Specifies a list of possible reasons for rejecting the email.

  • Reasons for acceptance : Specifies a list of possible reasons for accepting the email.

  • Reason for rejection required: Requires specifying a reason for rejection.

  • Reason for acceptance required: Requires specifying a reason for acceptance.

...

Step 4

This last step allows you to review the batch configuration and set a future shipment execution date or set the shipment to be executed as soon as possible. Once the data has been confirmed and the execution date has been set, click on the continue button to finish creating the batch.

...

Final Step

This screen displays a summary of the configured batch, along with charts showing the progress of the shipment and the status of the completed shipments. By clicking the 'Close' button, you will be taken to the screen with the batch shipment list.

image-20250120-122611.pngImage Added

Create a new EviSMS batch

Step 1:

The first step is to click on the EviMail icon image-20250120-144849.pngImage Added of the section “New Submission”. A submenu is displayed, in this submenu you can see the option "New EviMail Batch".

...

When clicking on this option, the application displays the "New Batch" screen, informing that the process consists of 4 steps.

In this first step, a brief description of the lot must be configured in order to find it quickly in the list of lots. In the next field you define the recipients that make up the batch.

To define the recipients you have the option of doing it manually, by copying and pasting into the text field, or by using a CSV file. In both ways, the first row with the headers that make up the list of recipients must be respected. This header is composed of mandatory columns and then additional columns that function as variables when composing the message to the recipient.

  • EviSMS mandatory columns:

    • lookupkey: Client identifier. Contains a unique identifier of the customer to facilitate the search in your systems.

    • phoneNumber* : Contains the recipient's phone number. It is used to send the notification to the recipient

    • legalname*: Company name of the recipient.

    • evidenceaccesscontrolchallenge: In case of configuring the evinotice with access to custody through "Challenge", this field contains the question to be answered by the recipient in order to access the evidence generated in the process.

    • evidenceaccesscontrolchallengeresponse: If the EviSMS is configured with access to custody through "Challenge", this field contains the response that the recipient must give in order to access the evidence generated in the process.

  • * These fields are required to be informed in each record.

Notas:

  1. If evidenceaccescontrolchallenge is not reported, the method of access to the evidence will be "AutoChallenge", where a data known by the recipient is requested, such as the sender's e-mail address.

...

Step 2:

This step allows you to configure the body of the message that the sender wishes to communicate to the recipient.

The content of the message can be composed using variables.

Variables can be system variables or user variables.

  • System variables are those that are predefined in the application and contain generic values of the platform.

  • User variables are those defined by the user when composing the list of recipients. To create user variables, just add more headers, apart from the mandatory ones, when creating the list of recipients, these new headers will be considered as variables and the value is set record by record.

    • In the following example in bold are the fields added as variables:

      • lookupkey|phonenumber|legalname||displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|varexample01|varexample02

When using these variables in the body of the message, it should be done in the following way, taking the previous variables as an example,{{@varexample01}}

...

Step 3

This step allows the configuration of the EviSMS features. These characteristics are shared for all the shipments that make up the batch.

  • Cost Centre: Cost center for billing grouping.

  • AffidavitKinds: List of affidavit types to be generated.

  • Notification Language : Language for the email.

  • Affidavit Language : Language for the generated affidavits.

  • Url for event notification : URL to receive status change notifications of the evidence.

  • Notification filter : List of push notifications expected by the client.

  • PushNotificationExtraData : Additional data that the sender wishes to include in each push notification.

...

Step 4

This last step allows you to review the batch configuration and set a future shipment execution date or set the shipment to be executed as soon as possible. Once the data has been confirmed and the execution date has been set, click on the continue button to finish creating the batch.

...

Final Step

This screen displays a summary of the configured batch, along with charts showing the progress of the shipment and the status of the completed shipments. By clicking the 'Close' button, you will be taken to the screen with the batch shipment list.

image-20250120-150800.pngImage Added

Examples and CSV files upload of recipients.

...

Expand
titleExample EviNotice 3 recipients, 3 recipient notified by phone number first with identify PIN to email, second identify by challenge, third identify by PIN to phone and acces to custody by challenge

View file
nameEviNoticeExample02.txt

address|legalname|lookupkey|displayname|evidenceaccesscontrolchallenge|evidenceaccesscontrolchallengeresponse|deliverysignchallenge|deliverysignchallengeresponse|deliverysignfixedemail|deliverysignfixedmobile
+3466600888|recipientlegalname01|001|recipientname01|||||recipient01@narecipientmailmirial.com|
+3466600888|recipientlegalname02|002|recipientname02|||Your card ID|1234||
+3466600888|recipientlegalname03|003|recipientname03|last 4 number Idcard|1234||||+34666000888

CSV EviMail:

Expand
titleExample EviMail 4 recipients.

View file
nameEviMailBatch01.txt

lookupKey|emailAddress|legalName|evidenceAccessControlChallenge|evidenceAccessControlChallengeResponse
001|recipient1@testmail.com|Recipient1||
002|recipient2@testmail.com|Recipient2||
003|recipient3@testmail.com|Recipient3||
004|recipient4@testmail.com|Recipient4||

Expand
title

...

Se ha creado una API para facilitar la integración de esta funcionalidad en sistemas del cliente.

...

titleUso de la funcionalidad desde la Web

...

Example EviMail 4 recipients. with access control

View file
nameEviMailBatch02.txt

lookupKey|emailAddress|legalName|evidenceAccessControlChallenge|evidenceAccessControlChallengeResponse
001|recipient1@testmail.com|Recipient1|last 3 numbers Id|111
002|recipient2@testmail.com|Recipient2|last 3 numbers Id|222
003|recipient3@testmail.com|Recipient3|last 3 numbers Id|333
004|recipient4@testmail.com|Recipient4|last 3 numbers Id|444

CSV EviSMS:

Expand
titleExample EviSMS 3 recipients

View file
nameEviSMSExample01.txt

lookupKey|phoneNumber|legalName|evidenceAccessControlChallenge|evidenceAccessControlChallengeResponse
001|+34600000000|RecipientName1||
002|+34600000001|RecipientName2||
003|+34600000002|RecipientName3||

How it works from API

Here you can see how to create an EviNotice batch from API EviNotice Batch Sending

Here you can see how to create an EviMail batch from API EviMail Batch Sending

Here you can see how to create an EviSMS batch from AP IEviSMS Batch Sending