JQLT Usage

Usage

JQL Tricks plugin is a plugin which has a set of useful JQL Functions. Those include simple functions to complex ones and are explained in detail below.

The functions are grouped into different sets for ease of understanding. Click on the link icons to navigate into specific pages with detailed examples!

Issue Functions ( 🔗 )

These functions return JIRA ISSUE objects and hence should be used in JQL in the following format.

issue in functionName([parameters])

Following are the various issue functions supported by JQL Tricks plugin.

v 1.0

hasAttachments() - To find issues based on the number of attachments
hasSameValues() - T0 find issues that has same values for the argument mentioned

Added in v 2.0

commentedByUser() - To find issues on which a specific user has commented
commentedOnDate() - To find issues on which a comment was added on a specified Date
attachedByUser() - To find issues on which a specific user has attached files

Added in v 2.2

componentsFromProject() - To find issues in all components with the same name as that of components in a given project.

Added in 3.1

commentedAfterDate() - To find issues on which a comment was added after specified Date

Added in 4.0

movedIssues() - To find all issues on which were moved from one project to another, atleast once

Added in 4.1

hasSameversions() - To find issues that has exact same fixVersion and affectedVersion fields
hasVersions() - To find issues with the exact number of affected versions or fix versions
hasComponents() - To find issues with the exact number of components

Added in 7.0

commentedBeforeDate() - To find issues on which a comment was added before specified Date

Subtask Functions ( 🔗 )

Subtasks are JIRA issues, although in a different level. Hence these functions also return JIRA Issue objects and should be used in JQL similar to Issue functions.

issue in functionName([parameters])

Following are the various subtask functions supported by JQL Tricks plugin.

Added in v 2.0

parent() - To find subtask issues based on parent values
subtask() - To find parent issues based on subtask values

Added in v 2.1

hasSubtasks() - To find issues with atleast one subtask, with an option to specify the count, subtask type or a query to limit the results.

Issue Link Functions ( 🔗 )

These are also Issue functions but grouped separately because they are all used for searching based on Issue Links. These functions also return JIRA Issue objects and should be used in JQL similar to Issue functions.

issue in functionName([parameters])

Following are the various issue link functions supported by JQL Tricks plugin.

v 1.0

linkedAllIssues() - To find all issues linked to a given issue and optionally for a link type
linkedIssuesByDepth() - Same as above but only to the depth specified
hasLinks() - To find all issues that has (or not has) links and optionally for a link type
linkedIssuesInProject() - To find all issues that has got linked issues in the specified project
inkedIssuesInVersion() - To find all issues that has got linked issues in the specified Version
linkedIssuesInComponent() - To find all issues that has got linked issues in the specified component
linkedIssuesHasStatus () - To find all issues that has got linked issues in the specified status

Added in v 2.1

linkedIssuesInVersionByName() - To find all issues that has got linked issues in the specified Version(s) using its name.
linkedIssuesInComponentByName() - To find all issues that has got linked issues in the specified component using project and component name.

Added in v 3.1

linkedIssuesInQuery() - To find all issues linked to issues satisfying the given JQL query
linkedIssuesInFilter() - To find all issues linked to issues satisfying a given filter

Added in v 5.2

issuesWhereEpicIn() - To find all issues where the Epic associated to the issue satisfies the given JQL query
epicsWhereIssueIn() - To find all epics where atleast one issue associated to the epic satisfies the given JQL query

Added in v 5.3

hasRemoteLinks() - To find all issues that has (or not has) remote links and optionally for a remote link type

Added in v 7.1

epicsWithIssues() - To find all epics with at least one issue linked to it

Development Functions ( 🔗 )

These are also Issue functions but grouped separately because they are all used for searching based on development attributes. These functions also return JIRA Issue objects and should be used in JQL similar to other Issue functions.

issue in functionName([parameters])

Following are the various development functions supported by JQL Tricks plugin.

v 7.0

hasCommits() - To find issues that have commits associated with it.
hasReviews() - To find issues that have reviews associated with it.
hasOpenReviews() - To find issues that have open reviews associated with it.
hasPRs() - To find issues that have pull requests associated with it.
hasOpenPRs() - To find issues that have open pull requests associated with it.
hasFailingBuilds() - To find issues that have failing builds associated with it.

Worklog Functions ( 🔗 )

