User interface customization

Graphical user interface

In Settings > Rebranding different parts of the GUI can be rebranded with customized images and text. Currently the following GUI parts are supported

  1. Rescan page: page of quarantine actions that are available as quarantine report or notification email actions.

Customization

To change a GUI element, hover over it with the mouse. If changing the element is supported, then the GUI element gets a blue box:

Image elements

Images can be replaced or hidden. An uploaded image is resized automatically to fit its container. Uploaded images must be less than 5MBs.

In shared database setups, images set on one instance are distributed to other instances in every 10 minutes potentially causing delay for customized GUIs on other instances.

Text elements

Only the text string can be customized. The text formatting (e.g. weight) comes from the default design.

Translations are supported through the GUI for the locales that are defined for the product. For details see Translation.

To show the translated version of the GUI part, select the appropriate locale from the Language dropdown.

HTML elements

For certain elements (that typically require more complex customization) a WYSWYG/HTML editor is supported.

To view and edit the HTML source of the element, click the </> button.

Restore to default

Each individual GUI element or the GUI part as a whole can be restored to the default.

Alert, notification and quarantine report emails

By default, alert, notification and quarantine report emails have an OPSWAT styling (colors, logos, texts). The default templates of these emails are stored as xslt templates. If the text or the style of the alert, notification and quarantine report emails need to be changed, the appropriate xslt template needs to be edited.

Overview

Templates of the notification, alert and report emails can be found in:

Copy

Default:

Copy

These files are plain text xslt (Extensible Stylesheet Language Transformations) files, that can be edited using plain text editors or xslt editors.

Content and structure of the xslt templates can be changed to customize the alert, notification and quarantine report emails.

Examples

The template for blocked notifications can be found in the notification_blocked.xsl file. It is an XSLT file which contains HTML, CSS and XSLT elements. By modifying the HTML and CSS elements you can get a different look or language for your notifications. XSLT elements should not be modified as we use them to fill the email with actual data.

By default, the blocked notification email looks like below. In the following examples we will customize this.

In order to replace the logo the appropriate image reference should be found and modified in the notification_blocked.xsl file:

Original logo
Copy

The new logo is placed as newlogo.png image in the img folder. In this case we should modify this part to look like this:

Modified logo
Copy

After this modification the notification email will look like this:

Customizing colors

To customize the colors of the table containing the information related to the blocked email modify this part in the style block of the xslt template:

Original colors
Copy
Modified colors
Copy

After this modification the notification email will look like this:

Removing blocks

Removing xslt elements may give unexpected results (e.g. information missing from the email).

To remove the Scan result link row from the notification email, the following part needs to be removed from the notification___blocked__.xsl template:

HTML
Copy

After this modification the notification email will look like this without the scan result row:

Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard