7.0 Customizing Email Notifications

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

About TeamWorks’s Email Templates

TeamWorks generates email notifications using Apache Velocity version 1.5 templates.

You can customize the following templates:

Template Name

Purpose

footer.vm

Text or images applied at the end of each email

header.vm

Text or images applied at the beginning of each email

passwordChangedNotification.vm

Notification that user’s password changed

publicLinkNotification.vm

Notifcation of a publicly available link to a file

selfRegistrationRequired.vm

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

sharedEntryInvite.vm

Shared file invitation to an existing TeamWorks user

sharedEntryNotification.vm

Shared file notification of change to existing TeamWorks user

sharedFolderInvite.vm

Shared folder invitation to existing TeamWorks user

sharedFolderNotification.vm

Shared folder notification of change to existing TeamWorks user

style.vm

CSS style sheet for email notifications

teaming.vm

Macros that get applied to all emails

Template Tips and Documentation

IMPORTANT:Micro Focus TeamWorks 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 TeamWorks.

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

  • TeamWorks 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 TeamWorks 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 TeamWorks 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 created for the Micro Focus Filr release: