Customize emails

You can design an email template for each of ALM Octane entities, customize the email header and footer, and add a security tag to the email subject.

Email customization is set at the shared space level.

Design templates

Define an email template for each ALM Octane entity. The template includes the entity fields that will be listed in the email, and a definition of the email subject line.

To design email templates:

  1. In Settings > Spaces, select a shared space.

  2. Click Entities and select an item.

  3. Click Email.

  4. To add a field, click Add field.

  5. To change the order in which fields are displayed in the template, select a field and click the Move Up or Move Down buttons.

    Note: Memo fields must be placed above or below the Details section. Use the Move Up or Move Down button to place it accordingly.

  6. To delete a field, select a field and click Delete.

  7. In the Email Subject Prefix field, type a prefix for the email subject. Each field must be enclosed in curly brackets. Example: \{Octane\} – {workspace.id} – {severity}

    Example:

    1:

    Prefix script: \{Octane\} workspace id: {workspace.id} workspace name: {workspace.name}

    Output: {Octane} workspace id: 1002, workspace name: ws1

    2:

    Prefix script: defect name: {name}, severity: {severity}

    Output: defect name: defect A, severity: High

    Note: The subject prefix is used for emails generated automatically by business rules and notifications. It is not used for emails sent manually by a user via the toolbar command.

  8. To include output property fields in the email, make sure to include the Output properties field in your template. For example, to include a link to the document report generated by an auto action, add the Output properties field.
  9. To save changes, click Save.

  10. Click Set as default if you want to use this template as the default.

  11. To reset the template layout, click Restore.

Back to top

Customize email header and footer

You can customize the header and footer of the emails sent from ALM Octane.

To customize the email header and footer:

  1. In Settings > Spaces, select a shared space.

  2. Open the Defaults > Emails tab.
  3. To replace or remove, hover over the header.
  4. To edit the footer, click the footer.
  5. To save changes, click Save.
  6. To reset the header and footer, click Restore.

Back to top

Add a security tag

You can add a security classification tag to email subjects to ensure that ALM Octane emails are allowed by your organization's mail server.

To define the security tag, configure the mail_subject_suffix parameter. For details, see Configuration parameters.

Back to top

See also: