Custom Motion Alert Email Templates

Orchid Fusion may be configured to send customized email motion alerts by specifying a template file in the Orchid Fusion properties file.  For more information about editing the Orchid Fusion properties file, see the section "How to Edit a Configuration File" in the Orchid Fusion VMS Installation Guide.

Template Requirements

• Motion Alert Custom template files may only be HTML, XML, or TXT.
• Custom templates must end in the extension ".tmpl" (ex: template.html.tmpl).
• Users must specify a custom template in the fusion.properties file using the following property: motion.alerter.email.template=<path>
• The path specified in the properties file must be an absolute path to the custom template.  For example:
  /etc/opt/fusion/motion-alert-template.txt.tmpl or C:\Program Files\IPConfigure\Fusion\template.txt.tmpl

Template Formatting

Custom templates have two sections; subject and body.

Subject

The subject of the email corresponds to the first line of the template file. Any characters in this line will be presented as the subject of the email.

Body

The body of the email corresponds to the second line through the end of the template file. Any characters in these lines will be presented as the body of the email. Feel free to format this as you wish; your styling will be retained.

Replaceable Tokens

The following tokens can be included in subject and/or body to be replaced with their respective values:

• @orchid_name@ - This token is replaced by the name of the individual attached server that an event occurred on.
• @camera_name@ - This token is replaced with the name of the camera that detected the motion event.
• @event_time@ - This token is replaced with the time an event occurred in Epoch Milli format.
• @event_time_formatted@ - This token is replaced with the string representation of the start time of a motion event in the form "EEEE, MMMM dd, YYYY HH:mm:ss" in the time of that server.
• @time_zone@ - This token is replaced with the TimeZone of an attached server as reported by that server.
• @server_url@ - This token is replaced with a URL to the parent server (ie Fusion) that the child server reporting the event is attached to.
• @brand_name@ - This token is replaced with the Branded name of the parent server (ie Fusion)
• @orchid_uuid@ - This token is replaced with the UUID associated with the server where the motion event occurred.
• @camera_id@ - This token is replaced with the UUID associated with the camera that detected the motion event.
• @stream_id@ - This token is replaced with the integer id of the stream of the camera that detected the motion event.