These are also Issue functions but grouped separately because they are all used for searching based on worklogs. These functions also return JIRA Issue objects and should be used in JQL similar to other Issue functions.

issue in functionName([parameters])

Following are the various worklog functions supported by JQL Tricks plugin.

v 1.0

workStartedOn() - Find out issues for which work was started on the specified date and optionally by a specific user.
workLoggedOn() - Find out issues for which work was logged on the specified date and optionally by a specific user.
workUpdatedOn() - Find out issues for which work was updated on the specified date and optionally by a specific user.
workLoggedBetween() - Find out issues for which work was logged between the specified dates and optionally by a specific user.

Added in v 3.0.2

workLoggedAfter() - Find out issues for which work was logged after the specified date and optionally by a specific user.

Added in v 7.1

workLoggedBy() - To find issues on which work was logged by a specific user or users in a given group

Project Functions ( 🔗 )

These functions return JIRA PROJECT objects and hence should be used in JQL in the following format.

project in functionName([parameters])

Following are the various project functions supported by JQL Tricks plugin.

v 1.0

recentProjects() - To find all issues in the recent Projects

Added in v 2.2

projectWithUserInRole() - To return all projects where the specified user is in a role.

Added in v 7.0

projectMatches() - To return all projects where the name matches a given regex.

Version Functions ( 🔗 )

These functions return JIRA VERSION objects and hence should be used in JQL in the following format.

fixVersion/affectedVersion/versionPickerCustomField in functionName([parameters])

Following are the various version functions supported by JQL Tricks plugin.

v 1.0

dueVersions() - To find issues in Versions that are due, i.e. versions that are not released and has a release date in the future.
overDueVersions() - To find issues in Versions that are overdue, i.e. versions that are not released but has a release date in the past.
openVersions() - To find issues in Versions that are without a release date.
currentVersionsBySeq() - To find issues in the current versions identified by their sequence
currentVersionsByDate() - To find issues in the current versions identified by their date
versionsAfterDate() - To find issues in Version that are due after specified date
releasedOn() - To find issues in Versions due on specified date

Added in v 2.0

versionsAfter() - To search based on versions following a given version
versionsBefore() - To search based on versions before a given version

Added in v 3.0.1

versionMatches() - To search versions with name matching a given regular expression

Added in v 7.0

archivedVersions() - To find issues in Versions that are archived

Component Functions ( 🔗 )

These functions return JIRA COMPONENT objects and hence should be used in JQL in the following format.

component/componentPickerCustomField in functionName([parameters])

Following are the various component functions supported by JQL Tricks plugin.

Added in v 3.0.1

componentMatches() - To search components with name matching a given regular expression

User Functions ( 🔗 )

These functions return JIRA USER objects and hence should be used in JQL in the following format.

assignee/reporter/userPickerCustomField in functionName([parameters])

Following are the various user functions supported by JQL Tricks plugin.

v 1.0

membersOfGroups() - To search based on users of specified groups
projectLeads() - To search based on leads of all Projects
projectLead() - To search based on project lead of a project
usersInRole() - To search based on users in a specific role in a specific project

Added in v 2.0

userMatches() - To search based on users matching to a regular expression

Added in v 4.0

inactiveUsers() - To find issues based on inactive users
usersInTimezone() - To find issues based on users in specific timezone

Added in v 7.1

componentLeads() - To search based on leads of all components or components in a given project or based on the lead of a given component ID

Group Functions ( 🔗 )

These functions return JIRA GROUP objects and hence should be used in JQL in the following format.

groupPickerCustomField in functionName([parameters])

Following are the various user functions supported by JQL Tricks plugin.

v 1.0

groupsOfUser() - To search based on groups of a specific user

Added in v 2.0

groupMatches() - To search based on groups matching to a regular expression

Date Functions ( 🔗 )

These functions return JIRA DATE objects and hence should be used in JQL along with date fields.

Following are the various date functions supported by JQL Tricks plugin.

Added in v4.1

lastLoginOf() - To compare dates with last login time of a specific user

Added in v 7.1

sprintStartDateOf() - To search based on start date of a given sprint
sprintEndDateOf() - To search based on end date of a given sprint
versionStartDateOf() - To search based on start date of a given version
versionEndDateOf() - To search based on start date of a given version

FAQ