Fortinet black logo

Administration Guide

Customizing FortiRecorder and Messages

Copy Link
Copy Doc ID f41cea3c-ee48-11eb-97f7-00505692583a:928455

Customizing FortiRecorder and Messages

This section contains settings to customize messages sent by the FortiRecorder unit and the overall appearance of the web UI.

Customizing replacement messages

The FortiRecorder system delivers custom system messages to the user, such as disclaimers or camera notifications.

The disclaimers and notifications are customizable. When you create email template in System > Customization > Custom Email Template, you can use many of the replacement messages.

To view the replacement message list

  1. Go to System > Customization > Custom Message.
  2. Expand the section to display the replacement messages for that category. The message list organizes replacement messages into types, such as System. Double-click each replacement message to customize that message. You can reword existing messages or create new ones.

Additionally, you can modify the text and HTML code within a replacement message to suit your requirements.

You can change the content of the replacement message by editing the text and HTML codes and by working with replacement message variables.

All message groups can be edited to change text, or add text and variables.

To customize text replacement messages

  1. Go to System > Customization > Custom Message.
  2. Select a message and select Edit.
  3. Enter the desired message in the content area. There is a limit of 4000 characters for each message.
  4. Some messages can contain custom variables, such as the date. To add a custom variable to the message:
    • Select Insert Variables. If no custom variables exist, the Insert Variables link does not appear.
    • Place your mouse cursor in the text message at the insertion point of the variable.
    • Select the name of the variable to add. It will appear at the insertion point.
    • Select the close icon.
  5. Select OK.

In addition to adding predefined variables to your system messages, you can create new variables. Typically these variables represent frequently used messages. You can modify the variables that you create, but you cannot edit or delete the predefined variables.

To create a new variable

  1. Go to System > Customization > Custom Messages.
  2. Select a message and then select Edit Variable.
  3. Select New.
  4. Configure the following:

    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 word “warning”, this variable appears as %%warning%% in the system message if you select to insert it.

    Display name

    Enter a description for the variable. The display name appears in the variable list when you select Insert Variables while customizing a message or creating a variable.

    Content

    Enter the variable’s content. For example: The came %%CAMERA_NAME%% has detected motion on %%EVENTDATE%%.

  5. Select Create.

The following table is a list of default replacement:

Variable

Description

%%ADDRESS%%

The senders address of the notification message.

%%ADMIN_USER%%

The administrator notified by the notification message.

%%BODY%%

The content of the camera notification message.

%%CONTENT%%

The content of the alert message.

%%DATE%%

The day when the notification is sent.

%%EVENT_DATE%%

The day the event captured by the camera that triggered the notification.

%%EVENT_LINK%%

The link to the event captured by the camera that triggered the notification.

%%EVENT_TITLE%%

The title of the event captured by the camera that triggered the notification.

%%HOSTNAME%%

The name of the host.

%%LOCATION%%

The location of the event that triggered the notification and that is featured in the clip.

%%MOBILE_APPLE_BADGE%%

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

%%MOBILE_GOOGLE_BADGE%%

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

%%MOBILE_APPLE_URL%%

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

%%MOBILE_GOOGLE_URL%%

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

%%MOBILE_QR%%

The placement of the QR code in the mobile account registration email.

%%MOBILE_QR_URL%%

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

%%MOBILE_EXPIRATION%%

The expiration time in the mobile account registration email.

%%NOTIFY_FROM%%

The notification from the alert message.

%%PIC_INDEX%%

Inserts a reference to the snapshot.

%%POSTMASTER%%

The name of the administrator of the email.

%%PUBLIC_ADDRESS%%

The publicly available email address.

%%QR_CODE%%

The location of the QR code.

%%QR_CODE_URL%%

The location of the QR code's address.

%%SENDER%%

The senders address of the notification message.

%%SUBJECT%%

The subject of the notification.

%%VID_LINK%%

The link to the clip that triggered the notification.


Customizing email templates

The FortiRecorder unit may send out notification emails for events such as alert or camera notification.


To customize email templates

  1. Go to System > Customization > Custom Email Templates.
  2. Select the template and then select 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, select Insert Variable.
  5. Determine if the HTML code was entered correctly by selecting Preview.
  6. Select OK.

Customizing the user interface appearance

You can customize the interface of the FortiRecorder, such as changing the default color of the interface or adding your own custom logo.

To customize the user interface appearance

  1. Go to System > Customization > Appearance.
  2. Configure the following to change the appearance of the UI:

    Setting Name

    Description

    Product name

    Enter the name of the product.

    Custom top logo

    Select Change to upload an icon used as the favicon for the FortiRecorder UI. The image’s dimensions must be 460 pixels wide by 36 pixels tall.

    Tooltip

    Use an image with a transparent background. Non-transparent backgrounds will not blend with the underlying theme graphic, resulting in a visible rectangle around your logo graphic.

    Note

    Uploading a graphic overwrites the current graphic. The FortiMail unit does not retain previous or default graphics. If you want to revert to the current graphic, use your web browser to save a backup copy of the image to your management computer, enabling you to upload it again at a later time.

    Default Theme

    Select the default display theme (red, green, blue, and light blue) for the display of the web-based manager and login page.

    You can configure separate theme preferences for each administrator account. For details, see the Configuring an administrator account section.

  3. Select Apply.

Customizing Single Sign On

The FortiRecorder provides custom single sign on methods.

To configure single sign on

  1. Go to System > Customization > Single Sign On.
  2. Enable Single Sign On.
  3. Enter your Identity Provider Metadata in the entry field.
  4. Enter the necessary information in the FortiRecorder Service Provider Metadata section fields.
  5. Select Apply.

