User Guide

Below table contains JQL functions for searching linked issues:

NameArgumentsDescription
linkFinder

query or filter, association (optional)

The function returns issues that meet the criteria defined in the query or filter and have a linked issue corresponding to the type of association. The first argument must be a valid JQL query or a defined filter name. Second argument is association defined in Jira. More information about associations in Jira you can find here. You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira. Please also note that this function will return these issues which have exactly this association, eg. if you give "blocks" as argument, function will return issues which block other ones.


Examples:


Returns all issues which are blocked by other:

issue in linkFinder("project = CRM", "is blocked by")


linkFinderForIssuesquery or filter, association, issue_1, issue_2, ...

The function returns list of issues which are in association with issues given as list. The first argument must be a valid JQL query or a defined filter name. Second argument is association defined in Jira or * (asterisk). More information about associations in Jira you can find here. You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira. Third (or next) argument is issue which fulfill association condition, eg. if your association is "is blocked by" and issue is "IS-3" then result will be issues which are blocked by IS-3 issue. If you provide more than one issue as this argument, result will be logical OR operation.


Examples:


Example below returns issues from project CRM which are linked (no matter how) with issue CRM-8

issue in linkFinderForIssues("project = CRM", "*", "CRM-8")


Example below returns issues from project CRM which blocks issues CRM-8 and CRM-6:

issue in linkFinderForIssues("project = CRM", "blocks", "CRM-8", "CRM-6")


linkFinderByConditionquery or filter, condition

The function that searches all linked issues. The first argument must be a valid JQL query or a defined filter name. Second argument is simple condition. This condition takes as first argument association defined in Jira. Next part is operation <,>,=,<=,=>, and the last one is number, eg. "is depended by < 3". This example condition returns all associations which number is lower than 3. More information about associations in Jira you can find here. You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira. Please also note that this function will return these issues which have exactly this association, eg. if you give "blocks" as argument, function will return issues which block other ones.


Examples:


Below is example which returns issues which are in project CRM, have status Done and are blocked by more than one issue:

issue in linkFinderByCondition("project = CRM and status = Done", "is blocked by >= 1")


linkFinderForEmptyLinksquery or filter

The function takes one argument query or filter and returns issues without associations (links).The first argument must be a valid JQL query or a defined filter name.


Examples:


Returns issues without linked issues in project CRM:

issue in linkFinderForEmptyLinks("project = CRM")


linkFinderForAllStatuses query or filter, association, status_1, status_2, ...

The function searches for issues that have linked issues in the given status or statuses. This function takes as arguments query or filter, association or * (asterisk) and list of statuses. The first argument must be a valid JQL query or a defined filter name. More information about associations in Jira you can find here. Second argument is association defined in Jira or * (asterisk). You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira.


Examples:


Example below returns all issues which link issues has status To do - association doesn't matter:

issue in linkFinderForAllStatuses("project = CRM", "*", "to do")


Example below returns all issues which blocks other issues which have status To do and In progress:

issue in linkFinderForAllStatuses("project = CRM and status = Done", "blocks", "to do", "in progress")


linkFinderForAnyStatuses query or filter, association, status_1, status_2, ...

The function searches for issues that have linked issues in the given status or statuses. This function takes as arguments query or filter, association or * (asterisk) and list of statuses. The first argument must be a valid JQL query or a defined filter name. More information about associations in Jira you can find here. Second argument is association defined in Jira or * (asterisk). You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira. This function is similar to linkFinderForAllStatuses but has one important difference related to the interpretation of statuses. In this function linked issues doesn't have to be exactly in given statuses.


Examples:


Example below returns all issues which have linked issues with status To do or In progress (important in here is word or):

issue in linkFinderForAnyStatuses("project = CRM", "blocks", "to do", "in progress") 


linkFinderForLinkTypesquery or filter, association_1, association_2, ...

The function searches for linked issues that have one or more association. This function takes as arguments query or filter and association or list of associations. The first argument must be a valid JQL query or a defined filter name. More information about associations in Jira you can find here. Second argument is association defined in Jira or list of associations. You can use association as name, outward or inward description. This argument must accurately comply with this defined in Jira.

