Table of Contents |
---|
Plugin overview
The Herzum Approval add-on is a powerful JIRA add-on that provides a simple and flexible way of managing and processing the approval of JIRA issues.
...
- an User friendly approval configuration panel
- an intuitive and easy way to see issue's approval status
- useful JQL functions to filter pending for approval, approved or rejected issues
- approval request notification
- approval request replying via the issue screen or via email.
Display the approvals status for each transition (progress bar)
From an issue it is possible view all required approvals for each transition and their approval state.
...
When the bar is entirely green the associated transition is enabled, as showed on the following screen shot.
Approvals detail
The fields displayed on the Approvals Detail tab are:
...
- Red: the approval request has been rejected.
- Yellow: the approval request is pending
- Green: the approval request has been approved.
How to approve, reject or cancel an approval request
The authorized user can manage an approval request two way:
- by clicking on the 'Action' buttons available on the Approval section of the issue screen
- by replying to the email notifying the approval request
How to manage the approval via the issue screen
When the user wants to manage the approval, he can add a comment in the text area, before clicking on the button; the comment and the action description will be added to the Comments section.
...
- When the approval request is in Approved status, the user can reject or reset so to return in Pending status.
- When the approval request is in Rejected status, the user can approve or reset so to return in Pending status.
- When approval is in Pending status, user can approve or reject.
How to manage the approval via email
If you want, you can setup approvals by email just defining the "Approval Mail Handler" for the related mail queue.
...
The issue Assignee and the User clicking on the action button are notified for each action made via email.
JQL functions
An user can search the tickets into the issue navigator based on their approval status.
- issue in pendingForApproval()
- issue in approvedForApprovalStatus()
- issue in rejectedForApprovalStatus()
How to use JQL functions
1 | From the JIRA header, click Issues -> Search for Issues | Search for Issues tab |
2 | Click Advanced to switch the form to advance search mode using JQL. | Search screen |
3 | Enter an Approval JQL function | Search screen |
4 | Click the search icon to run the search. The list of issues appears. | JIRA search screen list view |
The JQL functions have the behavior described below.
The issue in pendingForApproval() JQL function returns all issues having at least one approval requests in 'Pending' status. | JIRA search screen detail view |
The issue in rejectedForApprovalStatus() JQL function retuns all issues having at least one approval requests in 'Rejected' status. | JIRA search screen detail view |
The issue in approvedForApprovalStatus() returns all issues having all approval requests in 'Approved' status | JIRA search screen detail view |
Notifications
The Herzum Approval add-on manages the following notifications via email:
- to the Assignee and to User having clicked an action button: when an user click on one of the action buttons (Approve, Reject, Cancel)
- to all the Approvers: when the user click on the button allowing the "Request for Approval".
When the user click on the notification button, a message confirms that the approvers have been notified with an email.