To configure FortiRecorder Admin Account Single Sign On to work with PingIdentity, see the Using Single Sign On with PingIdentity section in the FortiRecorder Cookbook.

Customizing FortiRecorder and Messages

This section contains settings to customize messages sent by the FortiRecorder unit and the overall appearance of the web UI.

Customizing replacement messages

The FortiRecorder system delivers custom system messages to the user, such as disclaimers or camera notifications.

The disclaimers and notifications are customizable. When you create email template in System > Customization > Custom Email Template, you can use many of the replacement messages.

To view the replacement message list

  1. Go to System > Customization > Custom Message.
  2. Expand the section to display the replacement messages for that category. The message list organizes replacement messages into types, such as System. Double-click each replacement message to customize that message. You can reword existing messages or create new ones.

Additionally, you can modify the text and HTML code within a replacement message to suit your requirements.

You can change the content of the replacement message by editing the text and HTML codes and by working with replacement message variables.

All message groups can be edited to change text, or add text and variables.

To customize text replacement messages

  1. Go to System > Customization > Custom Message.
  2. Select a message and select Edit.
  3. Enter the desired message in the content area. There is a limit of 4000 characters for each message.
  4. Some messages can contain custom variables, such as the date. To add a custom variable to the message:
    • Select Insert Variables. If no custom variables exist, the Insert Variables link does not appear.
    • Place your mouse cursor in the text message at the insertion point of the variable.
    • Select the name of the variable to add. It will appear at the insertion point.
    • Select the close icon.
  5. Select OK.

In addition to adding predefined variables to your system messages, you can create new variables. Typically these variables represent frequently used messages. You can modify the variables that you create, but you cannot edit or delete the predefined variables.

To create a new variable

  1. Go to System > Customization > Custom Messages.
  2. Select a message and then select Edit Variable.
  3. Select New.
  4. Configure the following:

    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 word “warning”, this variable appears as %%warning%% in the system message if you select to insert it.

    Display name

    Enter a description for the variable. The display name appears in the variable list when you select Insert Variables while customizing a message or creating a variable.

    Content

    Enter the variable’s content. For example: The came %%CAMERA_NAME%% has detected motion on %%EVENTDATE%%.

  5. Select Create.

The following table is a list of default replacement:

Variable

Description

%%ADDRESS%%

The senders address of the notification message.

%%ADMIN_USER%%

The administrator notified by the notification message.

%%BODY%%

The content of the camera notification message.

%%CONTENT%%

The content of the alert message.

%%DATE%%

The day when the notification is sent.

%%EVENT_DATE%%

The day the event captured by the camera that triggered the notification.

%%EVENT_LINK%%

The link to the event captured by the camera that triggered the notification.

%%EVENT_TITLE%%

The title of the event captured by the camera that triggered the notification.

%%HOSTNAME%%

The name of the host.

%%LOCATION%%

The location of the event that triggered the notification and that is featured in the clip.

%%MOBILE_APPLE_BADGE%%

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

%%MOBILE_GOOGLE_BADGE%%

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

%%MOBILE_APPLE_URL%%

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

%%MOBILE_GOOGLE_URL%%

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

%%MOBILE_QR%%

The placement of the QR code in the mobile account registration email.

%%MOBILE_QR_URL%%

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

%%MOBILE_EXPIRATION%%

The expiration time in the mobile account registration email.

%%NOTIFY_FROM%%

The notification from the alert message.

%%PIC_INDEX%%

Inserts a reference to the snapshot.

%%POSTMASTER%%

The name of the administrator of the email.

%%PUBLIC_ADDRESS%%

The publicly available email address.

%%QR_CODE%%

The location of the QR code.

%%QR_CODE_URL%%

The location of the QR code's address.

%%SENDER%%

The senders address of the notification message.

%%SUBJECT%%

The subject of the notification.

%%VID_LINK%%

The link to the clip that triggered the notification.


Customizing email templates

The FortiRecorder unit may send out notification emails for events such as alert or camera notification.


To customize email templates

  1. Go to System > Customization > Custom Email Templates.
  2. Select the template and then select 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, select Insert Variable.
  5. Determine if the HTML code was entered correctly by selecting Preview.
  6. Select OK.

Customizing the user interface appearance

You can customize the interface of the FortiRecorder, such as changing the default color of the interface or adding your own custom logo.

To customize the user interface appearance

  1. Go to System > Customization > Appearance.
  2. Configure the following to change the appearance of the UI:

    Setting Name

    Description

    Product name

    Enter the name of the product.

    Custom top logo

    Select Change to upload an icon used as the favicon for the FortiRecorder UI. The image’s dimensions must be 460 pixels wide by 36 pixels tall.

    Tooltip

    Use an image with a transparent background. Non-transparent backgrounds will not blend with the underlying theme graphic, resulting in a visible rectangle around your logo graphic.

    Note

    Uploading a graphic overwrites the current graphic. The FortiMail unit does not retain previous or default graphics. If you want to revert to the current graphic, use your web browser to save a backup copy of the image to your management computer, enabling you to upload it again at a later time.

    Default Theme

    Select the default display theme (red, green, blue, and light blue) for the display of the web-based manager and login page.

    You can configure separate theme preferences for each administrator account. For details, see the Configuring an administrator account section.

  3. Select Apply.

Customizing Single Sign On

The FortiRecorder provides custom single sign on methods.

To configure single sign on

  1. Go to System > Customization > Single Sign On.
  2. Enable Single Sign On.
  3. Enter your Identity Provider Metadata in the entry field.
  4. Enter the necessary information in the FortiRecorder Service Provider Metadata section fields.
  5. Select Apply.

To configure FortiRecorder Admin Account Single Sign On to work with PingIdentity, see the Using Single Sign On with PingIdentity section in the FortiRecorder Cookbook.