Examples:

Example below returns list of issues from CRM project which have at least one linked issue with "blocks" association.

issue in linkFinderForLinkTypes("project = CRM", "blocks")


Example below returns list of issues from CRM project which have at least one linked issue with "blocks" or "is related to" association.

issue in linkFinderForLinkTypes("project = CRM", "blocks", "is related to")


Please take a look here at more examples of using JQL functions.

Below table contains functions that search issues with web and remote links:

NameArgumentsDescription
linkFinderRemoteLinksquery or filter, association (optional)

The function that searches all issues having web and remote links. First argument must be correct JQL query or defined filter. Second argument is association defined in Jira. More information about associations in Jira you can find here. You can use association as outward or inward description. This argument must accurately comply with this defined in Jira. In case of web links, this association is only one and its name is "links to".In case of remote links, this association can have different names and definition of these names is described earlier.


Examples:


Example below returns all issues which are in project CRM and have remote links in association - relates to:

issue in linkFinderRemoteLinks("project = CRM", "relates to")


Example below returns all issues which are in project CRM and have links to Confluence:

issue in linkFinderRemoteLinks("project = CRM", "mentioned in")


linkFinderRemoteAppquery or filter, application name

The function that searches all issues having remote links with given application name. First argument must be correct JQL query or defined filter. Second argument is application name that is defined by the user during creation of this remote link. Please also note that this application name has to be exactly the same, however it ignores case.


Example:


Returns issues which are in project CRM and have links to application TFS:

issue in linkFinderRemoteApp("project = CRM", "TFS")


linkFinderRemoteTitlequery or filter, title

The Function that searches all issues having web and remote links with given title. First argument must be correct JQL query or defined filter. Second argument is title and it must contain word given as a title argument.


Example:


Returns issues which are in project CRM and have in title text: TEST-1:

issue in linkFinderRemoteApp("project = CRM", "TEST-1")


linkFinderRemoteSummaryquery or filter, summary

Function that searches all issues having remote links which summary contains given text. First argument must be correct JQL query or defined filter. Second argument is summary and it must contain word given as a summary argument.


Example:


Returns issues which are in project CRM and have in summary text: Create window:

issue in linkFinderRemoteSummary("project = CRM", "Create window")


linkFinderRemoteUrlquery or filter, URL

Function that searches all issues having web and remote links which URL contains given text. First argument must be correct JQL query or defined filter. Second argument is URL and it must contain word given as a URL argument.


Example:


Example below returns issues in project CRM and have text URL: limetrees:

issue in linkFinderRemoteUrl("project = CRM", "limetrees")

Please take a look here at more examples of using JQL remote links functions.

Below table contains functions that search epics:

NameArgumentsDescription
linkFinderEpicquery 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 linkFinderEpic("project = CRM and status = \'TO DO\'") 


Returns epics for the CRM project:

issue in linkFinderEpic("project = CRM")


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

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

linkFinderEpicsForIssuesquery 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 linkFinderEpicsForIssues("project = CRM and status = \'TO DO\'") 


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

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

linkFinderIssuesForEpicKeyepic 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 linkFinderIssuesForEpicKey("AS-24")


linkFinderSubtasksForEpicKeyepic 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 linkFinderSubtasksForEpicKey("AS-24")


linkFinderSubtasksForEpicsquery 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 linkFinderSubtasksForEpics("project = CRM and priority = High and assignee is EMPTY") and type = Sub-task and assignee = currentUser()


linkFinderIssuesForEpicsquery 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 linkFinderIssuesForEpics("project = CRM AND labels = Production")


Please take a look here at more examples of using JQL epic functions.

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.

If you want to use in query names that have two parts, eg. "Project Tango", you must use \' at the beginning and the same at the end of the name. Eg. "project = \'Project Tango\'".

Known limitations

Please note that functions return epics that have assigned issues. Epics that have no assigned issues are not supported in this release.

Define remote links

It is specific functionality of this app that broaden standard functionality of Jira adding to link additional information - please take a look at below picture:

This issue is association between Jira issue and remote link. This association is described here.

In case you want to use remote link to file, please read this article.