14.0 Notification (Email) Customization

You can customize many of the Filr-generated strings that appear in notifications sent to Filr users.

About Filr’s Email Templates

Filr generates email notifications using Apache Velocity version 1.5 templates.

You can customize the following templates:

Template Name

Purpose

externalConfirmation.vm

Confirmation notification sent to an external user after the user is successfully registered with Filr server.

fileRequestNotification.vm

A mail is sent requesting the external user to upload a file to the Filr server.

fileRequestUploadNotification.vm

A confirmation mail is received by the Filr user when the file is uploaded to the Filr server.

footer.vm

Text or images applied at the end of each email.

followEmailOnly.vm

On enabling Follow, an email notification is sent to a user for each operation performed on the file or a folder.

followEmailDigest.vm

On enabling Follow, an email with the summary of all the operation performed on the files in a folder is sent to a user.

forgottenPasswordNotification.vm

Forgotten password notification sent to a user when the user clicks Can't login link on the login page to request for a new password.

header.vm

Text or images applied at the beginning of each email

passwordChangedNotification.vm

Notification that user’s password changed

publicLinkNotification.vm

Notification of a publicly available link to a file

selfRegistrationRequired.vm

Shared item notification to user who must register with Filr in order to view it

shareAccessedNotification.vm

Notification that the file or folder is accessed by the user.

sharedEntryInvite.vm

Shared file invitation to an external user

sharedEntryNotification.vm

Shared file notification of change to existing Filr user

sharedFolderInvite.vm

Shared folder invitation to external user

sharedFolderNotification.vm

Shared folder notification of change to existing Filr user

storageAlertEmail.vm

Storage notification that the Filr server sends to Filr administrators when vashare or vastorage storage is 90% filled.

style.vm

CSS style sheet for email notifications

teaming.vm

Macros that get applied to all emails

zoneQuotaAlertEmail.vm

An alert mail to the zone administrator and inbuilt (main) administrator when a user has used all the allocated space.

Template Tips and Documentation

IMPORTANT:Micro Focus doesn’t attempt to document third-party products, such as Apache Velocity.

For complete information and instructions for the Apache Velocity version 1.5 template language, visit the Apache Velocity Project website.

The following are tips about the template files in Filr.

  • Each template contains a brief explanation about what it affects and what you can customize in it.

  • Filr system-generated emails contain both text and HTML MIME parts.

    You can customize these independently.

  • You can customize for specific languages to localize the emails your Filr system generates.

  • You can revert back to the default template by selecting a customized template in the list and then clicking the Delete button.

  • Make sure you use the Velocity documentation.

    For example, one user assumed that the hash marks (#) indicated comments, when in fact they are part of the Velocity scripting language.

Modifying the Email Template Files

The default email templates that reside on the Filr system cannot be changed or deleted, but you can create and deploy customized copies of them by doing the following:

  1. Download a template to your local disk by clicking it in the Email Templates dialog.

  2. Open the downloaded template in a text editor.

  3. Customize the file as discussed in the Video Walkthrough below and documented on the Apache Velocity Project website.

  4. Save the template on your local disk.

  5. Upload the customized file by dragging and dropping it into the Email Templates dialog.

    The Type then changes to Customized.

Email Template Customization—A Video Walkthrough

To see a demonstration of the email template customization process, view the following video: