Page tree
Skip to end of metadata
Go to start of metadata

The Herzum Add Approval Summary on linked issues Post Function allows to add a Jira comment on the issues linked to an issue that collected the requested approval replies when this issue transitions in the destination status following the approbations or rejection.

The Jira comment will report the the Summary of the Approvals collected in the current issue.

Prerequisites

In order to allow the post function to work properly, ensure to enable the Approval History by navigating on 

Manage apps → Global Configuration → Approval History → Enable Approval History


Configuring Add Approval Summary on linked issues

Follow the steps below to setup the Add Approval Summary on linked issues post function on a workflow transition

  1. Choose   →  Issues → Workflows or click Create Workflow function on the v5-Advanced#Workflowfunctions administration screen
  2. Edit the concerned workflow
  3. Select the concerned workflow transition (transition on approbation or transition on rejection)
  4. Select the Post Function tab
  5. Add Post Function
  6. Check the option for the Add Approval Summary on linked issues



  7. Fill the parameters: 
    1. Super User (Required) - used to evaluate the applied criteria and to put the final approval reply into a comment in the linked issues:  

      1. Any of the specified criteria will be evaluated based on the selected user. Ensure that the selected user has appropriate browsing permission on the projects to whom the current and related issues belong to.

      2. The Jira Comment will be added via the selected user credentials. 
    2. Issue Link types (Required): the Jira Comment will be added on the Issues linked to the current Issue and matching the selected Outward Descriptions.

    3. Customize the text of the approval log (Optional):  Here you can customize the Approval Summary (see How to Customize the text of the approval log). If this field is not filled, the default option is applied. The default Approval Summary Comment appears as follows:

    4. JQL filter for linked issues (Optional): the post function will be executed only on the issues that satisfy the JQL filter

    5. JQL filter for current issue: (Optional): the post function will be executed only on the issues that satisfy the JQL filter

    6. Add Summary on current issue (Optional): When True, Approval Summary will be added to Jira Comments of the current issue.

(warning) In order to allow the post function to work properly, remember to keep it on the top (prior to Set issue status to the linked status of the destination workflow step).

(info) You can Add the Post-function on any transition.

(info) The Approval Summary is filled with last approval decision for each mapping applied on the issue identified by its Source status and transition on approbation.

How to Customize the text of the approval log

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

Select a Locale to translate the logged Actions (Approved, Rejected, Abstained, Reset) based on the Language pack translations associated with 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
  • Bodyinsert 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 curly brackets { }
    2. add any admissible issue field inside the squared brackets [ ]. Admissible fields are:"Approval Name", "Action", "Source Status", "Transition", "Approver", "Date", "Comment", "Destination Status", "Can Approve Detail", "MandatoryOptional"

    3. concatenate each element via &

Example - {• Source Status: } &[Source Status]& {\\ } &{• Transition Name: }&[Transition]& {\\ } &{• "}&[Approval Name] &{" }&{:  } &[Action]&{ by }&[Approver]&{ on }&[Date] & {\\ } 

(info) You can have multiple conditional tags concatenated by '&'

Example -

{• 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)
  • the Comment exists or it doesn't.; If the Approval Comment was provided on performing an Approval Action, the condition <if Comment>..</ifComment> returns true.

The following screenshots illustrates the result of a Run Test by example.

Example 1

Example 2


How it works

Assuming to have the following Scenario

  • Approval History for an issue

  • Post Function 'Add Approval Summary on linked Issues' Configuration


  • Language pack configuration


When the post function runs, any linked Issue that belongs to project=PostFunction, in addition to the current issue that meets the condition project=PostFunction, will get the following Jira comment:

In this section

Need support?

We would love to help.

This page contains macros or features from a plugin which requires a valid license.

You will need to contact your administrator.

Submit a support request