Customization and Re-branding Email Alerts

Customization of Notifications

You can customize the email notifications sent at the time of various milestones. You can edit the content and/or modify the look-and-feel of the notifications. A file named “custom-messages.properties” and a set of templates are provided inside the “conf/mail-templates” folder in your deployment location.

The properties file is organized into two sets of property name = value pairs; the top section denotes the phrases that will appear in the email notification subject fields at various milestones and the bottom section, whose property names end with “_D”, denotes the template HTML file names containing the body of the email notifications.
To edit the subject fields of your notifications, simply modify the corresponding values in the top section of the properties file.
To edit the content of the notification, please open the template HTML file and edit the file to change the content and/or the aspects like font, layout, colors, etc.

For example:

If you want to change the subject of the notifications sent on task modifications, you can do so by changing the value for the property named “TASK_EDIT”. Simply change the value as shown below, and save the properties file:

TASK_EDIT= Your task #{0} has been modified.

If you want to change the content of the notification sent out on task modifications, look up the name of the template file under the property name TASK_EDIT_D (default is “TASK_EDIT_D.html”) and open that HTML file; edit the template HTML file and save it.

Word of Caution: Do not edit the property names defined in the “custom-messages.properties” file. Change only the property values. Do not edit the property values or the templates if you are not sure of what you must do. The contents have been laid out in specific formats for us to be able to generate the notifications with dynamically fetched details of each job/user/milestone etc. Specifically: you will find interspersed in the template, strings like “{0}”, “{1}” etc. Please be very wary of editing or moving around these strings!!!

Parameters in Mail Templates

Here are the parameter details for the subject fields in the various notifications

Task Edit (denoted by the property TASK_EDIT)

  • {0}: Task ID

Task Deletion (denoted by the property TASK_RM)

  • {0}: Task ID

Lightbox Shared (denoted by the property LB_SHARED)*

  • {0}: Task ID
  • {1}: Task name

Request for Review (denoted by REVIEW_NEEDED)

  • {0}: Task ID
  • {1}: Job name
  • {2}: Task phase number

Task Ready-to-Start (denoted by TASK_STARTABLE)

  • {0}: Task ID
  • {1}: Job name
  • {2}: Task phase number

And here are the details of the parameters that get dynamically inserted into the mail notification body.

Archive Operation Completion (denoted by the property ARCHIVE_DONE_D)

  • {0}: The list of the fully-qualified path names of the assets that were successfully archived.

Restore Operation Completion (denoted by the property RESTORE_DONE_D)

  • {0}: The list of the fully-qualified path names of the assets that were successfully restored.

Restore Petition Completion (denoted by property named RESTORE_PETITION_DONE_D)

  • {0}: The list of the fully-qualified path names of the assets that were successfully petitioned for restore.

Restore Petition Rejection (denoted by property named RESTORE_PETITION_REJECT_DONE_D)

  • {0}: The list of the fully-qualified path names of the assets that were earlier petitioned for restore, but were rejected by the administrator.

Task Edit (denoted by the property TASK_EDIT_D)

  • {0}: Task name
  • {1}: Task ID
  • {2}: Job name

Task Deletion (denoted by the property TASK_RM_D)

  • {0}: Task name
  • {1}: Task ID
  • {2}: Job name

Task Startable (denoted by the property TASK_STARTABLE_D)

  • {0}: Task name
  • {1}: Task ID
  • {2}: Job name
  • {3}: Task phase number

Lightbox Review Request (denoted by the property LB_REVIEW_NEEDED_D)*

  • {0}: Task ID
  • {1}: Task name
  • {2}: Review server address in the form of “host”:”port”
  • {3}: Zoom server address (as IP)
  • {4}: Task owner username

Lightbox Review Request with Credentials(denoted by property named LB_REVIEW_NEEDED_CRED_D)*

  • {0}: Task ID
  • {1}: Task name
  • {2}: Review server address in the form of “host”:”port”
  • {3}: Zoom server address (as IP)
  • {4}: Task owner login name
  • {5}: Task owner user account password

Lightbox Review Pending (denoted by the property LB_REVIEW_PENDING_D)*

  • {0}: Task ID
  • {1}: Task name

Review Request (denoted by the property REVIEW_NEEDED_D)

  • {0}: Task ID
  • {1}: Task name
  • {2}: Job name
  • {3}: Task phase number

Review Request with Link (denoted by the property REVIEW_NEEDED_CRED_D)

  • {0}: Task ID
  • {1}: Task name
  • {2}: Review server address in the form of “host”:”port”
  • {3}: Zoom server address (as IP)
  • {4}: Task owner username
  • {5}: Job name
  • {6}: Task phase number

Review Request with Link and Credentials(denoted by the property REVIEW_NEEDED_CRED_D)

  • {0}: Task ID
  • {1}: Task name
  • {2}: Review server address in the form of “host”:”port”
  • {3}: Zoom server address (as IP)
  • {4}: Task owner username
  • {5}: Job name
  • {6}: Task phase number
  • {7}: Task owner login name
  • {8}: Task owner user account password

Re-branding Zoom Server

You can incorporate your client logo on our web-based Visual Approval page. Place your logo icon (preferred size is 64 x 64) into the webapp directory inside the Preview Server web-root directory. Make sure to call this image file as “logo.png”. Typically, the location should be like this: <Preview server web-root directory>/webapp/logo.png

Now when you open the Visual Approval for Lightbox, you can see your client’s logo at the top left*.

Typical Locations of Preview Server Web Root Directory:

macOS if preview server is started by root or through system restart
/Library/Application\ Support/Evolphin/servers/PreviewServer
macOS if preview server is started by some other user
/Users/<username>/Library/Application\ Support/Evolphin/servers/PreviewServer
Windows 32-bit
C:\\Program Files\\Evolphin\\DAM\\tmp\\servers\\PreviewServer
Windows 64-bit
C:\\Program Files (x86)\\Evolphin\\DAM\\tmp\servers\\PreviewServer
Linux
<zoom-install-dir>/webcontext/servers/PreviewServer

* Only available till Zoom 6.0.

Leave a Comment