Create a Notification Template

Fairways Debt enables you to send email notifications to users when documents are uploaded. Create notification templates to customize the content to meet your needs.

Note: Only administrators can manage notification templates.

 

Prerequisites
  1. Contact your Finance Active consultant to enable the Documents application.
  2. Create a Document Type.
  3. Design your template in an HTML file format.
    Note: The template must start with "<html>" and end with "</html>".

Note: The notification for uploaded documents must be enabled in the user account settings.

Navigate to the Account Administration
  1. Log in to your Fairways Debt account.
  2. Select a customer account.
  3. Navigate to Applications Applications.png > Account Administration.
Create a Notification Template
      1. Click Administration > Documents Module on the left menu.
      2. From the Notification Templates section, click Add Notification Template.
      3. On the popup window, click Download Template to download an Excel file containing the list of the available attributes which can be used in the template.
        You can then include the relevant attributes in your HTML template:

        Attribute

        Description

        objectLinkedType Transaction type
        objectLinkedReference Transaction reference
        documentName Document name
        documentType Document type
        documentURL External link redirecting to the document
        userFullName User name
        accessUrl External link to access the platform
        title Notification email title
        platformName Platform name
      4. On the same popup window, click Select a file and then browse a path to the template file.
      5. Click Apply.

UploadNotificationTemplate_EN.png

An integration report is then displayed: if no error is found in the template syntax, click Import.

IntegrationReport_EN.png

The new template is then added to the list in the Notification Templates section.

NotificationTemplatesArea_EN.png

Example of a Notification Template - Code Preview
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
 </head>
 <body>
<h1> <font style="font-size: 14px; text-transform: uppercase" color=#636466 face=arial><b> New document ${documentName} </b></font> </h1> <hr/>
<p> Hello, the document ${documentName} has been uploaded on ${documentURL} </p> <hr/> <p> <font color=#008000 size=1 face="Arial, Helvetica, sans-serif"> Please consider the environment before printing this e-mail.</font> </p> <p> <font color=#666666 size=1 face="Arial, Helvetica, sans-serif">This message and its attachments, if any, are confidential and are intended solely for the addressees. If you received this message in error, please delete it and notify the sender.</font> </p>
</body> </html>
Example of a Notification Template - Template Preview

New document ${documentName}


Hello, the document ${documentName} has been uploaded on ${documentURL}


Please consider the environment before printing this e-mail.

This message and its attachments, if any, are confidential and are intended solely for the addressees. If you received this message in error, please delete it and notify the sender.

What's Next?
Related Documentation
Was this article helpful?
0 out of 0 found this helpful