User Guide

Information on this page are valid for the newest version of this app.



Below table contains Epic Finder JQL functions:

NameArgumentsDescription

efEpics

(epicFinder)

query or filter

The function returns epics which satisfy the condition given as query or filter. The argument must be a valid JQL query or a defined filter name.


Examples:


Returns epics for the CRM project and that have the status To do: 

issue in efEpics("project = CRM and status = \'TO DO\'") 


Returns epics for the CRM project:

issue in efEpics("project = CRM")


Returns epics for the CRM project and are assigned to the user Admin:

issue in efEpics("project = CRM and assignee = admin") 


efEpicsIssues

(epicFinderEpicsForIssues)

query or filter

The function returns epics which issues satisfy the condition given as query or filter. The argument must be a valid JQL query or a defined filter name.


Examples:


Returns epics for issues in project CRM and status To do:

issue in efEpicsIssues("project = CRM and status = \'TO DO\'") 


Returns epics for issues in project CRM and are assigned to the user Admin:

issue in efEpicsIssues("project = CRM and assignee = admin") 


efIssuesEpic

(epicFinderIssuesForEpicKey)

epic key

The function returns the issues (user stories/issues) for the specified epic. The argument must be valid epic key.


Example:


Returns all the issues for epic key AS-24: 

issue in efIssuesEpic("AS-24")


efSubtasksEpic

(epicFinderSubtasksForEpicKey)

epic key

The function to find all issues and subtasks that has epic. The argument must be valid epic key.


Example:


Returns all issues and their corresponding subtasks for epic key AS-24:

issue in efSubtasksEpic("AS-24")


efEmptyEpicsquery or filter

The function to find empty epics that meet the query or filter criteria. The argument must be a valid JQL query or a defined filter name.


Example:


Returns empty epics for project Audit software and assignee is Unassigned:

issue in efEmptyEpics("project = \'Audit software\' AND assignee is EMPTY")

efEpicsAllIssuesInStatusquery or filter, status

The function returns epics that meet the criteria defined in the query or filter and that all their issues have given status. The first argument must be a valid JQL query or a defined filter name.

The second argument must be valid Jira status.


Example:


Returns epics which issues have a status Done:

issue in efEpicsAllIssuesInStatus("project = \'Audit software\'", "done")


efEpicsIssuesInStatusConditionquery of fitler, condition

The function to find all epics for issues in status that meets the condition. The first argument must be a valid JQL query or a defined filter name. 

The second argument must be valid condition. The condition has syntax: [status][=,<, <=,>=, >][number].


Example:


Below is example which returns epics for more than 3 issues with status Done:

issue in efEpicsIssuesInStatusCondition("project = \'Audit software\'", "done > 3")


efEmptyStoriesquery or filter

The function to find empty user stories (without issues) that meet the query or filter criteria. The argument must be a valid JQL query or a defined filter name.


Example:


Returns empty stories for project Audit software and status To do:

issue in efEmptyStories("project = \'Audit software\' and status = \"TO DO\"")


efStoriesAllIssuesStatusquery or filter, status

The function returns user stories that meet the criteria defined in the query or filter and that all their issues have given status. The first argument must be a valid JQL query or a defined filter name.

The second argument must be valid Jira status.


Example:


Returns all user stories for project Audit software and status Done:

issue in efStoriesAllIssuesStatus("project = \'Audit software\'", "Done")


efStoriesIssuesInStatusConditionquery of fitler, condition

The function to find all user stories for issues in status that meets the condition. The first argument must be a valid JQL query or a defined filter name. 

The second argument must be valid condition. The condition has syntax: [status][=,<, <=,>=, >][number].


Example:


Below is example which returns user stories for more than 2 issues (subtasks) with status In progress:

issue in efStoriesIssuesInStatusCondition("project = \'Audit software\'", "in progress > 1")


efStoriesEpicepic key

The function to find all user stories for the given epic. The parameter must be valid epic key.


Example:


Example below shows how to get user stories for epic CRM-7:

issue in efStoriesEpic("CRM-7")


efIssuesStoriesEpicepic key

The function to find all issues in the user stories for the given epic (only subtasks in user stories). The argument must be valid epic key.


Example:


Returns all issues (subtasks) from user stories from epic AS-22:

issue in efIssuesStoriesEpic("AS-22")


efStoriesquery or filter

The function returns the user stories which satisfy the condition given as query or filter. The argument must be a valid JQL query or a defined filter name.


Example:


Returns all user stories which have a status Done:

issue in efStories("status = Done")


efIssuesStoriesquery or filter

The function returns the issues for the user stories that meet the query or filter criteria. The argument must be a valid JQL query or a defined filter name.


Example:


Returns all issues which user stories are in project Audit software and they have status Done:

issue in efIssuesStories("project = \'Audit software\' AND status = Done")


efStoriesIssuesquery or filter

The function returns the user stories for the issues that meet the query or filter criteria. The argument must be a valid JQL query or a defined filter name.


Example:


Returns all user stories for issues in project Audit software and fix version is latestReleasedVersion:

issue in efStoriesIssues("project = \'Audit software\' and fixVersion = latestReleasedVersion()")


efStoriesIssuesAssigneeassignee

The function returns the user stories wher issues are assigned to the specified user. If argument is empty then function returns user stories which have unassigned issues.


Example:

Returns user stories for all issues (subtasks) assigned to user Potty:

issue in efStoriesIssuesAssignee("Potty")


efEpicsIssuesAssigneeassignee

The function returns the epics where issues are assigned to the specified user. If argument is empty then function returns epics which have unassigned issues.


Example:


Returns epics for all sub-tasks (without user stories) assigned to user Potty:

issue in efEpicsIssuesAssignee("Potty")


efEpicsSprintsprint name or sprint id

The function returns the epics which issues are implemented in the specified sprint. The argument must be valid sprint name or sprint id.


Example:


Returns all epics which have issues in CRM sprint 2:

issue in efEpicsSprint("CRM Sprint 2")



efIssuesEpicsquery or filter

The function returns the list of issues  (user stories/issues) which epics meet the condition given as a query or filter. The argument must be a valid JQL query or a defined filter name.


Example:

In below example we want to find all issues (user stories/issues) for epics in project CRM which are labeled as Production:

issue in efIssuesEpics("project = CRM AND labels = Production")


efSubtasksForEpicsquery or filter

The function return the list of issues and subtasks which epics meet the condition given as query or filter. The argument must be a valid JQL query or a defined filter name.


Example:


Returns subtasks for current user which are assigned to epics in project CRM with High priority without assignee

issue in efSubtasksForEpics("project = CRM and priority = High and assignee is EMPTY") and type = Sub-task and assignee = currentUser()


You can find more information and examples in the Epic Finder Ultimate Guide

Please note that in case you create condition that will return big amounts of data, queries may need more time to perform. In these situations, the best solution is to narrow results using more detailed query or filter condtition.