Versions Compared

Version Old Version 5 New Version Current
Changes made by

Paula Mantilla

Paula Mantilla

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
bgColor#F4F5F7

This page provides information about Approval JQL Functions.

Select an Approval JQL Function from the Approval Menu in Herzum Approval Tab

Info

Need support?

We would love to help.

✉ Submit a support request

The Herzum Approval Tab empowers users to efficiently search for issues based on pending and replied approvals.

Access and Configuration:

  • Users can access the Herzum Approval Tab through the apps menu.

  • Administrators can configure access to this feature within the Permissions settings of the Herzum Approval configuration.

image-20240404-154637.png

Search Functionality:

  • The tab includes various filters to refine your search results and enhance efficiency.

617cb203-d7c0-4a77-a304-2b574ba8a9c3.pngImage Added

  • For advanced searches, utilize the "Advanced JQL" button to create custom JQL queries.

122c813e-85ef-4652-bc82-2fe1ab69ffcd.pngImage Added

For all Herzum Approval JQL functions, issues are loaded in blocks of 50 until all issues are displayed on the screen. Once all issues are fully loaded, the following message appears above the results table: "100% of the issues have been loaded."

image-20241120-162232.png

The loading time will depend
Note

Please note that search loading times may vary depending on the amount of data

in your instance. It is recommended to use the filters to simplify your search.

image-20241120-162323.pngImage Removed

In this section

returned. Using filters can significantly improve performance.

Here's a list of the available search functions within the Herzum Approval Tab:

Table of Contents
minLevel1
maxLevel6
outlinefalse
styledefault
typelist
printablefalse

pendingForApproval() 

This function returns issues having at least one approval request in 'Pending' status.

This function can take from 0 to 2 arguments:

  • first parameter expects the Project key or “All”

Examples:  PendingForApproval('All'), issue in PendingForApproval('Pkey')

  • second parameter expects true or false; this parameter, when true, enables an alternative filter method on the conditional rules that may be used to improve performance for some scenarios

Example:  pendingForApproval('All','true')

Admissible operators include IN and NOT IN.

If you do not specify any argument, the function returns all issues having at least one approval request in 'Pending' status.

Code Block
issue in pendingForApproval()

pendingForApprovalName() 

This function returns all issues having at least one approval request in 'Pending' status for the specific 'approval name'. 

This function expects the argument approval name.

Code Block
issue in pendingForApprovalName(<approvalname>)

Admissible operators include IN and NOT IN.

image-20240404-170405.pngimage-20240404-170616.png

pendingForUserApproval() 

This function returns all issues having at least one approval request in 'Pending' status for the specific user. 

This function expects the argument username.

Code Block
issue in pendingForUserApproval(<username>)

Admissible operators include IN and NOT IN.

image-20240404-162116.pngimage-20240404-162947.png

pendingUserApprovalName

This function returns all issues having at least one approval request in 'Pending' status for the specific User Name and Approval Name. 

This function expects the argument a User Name and Approval Name.

Code Block
issue in pendingUserApprovalName(<username><approvalname>)

Admissible operators include IN and NOT IN.

image-20240404-171511.png

image-20240404-172051.png

pendingNotifiedApproval() 

This function returns all issues having at least one notified approval request in 'Pending' status.

This function doesn't take any arguments.

Code Block
issue in PendingNotifiedApproval()

Admissible operators include IN and NOT IN.

image-20240404-173340.png

image-20240404-173649.png

pendingForUserNotifiedApproval()

This function all issues having at least one notified approval request in 'Pending' status for the specific user.

This function expects the argument username. 

Code Block
issue in PendingForUserNotifiedApproval(<username>)

image-20240404-181313.pngimage-20240404-221634.png

myPendingApproval() 

This function returns issues having at least one approval request waiting for logged user approval action.

This function can take from 0 to 2 arguments:

  • first parameter expects the Project key or All

Examples:  myPendingApproval('All'), issue in myPendingApproval('Pkey')

  • second parameter expects true or false; this parameter, when true, enables an alternative filter method on the conditional rules that may be used to improve performance for some scenarios

Example:  myPendingApproval('All','true')

Admissible operators include IN and NOT IN.

Code Block
issue in myPendingApproval()

myPendingNotifiedApproval() 

This function returns all the issues having at least one notified approval request waiting for logged user approval action.

This function doesn't take any arguments.

Code Block
issue in myPendingNotifiedApproval()

Admissible operators include IN and NOT IN.

Correct misspelled word, change in all matches and redeploy

