Fortinet black logo

Administration Guide

Customizing notification templates

Customizing notification templates

You can customize messages that the FortiRecorder appliance sends.

Customizing system messages

Some messages that the GUI show to the user, such as an unauthorized login warning or camera event notifications, can be customized. You can modify both their text and HTML.

Variables can be used if you want to insert the same text in a message multiple times. In addition to using predefined variables (see Predefined variables), you can create your own new, custom variables.

To create a variable for custom messages

  1. Go to System > Customization > Custom Message.
  2. Select a message row.

    The Edit Variable button is greyed out and not available until you select a message.

    Tooltip

    The scope of a variable is for a specific message; it cannot be used in other messages or templates. If you require the same text in multiple templates or messages, create a variable in each.

  3. Click Edit Variable.
  4. Click New.

    You can modify the variables that you create, but you cannot edit or delete the predefined variables.

  5. Configure the following settings:

    Setting Name

    Description

    Name

    Enter the variable name to use in the system message. Its format is:

    %%<variable_name>%%

    For example, if you enter the name downtime_warning, then when you configure a customized message and insert this variable, its placement will be indicated as:

    %%downtime_warning%%

    The variable's Content will be inserted in that location each time FortiRecorder displays that message.

    Display name

    Enter a description for the variable.

    Content

    Enter the variable's content.

  6. Click Create.

To customize a system message

  1. Go to System > Customization > Custom Message.
  2. Double-click the message that you want to customize, or select its row and click Edit.
  3. Edit the text. The maximum length is 4000 characters.

    Optionally, if you want to insert a variable, place your text cursor, click Insert Variables, and then click the name of the variable.

  4. Click OK.

Customizing email templates

Similar to system messages, you can customize the templates that FortiRecorder uses for system alerts and camera notifications via email and SMS. The templates support both custom and predefined variables (see Predefined variables).

To customize email templates

  1. Go to System > Customization > Custom Email Templates.
  2. Select the template and then click Edit.
  3. Enter the necessary information, such as the name and a brief description.
  4. In the content section, format the message in HTML. To add variables, click Insert Variable.
  5. Determine if the HTML code was entered correctly by selecting Preview.
  6. Click OK.
Predefined variables

Like the variables that you create, each predefined variable usually can only be used within the scope of a specific type of system message or email template, as shown below.

Alert email

Variable

Description

%%ADDRESS%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%ADMIN_USER%%

The administrator notified by the message.

%%CONTENT%%

The content of the alert email.

%%DATE%%

The date when the event occurred.

%%HOSTNAME%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%NOTIFY_FROM%%

The sender email address of the email. The value is configured in Display name and Email address.

%%POSTMASTER%%

The postmaster email address of the email.

%%SENDER%%

The sender email address of the email. The value is configured in Display name and Email address.

%%SUBJECT%%

The subject line of the email.

Mobile account registration email

Variable

Description

%%MOBILE_APPLE_BADGE%%

The placement of the Apple icon in the mobile account registration email.

%%MOBILE_APPLE_URL%%

The placement of Apple's address in the mobile account registration email.

%%MOBILE_EXPIRATION%%

The expiration time in the mobile account registration email.

%%MOBILE_GOOGLE_BADGE%%

The placement of the Google icon in the mobile account registration email.

%%MOBILE_GOOGLE_URL%%

The placement of Google's address in the mobile account registration email.

%%MOBILE_QR%%

The QR code image in the mobile account registration email.

%%MOBILE_QR_URL%%

A hyperlink alternative to the QR code image in the mobile account registration email.

%%SENDER%%

The sender email address (From:) of the email. When using the default mail server settings, the value is:

FortiRecorder <noreply@fortirecorder.com>

Camera notification email

Variable

Description

%%BODY%%

The content of the camera notification message.

%%EVENT_DATE%%

The date when the event occurred.

%%EVENT_LINK%%

A hyperlink to the video recording of the event.

%%EVENT_TITLE%%

The title of the event.

%%PUBLIC_ADDRESS%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%SENDER%%

The sender email address (From:) of the email. When using the default mail server settings, the value is:

FortiRecorder <noreply@fortirecorder.com>

%%SUBJECT%%

The subject line in the email.

Camera notification web

Variable

Description

%%CAMERA_NAME%%

The name of the camera that triggered the notification.

%%EVENTDATE%%

The date when the event occurred.

%%EVENT_DESCRIPTION%%

The content of the camera notification message.

%%MODEL_IMAGE%%

An image that shows the FortiRecorder model number.

%%NOTIF_NAME%%

The title of the event.

%%NOTIF_ROW%%

A hyperlink to the video recording of the event.

Customizing notification templates

