Approval Logs via Comments

Overview

The Approval Logs via Comments section on the Global Configuration screen allows you to enable the capability from the app to:

• log a JIRA Comment that informs about an Approbation and Rejection, and customize the Approval log text
• dispatch any of the 'Add comment' events performed by the app
• notify Approval Requests by Jira comments and the capability to process approval responses by comment

Logging Approval Events

The Logging Approval Events option allows you to disable the capability to log approval events via Jira comments.

This option expects the values ON or OFF. By default this option is ON.

When Logging Approval Events is ON, any time that an approval changes status, a new comment is appended to the issue comments.

Dispatch 'Issue Commented' Event

When the Logging Approval Events option is ON, any time that an approval changes status, a new comment is appended to the issue comments.

Furthermore, if the Herzum Approval post functions Add Approval Summary or Add Approval Summary On Linked Issues are added to the workflow transition performed on approbation or on rejection, when the workflow transition runs, the app appends a comment on the Linked Issues or on the current Issue that reports the Summary of the Approvals collected in the current issue.

By default, this action performed by the app does not dispatch the 'Issue Commented' Event.

You can enable dispatching the event for each of the following distinct events: Approval Responses Summary logged via Jira Comment on linked Issues, Approval Responses Summary logged via Jira Comment on current Issue and Approval Response logged via Jira Comment.

Approval Log Text

When the Logging Approval Events option is ON, any time that an approval changes status, a new comment is appended to the issue comments.

By default, the text of the comment reports the following information: Current Issue Workflow Status, Workflow transition on complete approbation, Name of the Approval having changed its status, approval response, user having taken the approval decision, date and time this decision was taken.

You are able to Customize the text of the approval log as described below.

Select a Locale in order to translate the logged Actions (Approved, Rejected, Abstained, Reset, basing on the Language pack translations associated to the selected Locale.

Select the option Custom in order to set up 

• Header: insert a Wiki text on the top of the page 
• Footer: insert a Wiki text on the bottom of the page
• Body: insert a text that follows the convention described below:

1.  Add a Conditional Tag (Optional), in order to evaluate the expression only if a specific condition (e.g. 

   <tag>expression</tag>) is meet. Allowed Tags are: 

   1. TAG_IF_COMMENT = "ifComment";

   2. TAG_IF_COMMENT_IS_FALSE = "ifComment isFalse";

   3. TAG_IF_APPROVED = "ifApproved";

   4. AG_IF_APPROVED_IS_FALSE = "ifApproved isFalse";

   5. TAG_IF_REJECTED = "ifRejected";

   6. TAG_IF_REJECTED_IS_FALSE = "ifRejected isFalse";

   7. AG_IF_ABSTAINED = "ifAbstained";

   8. TAG_IF_ABSTAINED_IS_FALSE = "ifAbstained isFalse";

   9. AG_IF_PENDING = "ifPending";

   10. TAG_IF_PENDING_IS_FALSE = "ifPending isFalse";

2. specify the expression by following the convention below:

   1. add a text into the { } brackets

   2. add any admissible issue field inside the [ ] brackets. Admissible fields are: "Approval Name", "Action", "Source Status", "Transition", "Approver", "Date", "Comment", "Destination Status", "Can Approve Detail", "MandatoryOptional"

   3. concatenate each element via the &

E.g. {• Source Status: } &[Source Status]& {\\ } &{• Transition Name: }&[Transition]& {\\ } &{• "}&[Approval Name] &{" }&{:  } &[Action]&{ by }&[Approver]&{ on }&[Date] & {\\ } 

 You can have multiple conditional tags concatenated by '&'

E.g. 

{• Status: } &[Source Status] & {\\ } &{• Transition: }&[Transition]& {\\ }
&<ifComment>{• Approver Comment: } &[Comment]</ifComment>
&<ifComment isFalse>{• The Approver has not inserted any comment}</ifComment isFalse>&{\\}
&{• "} &[Approval Name] &{" }&{: }&[Action]&{ by }&[Approver]&{ il }&[Date] & {\\ }

Run Test

You are able to Review how the Custom Approval log will appear depending by:

• Action performed by the Approver (Approved, Rejected, etc)
• Whether the Comment exists or not. If the Approval Comment was provided on performing an Approval Action, the condition <if Comment>..</ifComment> returns true.

Example

Assuming to need the following custom approval log:

Wiky rendering

Text rendering

The custom Approval Log Text can be set as follows:

Approval Requests and Replies by Comment

The Approval Requests and Replies by Comment option allows you to enable the approval notification and the approbation and rejection via JIRA comments.

This option expects the values ON or OFF. By default this option is Disabled (Approval Requests and Replies by Comment is OFF).

When the Approval Requests and Replies by Comment is enabled, it is required to specify the user that will be used to append the comment that notify the approval request.

 The selected user must be valid with respect to the Projects permissions that allow to add comment to an issue.