Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

You must have the 
Panel
bgColor#DEEBFF
#F4F5F7

All administrative functions of Herzum Approval require you to be a user with the Jira Cloud System Administrators global permission before you can carry out the instructions on this page.

Overview
Anchor
overviewEt
overviewEt

The E-Mail Templates Administration screen let you able to add, edit, delete and review your templates configurations.

info

The Approval Request tab let you able to setup the templates to apply for the e-mails notifying an approval request.

Image Removed
Image Added

Info

The Approval Reply tab let you able to setup the templates to apply for the e-mails notifying an approval reply.

Image Removed
Image Added

Default Approval Request and Approval Reply Templates
Anchor
defaultEmailTemplates
defaultEmailTemplates

When installing the app, if no customization is applied, the Approval Request and the Approval Reply emails follow the Default Templates.

Default Approval Request e-mail template

Image Removed
Image Added

Default Approval Reply e-mail template

Image Removed
Image Added

You are able to customize the Default Templates and furthermore, you can undo the customization by clicking Reset Default Template.

Image Removed

Operations

Image Added

Add email template
Anchor
addEmailTemplate
addEmailTemplate

You are able to create a new template by clicking the Add email template button.

The screen that appears allows you to setup the Project or the Conditional rule that are evaluated to use the template.

The template configurations are set by default but you are able to update them by editing the template.

Image Added

Operations
Anchor
operationsEt
operationsEt

The E-mail Templates administration screen allows you to perform the following operations on an already existing E-Mail template:

  • Edit template configuration, open the Email Template Configuration screen allowing to setup the information appearing on the email

  • Copy template, create a new template from a copy of the selected one

Edit template configuration
Anchor
editEmailConfiguration
editEmailConfiguration

You are able to update all settings applied on an existing template (including the Default E-mail Template).

Image AddedImage Added

Copy template
Anchor
copyEt
copyEt

When copying an Email Template, a new template is created that has the same configuration of the copied template but not its Project or Conditional Rule association. 

Image Removed
Image Added

Edit template main settings
Anchor
editEmailSettings
editEmailSettings

The available operations on Approval Request and Reply  E-Mail templates include the capability to update the Project or the Conditional rule that are evaluated to use the Custom Approval Request and Reply E-Mail templates instead to the Default templates.

Image Removed
Image Added

Delete template
Anchor
deleteEt
deleteEt

When deleting an Email Template the data on existing Mappings and existing issues are made consistent.

Image Removed

Image Added

Custom E-Mail Templates
Anchor
customEMailTemplates
customEMailTemplates

The Email Template Configuration screen allows you to setup the information appearing on the email.

This sections illustrate the available optional settings and how to setup them.

Optional settings common to all templates
Anchor
optionalSettingsEt
optionalSettingsEt

Header

Image Removed

Anchor
headerEt
headerEt

Image Added

Subject

Image Removed

Anchor
subjectEt
subjectEt

Image Added

Issue Type
Anchor
issueTypeEt
issueTypeEt

This setting allows you to enable displaying the issue type in the email body.

Image Removed
Image Added

Assignee
Anchor
assigneeEt
assigneeEt

This setting allows you to enable displaying the issue assignee in the email body.

Image Removed
Image Added

Issue Creation Date
Anchor
issueCreationDateEt
issueCreationDateEt

This setting allows you to enable displaying the issue creation date in the email body.

Image Removed
Image Added

Project
Anchor
projectEt
projectEt

This setting allows you to enable displaying the issue Project in the email body.

Image Removed
Image Added

Priority
Anchor
priorityEt
priorityEt

This setting allows you to enable displaying the issue Priority in the email body.

Image Removed
Image Added

Reporter
Anchor
reporterEt
reporterEt

This setting allows you to enable displaying the issue Reporter in the email body

Image Removed
Image Added

Workflow Transition
Anchor
workflowTransitionEt
workflowTransitionEt

This setting allows you to enable displaying the Workflow transition on approbation in the email body.

Image Removed
Image Added

Approval buttons
Anchor
approvalButtonsEt
approvalButtonsEt

You have the capability to enable Approval buttons showing on the email in order to allow the approver to reply by clicking them.

Image Removed
Image Added

When you enable Approval Buttons you are able to manage the following options by clicking on the

Configuration

Cog Icon::

  • Button Placement

  • Comment screen popped up

  • Button Links

Button Placement
Anchor
buttonPlacementEt
buttonPlacementEt

You can choose  if the Approval Buttons appear on the Bottom (Default) or on the Top of the email body.

Image Removed
Image Added

Comment screen popped up
Anchor
commentScreenEt
commentScreenEt

You can choose  if by clicking an approval button the action is processed immediately or the screen requiring the Approval Comment appears only if the Approval Comment is mandatory or in any case.

Image Removed
Image Added

Button Links
Anchor
buttonLinksEt
buttonLinksEt

You can choose where do you want that buttons links redirect the user.

Available options are:

  • Approval page (Default), the user displays a built-in Approval form that allows to insert a comment and credentials (when enabled)

  • Jira ticket, the user is redirected on the concerned Issue view screen in Jira

Image Removed
Image Added

Footer
Anchor
footerEt
footerEt

You are able to insert a text that will display on the email footer.

The email will render the Html tags.

Image Added

Differences between optional settings available per template
Anchor
differencesBetweenEt
differencesBetweenEt

Not all optional settings are available for all the template.

The following table provide an overview of the  optional settings available per template.

Option

Approval Request E-Mail Template

Approval Reply E-Mail Template

Header

(tick)

(tick)

Subject

(tick)

(tick)

Issue Type

(tick)

(tick)

Assignee

(tick)

(tick)

Issue Creation Date

(tick)

(tick)

Project

(tick)

(tick)

Priority

(tick)

(tick)

Reporter

(tick)

(tick)

Workflow Transition

(tick)

(tick)

Approval buttons

(tick)

(error)

Footer

(tick)

(tick)

Usage of the custom Approval Request and Approval Reply E-Mail Templates
Anchor
usageEt
usageEt

The Approval Request and Approval Reply E-Mail templates can be enabled

  • On the Approval Mappings

  • On Single Issue

  • Per Project

If none of the previous settings have been configured, the app uses a Default Email template.

Image Removed

 

When an Email Templates is enabled on an Approval Mappings or Single Issue, any other setting enabling other Templates is ignored (e.g Email Template per Project). 

In this section

Table of Contents
minLevel1
maxLevel7

Need support?

We would love to help.

Submit a support request