image-20240404-215210.pngimage-20240404-221000.png

myPendingNoComment()

This function returns all the issues having at least one pending approval for logged user that doesn't require an approbation comment.

This function doesn't take any arguments.

Code Block
issue in myPendingNoComment()

Admissible operators include IN and NOT IN.

pendingForGroupApproval()

The function returns all issues having at least one approval request in 'Pending' status for the specified Group.

This function expects the argument Group.

Code Block
issue in pendingForGroupApproval("<Group>")

Admissible operators include IN and NOT IN.

pendingForGroupNotifiedApproval()

The function returns all issues having at least one notified approval request in 'Pending' status for the specified Group.

This function expects the argument Group.

Code Block
issue in pendingForGroupNotifiedApproval("<Group>")

The search for issue in pendingForGroupNotifiedApproval("") returns all issues having at least one notified approval request in 'Pending' status for every Group.

Admissible operators include IN and NOT IN.

image-20240404-222447.png

image-20240404-222722.png

rejectedForApprovalStatus()

This function returns all issues having at least one approval request in 'Rejected' status.

This function doesn't take any arguments. 

Code Block
issue in rejectedForApprovalStatus()

Admissible operators include IN and NOT IN.

image-20240404-223605.pngimage-20240404-224029.png

myRejectedApproval()

This function returns all issues having at least one approval request that has been 'Rejected' by the logged user.

This function doesn't take any arguments. 

Code Block
issue in myRejectedApproval()

Admissible operators include IN and NOT IN.

image-20240404-224837.pngimage-20240404-225015.png

approvedForApprovalStatus()

This function returns all issues having all approval requests in 'Approved' status.

This function doesn't take any arguments. 

Code Block
issue in approvedForApprovalStatus()

Admissible operators include IN and NOT IN.

approvedOrAbstainedStatus() 

This function returns all issues having all approval requests in 'Approved' or 'Abstained' statuses.

This function doesn't take any arguments.

Code Block
issue in approvedOrAbstainedStatus()

Admissible operators include IN and NOT IN.

image-20240404-225434.png

image-20240404-225416.png

 

myApprovedApproval() 

This function returns all issues, found in the Approval Source Status, having at least one approval request that has been 'Approved' by the logged user.

This function doesn't take any arguments. 

Code Block
issue in myApprovedApproval()

Admissible operators include IN and NOT IN.

image-20240404-230216.pngimage-20240404-230327.png

 

myApprovedOrAbstainedStaus()

This function returns all issues having at least one approval request that has been 'Approved' or 'Abstained' by the logged user.

This function doesn't take any arguments.

Code Block
issue in myApprovedOrAbstainedStaus()

Admissible operators include IN and NOT IN.

image-20240405-212330.png

image-20240405-212715.png

myPendingForDelegatedApproval()

This function returns all issues pending for my approval due to I'm a delegated approver.

This function doesn't take any arguments. 

Code Block
issue in myPendingForDelegatedApproval()

Admissible operators include IN and NOT IN.

image-20240405-214706.png

image-20240405-215448.png

myPendingForDelegatedNoComment()

This function returns all issues pending for logged user approval due to a delegation that doesn't require an approbation comment.

This function doesn't take any arguments. 

Code Block
issue in MyPendingForDelegatedNoComment()

Admissible operators include IN and NOT IN.

image-20240405-215946.png

image-20240405-220221.png

pendingForDelegatedNoComment()

This function returns all issues pending approval due to a delegation that doesn't require an approbation comment.

This function doesn't take any arguments. 

Code Block
issue in PendingForDelegatedNoComment()

Admissible operators include IN and NOT IN.

pendingForDelegatedApproval()

This function returns issues pending for approval due to a delegation from a specific delegator for a specific project and issue type in a given time range.

This function takes the listed arguments: delegator username (mandatory), Project Id (optional), IssueType Id (optional), Start Date (optional), End Date (optional). 

Code Block
issue in pendingForDelegatedApproval('delegator username',10004,'10006','','')

Admissible operators include IN and NOT IN.

noApprovalsReceived()

This function returns all issues pending for approval that have no yet received any approbation.

This function doesn't take any arguments. 

Code Block
issue in noApprovalsReceived()

Admissible operators include IN and NOT IN.

image-20240405-220546.png

image-20240405-220818.png

partiallyApproved()

This function returns all issues pending approval having already at least catched one approbation.

This function doesn't take any arguments. 

Code Block
issue in partiallyApproved()

Admissible operators include IN and NOT IN.

image-20240405-221252.pngimage-20240405-222245.png