Template Customizations

​

Branding Customizations

​

Change the Company Logo

• URL: Use a publicly accessible link to a logo image.
• Embedded file: Store a base64-encoded image file within XSP.

1. Click the style folder to expand it and click the default.yml file.
2. The first part in the section titled Branding & Colors is marked as #logo:.
3. Using the ++ctrl+slash++ (++cmd+slash++ on macOS) keyboard shortcut, uncomment its first line (that is logo:) and the last two lines, then change them to the following convention:
   • when using a URL link to the graphics:
   logo:
     location: "https://your.site/logo.png"
     type: "LINK"
   
   • when using graphics embedded in a txt file (note that the path is relative to the email_templates folder, not to the root directory):
   logo:
     location: "shared/logo_filename.txt"
     type: "PNG_BASE_64"
   
4. In the case of a URL link, click Publish to accept changes. In the case of a txt file, add a new folder using the context menu for the shared/email_templates folder.
5. Enter shared as the name of the folder in the dialog box that appears and click Create.
6. Use the same context menu technique on the newly created shared folder, but this time select New File from the menu. Enter the name for the logo file and click Create.
7. Scroll down to the file you have just created, click it, and in the right pane paste the result of Base64 encoding the logo. Click Publish to accept changes.

​

Change the colors

1. Click the style folder to expand it and click the default.yml file.
2. The second part in the section titled Branding & Colors is marked as #colors:.
3. Using the ++ctrl+slash++ (++cmd+slash++ on macOS) keyboard shortcut, uncomment the colors line and the required lines that follow. Enter new values for color properties that can be changed:
   • error, alert, warning, ok, neutral—the color of the text label for the findings (aka the “kicker”, e.g., ALERT, WARN, GREEN LIGHT or UNDECIDED)
   • background—self-explanatory: the color of the background
   • light and dark—reserved (unused)
   • info—links in the SSQ digest (message subject)
   • subscript—secondary text in the SSQ digest (message info: from, date, etc.)
4. Click Publish to accept changes.

​

Change the font

1. Click the style folder to expand it and click the default.yml file.
2. Go to the section titled Typography.
3. Using the ++ctrl+slash++ (++cmd+slash++ on macOS) keyboard shortcut, uncomment the font line and the required lines that follow. Enter new values for font properties that can be changed:
   • size—if you want to specify a new size
   • family—if you want to use another font family
   • color—for specifying a new font color

font:
  size: "12"
  family: "Lato, 'Helvetica Neue', Helvetica, Arial, sans-serif"
  color: "#0e0e0e"

​

Company Information

1. Click the info folder to expand it and click the default.yml file.
2. Using the ++ctrl+slash++ (++cmd+slash++ on macOS) keyboard shortcut, uncomment the required lines. Enter new values for company info properties that can be changed:
   • name—your company name
   • details—additional info, e.g., the department name such as "Security Operations Center"
   • email—contact email address
   • url—the URL address for a self-service quarantine link in notification mails, e.g., "https://customer.activeguard.cloud"
   • provider—the name of the service provider

name: "MyCompany, Inc."
details: "Security Operations Center"
email: "secops@mycompany.com"
url: "https://mycompany.activeguard.cloud"
provider: "xorlab AG"

​

Localization

1. Click the locale folder to expand it and click the default.yml file.
2. In the right pane, select and copy the whole content of the file.
3. Use the context menu for the locale folder to add a new file.
4. Enter the name for the file in the dialog box that appears. Use the convention of default_lang_COUNTRY.yml, e.g., default_pt_BR.yml for the Brazilian Portuguese version of a file. Click Create.
5. Scroll down to the file you have just created, click it, and in the right pane paste the content of the previously copied content of the default.yml file. For each template entry in the new localization file, replace the default text with its translation. Click Publish to accept changes.

​

Change the default language

1. Click the config folder to expand it and click the default.yml file.
2. You will see only one entry: defaultLocale. Set it to your country code (currently, only EN and DE values are supported).
3. Click Publish to accept changes.

​

Using Language Headers

emailReporting:
  ## Header name for specifying locale (default = x-ag-locale)
  localeIdentifyingMailHeaderName: my-custom-language-header

​

Managing Templates

​

Disable a Template

1. In the main shared/email_templates folder, click a .yml file for the notification template you want to disable.
2. In the right pane, go to the category keyword and change its value from ANALYST_FEEDBACK to DEFAULT.
3. Repeat these actions for every unwanted template and click Publish to accept changes.

​

Create a New Template

1. Use the context menu for the email_templates folder to create a new file inside of it.
2. Enter NOTIFICATION_NAME.yml as the name for the file in the dialog box that appears. Click Create.
3. Scroll down to the file you just created, click it, and in the right pane paste the following content:
   # Note: The `id` must be the same template identifier as the file name.
   id: NOTIFICATION_NAME
   # The type of notification for the template (default: DEFAULT)
   # Supports: DEFAULT, ALERT, ERROR, WARN, CLEAR, ACK
   type: DEFAULT
   # The notification category for the template. Use ANALYST_FEEDBACK for feedback to reported emails.
   # Supports: DEFAULT, ANALYST_FEEDBACK, FILE_ANALYSIS, QUARANTINE_NOTIFICATION
   category: ANALYST_FEEDBACK
   # The following block is only supported for category ANALYST_FEEDBACK
   analystFeedbackConfig:
     displayText: "Template display text"
     # Choose any of the predefined verdicts
     verdict: "phishing"
     defaultSelection: true
   
4. Enter values that match the template usage—please refer to the Template configuration section.
5. Go to the locale folder and, in each localization file of the default tenant, add a new entry for the new NOTIFICATION_NAME template using the YAML structure given below. For example, to localize the email notification into US English, add the following lines to default.yml:
   ################################################################################
   ## NOTIFICATION NAME                                                          ##
   ################################################################################
   NOTIFICATION_NAME:
     subject: "This is a subject example for a new template"
     preview: "This is a preview example for a new template"
     disclaimer: "This is a disclaimer example for a new template"
     kicker: "This is a kicker example for a new template"
     title: "This is a title example for a new template"
     summary: "This is a summary example for a new template"
     details:
       title: "This is a detailed info title example for a new template"
       paragraphs:
         - "This is the first paragraph example for a new template"
         - "This is the second paragraph example for a new template"
     providerNotice: "This is a provider notice example for a new template"
   

​

Template configuration

​

Using variables in templates