AlphaTrust e-Sign

Appearance

On this page

Notifications Customization ​

Notification Template Sets ​

Notification Templates are used for several purposes in AlphaTrust® e-Sign. One purpose is to notify a user that they need to sign a document. This can be triggered by setting the Participant's SendRequestViaEmail property to true. Another purpose is to send any participant's involved in the transaction (including external third-parties) a copy of the signed document once the transaction is completed. There are also Notification Templates for notification of transaction expiration and cancellation, among others. These Notification Templates sets are managed from within the AlphaTrust® e-Sign Control Panel by an Admin user for the appropriate account (Please reference the AlphaTrust® e-Sign Control Panel Guide for more details).

csharp
participant = new ParticipantInsertModel()
            {
                FullName = "John Smith",
                EmailAddress = "john.smith@your-domain.com",
                SendRequestViaEmail = true,
                EmailTemplateSetName = "MyCustomTemplateSet"
            }

WARNING

The property name for this feature is EmailTemplateSetName instead of NotificationTemplateSetName because the initial usage only dealt with emails and we have since added in SMS functionality so we changed the name from Emails to Notifications to cover both emails and SMS.

Placeholders ​

There may be times when you would like to customize any outgoing notifications with personalized data. For example, if you wish the Participant Notification to say "Dear John," at the top of the email or SMS message, you could use an Notification Template Placeholder. In order to do this, you must have some placeholders ready in your Notification Template. Those placeholders should be alpha-numeric strings of text surrounded by double curly braces.

Account ​

{{ACCOUNT_LOGO}}  
{{CONTROLPANEL_ACCESSLINK}}  
{{REPORTS_ACCESSLINK}}
{{EMAIL_FOOTER}}

Document ​

{{DOCUMENT_ID}}  
{{DOCUMENT_TITLE}}  
{{DOCUMENT_STATUS}}

Documents ​

{{DOCUMENTID_LIST_COMMA_SEPARATED}}  
{{DOCUMENT_LIST_COMMA_SEPARATED}}  
{{DOCUMENT_LIST_BULLETED}}  
{{DOCUMENT_LIST_BULLETED_WITH_IDS}}

Launcher ​

{{LAUNCHER_EMAILADDRESS}}
{{LAUNCHER_FIRSTNAME}}
{{LAUNCHER_LASTNAME}}
{{LAUNCHER_FULLNAME}}
{{LAUNCHER_ID}}
{{LAUNCHER_INITIALS}}
{{LAUNCHER_ORGANIZATION}}
{{LAUNCHER_TITLE}}

Participant ​

{{PARTICIPANT_ACCESSLINK}}  
{{PARTICIPANT_ACCESSTINYLINK}}  
{{PARTICIPANT_ID}}  
{{PARTICIPANT_FULLNAME}}  
{{PARTICIPANT_STATUS}}  
{{PARTICIPANT_FIRSTNAME}}  
{{PARTICIPANT_INITIALS}}  
{{PARTICIPANT_EMAILADDRESS}}  
{{PARTICIPANT_PHONENUMBER}}  
{{PARTICIPANT_TITLE}}  
{{PARTICIPANT_ORGANIZATION}}  
{{PARTICIPANT_ACCESSTOKEN}}
{{PARTICIPANT_FULLNAME:[ParticipantIndex]}}  
{{PARTICIPANT_FULLNAME:[ParticipantRole]}}  
{{PARTICIPANT_INITIALS:[ParticipantIndex]}}  
{{PARTICIPANT_INITIALS:[ParticipantRole]}}  
{{PARTICIPANT_EMAILADDRESS:[ParticipantIndex]}}  
{{PARTICIPANT_EMAILADDRESS:[ParticipantRole]}}  
{{PARTICIPANT_PHONENUMBER:[ParticipantIndex]}}  
{{PARTICIPANT_PHONENUMBER:[ParticipantRole]}}  
{{PARTICIPANT_TITLE:[ParticipantIndex]}}  
{{PARTICIPANT_TITLE:[ParticipantRole]}}  
{{PARTICIPANT_ORGANIZATION:[ParticipantIndex]}}  
{{PARTICIPANT_ORGANIZATION:[ParticipantRole]}}  
{{PARTICIPANT_FIRSTNAME:[ParticipantIndex]}}  
{{PARTICIPANT_FIRSTNAME:[ParticipantRole]}}

Participants ​

{{PARTICIPANT_LIST_COMMA_SEPARATED}}  
{{PARTICIPANT_LIST_BULLETED}}  
{{PARTICIPANT_LIST_BULLETED_WITH_IDS}}

Task ​

{{TASK_ID}}  
{{TASK_STATUS}}

Transaction ​

{{TRANSACTION_ID}}  
{{TRANSACTION_DESCRIPTION}}  
{{TRANSACTION_STATUS}}

Cancelling Participant ​

{{CANCELLING_PARTICIPANT_EMAILADDRESS}}
{{CANCELLING_PARTICIPANT_FIRSTNAME}}
{{CANCELLING_PARTICIPANT_FULLNAME}}
{{CANCELLING_PARTICIPANT_ID}}
{{CANCELLING_PARTICIPANT_INITIALS}}
{{CANCELLING_PARTICIPANT_ORGANIZATION}}
{{CANCELLING_PARTICIPANT_PHONENUMBER}}
{{CANCELLING_PARTICIPANT_STATUS}}
{{CANCELLING_PARTICIPANT_TITLE}}

ReassignedParticipant ​

{{REASSIGNED_PARTICIPANT_ACCESSLINK}}  
{{REASSIGNED_PARTICIPANT_ACCESSTINYLINK}}  
{{REASSIGNED_PARTICIPANT_ID}}  
{{REASSIGNED_PARTICIPANT_FULLNAME}}  
{{REASSIGNED_PARTICIPANT_STATUS}}  
{{REASSIGNED_PARTICIPANT_FIRSTNAME}}  
{{REASSIGNED_PARTICIPANT_INITIALS}}  
{{REASSIGNED_PARTICIPANT_EMAILADDRESS}}  
{{REASSIGNED_PARTICIPANT_PHONENUMBER}}  
{{REASSIGNED_PARTICIPANT_TITLE}}  
{{REASSIGNED_PARTICIPANT_ORGANIZATION}}  
{{REASSIGNED_PARTICIPANT_ACCESSTOKEN}}

Skipping Participant ​

{{SKIPPING_PARTICIPANT_EMAILADDRESS}}
{{SKIPPING_PARTICIPANT_FIRSTNAME}}
{{SKIPPING_PARTICIPANT_FULLNAME}}
{{SKIPPING_PARTICIPANT_ID}}
{{SKIPPING_PARTICIPANT_INITIALS}}
{{SKIPPING_PARTICIPANT_ORGANIZATION}}
{{SKIPPING_PARTICIPANT_PHONENUMBER}}
{{SKIPPING_PARTICIPANT_STATUS}}
{{SKIPPING_PARTICIPANT_TITLE}}

So, for example, if you want to personalize the notification shown below with a first name and a number for the participant to call if they have questions you could do the following:

Dear {{FirstName}},

Please sign your document by clicking on the link below:

{{PARTICIPANT_ACCESSLINK}}

Thanks,

Alan Agent
MyCompany, Inc.
{{SupportPhoneNumber}}

If you used the following code:

csharp
participant = new ParticipantInsertModel()
            {
                FullName = "John Smith",
                EmailAddress = "john.smith@your-domain.com",
                SendRequestViaEmail = true,
                EmailTemplateSetName = "MyCustomTemplateSet",
                EmailNotifications = new List<object>{
                                    new EmailNotificationModel() {
                                        Subject = "My Custom Email Subject",
                                        SendDelayInMinutes = 0,
                                        Placeholders = new List<object>
                                        {
                                            new EmailNotificationPlaceholderModel()
                                            {
                                                Name = "MyEmailPlaceholderName",
                                                Value = "My Email Placeholder Value"
                                            }
                                        }
                                    }
                                },
                //You can assign global placeholders here but they are overridden in the 
                //Participant Request email if you using the EmailNotifications Property shown above
                EmailTemplatePlaceholders = new List<object> 
                {
                    new EmailTemplatePlaceholderModel()
                    {
                        Name = "FirstName",
                        Value = "John"
                    },
                    new EmailTemplatePlaceholderModel()
                    {
                        Name = "SupportPhoneNumber",
                        Value = "555-555-5555"
                    }
                }
            }

The final output notification to the Participant would look something like this:

Dear John,

Please sign your document by clicking on the link below:

https://www.your-domain.com/ProntoNet/DocSign.aspx?PartID=1234567890&pat=JK82PA3SKFESNBV4P2OU3R776CF9440CKH499ES0V

Thanks,

Alan Agent MyCompany, Inc. 555-555-5555

"From" Addresses ​

The FROM email name and address used for emails sent during a specific transaction is set by these rules in this order:

  1. If the Transaction's OutgoingEmailFromName and OutgoingEmailFromAddress properties are set in the CreateTransactions() API method call this From Name and Email Address will be used for all outgoing emails for this transaction.
  2. If not defined in transaction as described above, the outgoing emails for the transaction will be sent from the Owner Name and Owner Email address (which is configured in the Pronto Control Panel's Group section).
  3. For any outgoing emails that are not account-related or transaction-related, the outgoing emails from come from the Temp_Email_Name and Temp_Email_Addr system-wide configuration setting values. These must be set by a system administrator in the \AlphaTrust\Pronto\Programs\ProntoConfig.ini file.

Copyright © 1998-present AlphaTrust