You can customize messages that the FortiRecorder appliance sends.

Customizing system messages

Some messages that the GUI show to the user, such as an unauthorized login warning or camera event notifications, can be customized. You can modify both their text and HTML.

Variables can be used if you want to insert the same text in a message multiple times. In addition to using predefined variables (see Predefined variables), you can create your own new, custom variables.

To create a variable for custom messages

  1. Go to System > Customization > Custom Message.
  2. Select a message row.

    The Edit Variable button is greyed out and not available until you select a message.

    Tooltip

    The scope of a variable is for a specific message; it cannot be used in other messages or templates. If you require the same text in multiple templates or messages, create a variable in each.

  3. Click Edit Variable.
  4. Click New.

    You can modify the variables that you create, but you cannot edit or delete the predefined variables.

  5. Configure the following settings:

    Setting Name

    Description

    Name

    Enter the variable name to use in the system message. Its format is:

    %%<variable_name>%%

    For example, if you enter the name downtime_warning, then when you configure a customized message and insert this variable, its placement will be indicated as:

    %%downtime_warning%%

    The variable's Content will be inserted in that location each time FortiRecorder displays that message.

    Display name

    Enter a description for the variable.

    Content

    Enter the variable's content.

  6. Click Create.

To customize a system message

  1. Go to System > Customization > Custom Message.
  2. Double-click the message that you want to customize, or select its row and click Edit.
  3. Edit the text. The maximum length is 4000 characters.

    Optionally, if you want to insert a variable, place your text cursor, click Insert Variables, and then click the name of the variable.

  4. Click OK.

Customizing email templates

Similar to system messages, you can customize the templates that FortiRecorder uses for system alerts and camera notifications via email and SMS. The templates support both custom and predefined variables (see Predefined variables).

To customize email templates

  1. Go to System > Customization > Custom Email Templates.
  2. Select the template and then click Edit.
  3. Enter the necessary information, such as the name and a brief description.
  4. In the content section, format the message in HTML. To add variables, click Insert Variable.
  5. Determine if the HTML code was entered correctly by selecting Preview.
  6. Click OK.
Predefined variables

Like the variables that you create, each predefined variable usually can only be used within the scope of a specific type of system message or email template, as shown below.

Alert email

Variable

Description

%%ADDRESS%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%ADMIN_USER%%

The administrator notified by the message.

%%CONTENT%%

The content of the alert email.

%%DATE%%

The date when the event occurred.

%%HOSTNAME%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%NOTIFY_FROM%%

The sender email address of the email. The value is configured in Display name and Email address.

%%POSTMASTER%%

The postmaster email address of the email.

%%SENDER%%

The sender email address of the email. The value is configured in Display name and Email address.

%%SUBJECT%%

The subject line of the email.

Mobile account registration email

Variable

Description

%%MOBILE_APPLE_BADGE%%

The placement of the Apple icon in the mobile account registration email.

%%MOBILE_APPLE_URL%%

The placement of Apple's address in the mobile account registration email.

%%MOBILE_EXPIRATION%%

The expiration time in the mobile account registration email.

%%MOBILE_GOOGLE_BADGE%%

The placement of the Google icon in the mobile account registration email.

%%MOBILE_GOOGLE_URL%%

The placement of Google's address in the mobile account registration email.

%%MOBILE_QR%%

The QR code image in the mobile account registration email.

%%MOBILE_QR_URL%%

A hyperlink alternative to the QR code image in the mobile account registration email.

%%SENDER%%

The sender email address (From:) of the email. When using the default mail server settings, the value is:

FortiRecorder <noreply@fortirecorder.com>

Camera notification email

Variable

Description

%%BODY%%

The content of the camera notification message.

%%EVENT_DATE%%

The date when the event occurred.

%%EVENT_LINK%%

A hyperlink to the video recording of the event.

%%EVENT_TITLE%%

The title of the event.

%%PUBLIC_ADDRESS%%

The IP address or domain name of FortiRecorder that is used in hyperlinks.

See Public Access Host name and Access Ports Service.

%%SENDER%%

The sender email address (From:) of the email. When using the default mail server settings, the value is:

FortiRecorder <noreply@fortirecorder.com>

%%SUBJECT%%

The subject line in the email.

Camera notification web

Variable

Description

%%CAMERA_NAME%%

The name of the camera that triggered the notification.

%%EVENTDATE%%

The date when the event occurred.

%%EVENT_DESCRIPTION%%

The content of the camera notification message.

%%MODEL_IMAGE%%

An image that shows the FortiRecorder model number.

%%NOTIF_NAME%%

The title of the event.

%%NOTIF_ROW%%

A hyperlink to the video recording of the event.