/
Enhanced JQL

Enhanced JQL

Owned by Anna Ciepłota
Last updated: Sept 30, 2024 by Agnieszka Sienkiewicz
3 min read

Contents:

Contents:

About the enahnced JQL

Enhanced JQL is available only on Jira data center.

JQL (Jira Query Language) allows you to search for specific issues in Jira. With JQL, you can create complex queries to filter and retrieve issues based on various criteria, such as status, assignee, project, and more.

BigPicture's enhanced JQL builds on Jira query language. It lets you run a Jira search based on data stored exclusively in BigPicture. There are five fields you can use to create BigPicture-specific functions: issue, key, fixVersion, affectedVersion, and component.

For example, the box ID is a native BigPicture element you can use as a function argument to run a search across the entire box:

  • issue in box(BOX-ID)

  • key in box(BOX-ID)

  • fixVersion in box(BOX-ID)

  • affectedVersion in box(BOX-ID)

  • component in box(BOX-ID)

How to filter issues using the enhanced JQL

  1. Go to Issues > Search issues.

  2. If you are in a Basic search, switch to the Advanced search.

accessong advanced jira issues search page.

  1. Type in your query.

When you add your query, the app will suggest wrapping the function argument in quotation marks within the brackets (the argument in this example is the box ID). However, the enahnced JQL syntax allows you to enter the argument without quotation marks.

enhanced-jql-suggestions.png

For example, the box ID for the “Ongoing agile project” is AGILE-1 (you can find the box ID in the box switcher or next to the box name when you are inside the box) . The issue in box(AGILE-1) or issue in box("AGILE-1") function will return all the issues in the scope of the AGILE-1 box.

enhanced jql example.

Available enahnced JQL functions

You can find the available enahnced JQL functions in the table below.

Context

Function

Result

Context

Function

Result

Box

issue in box(BOX-ID)

Returns all tasks included in the scope of the selected box.

Box

issue in boxBacklog(BOX-ID)

Returns only those tasks that are included in the scope of the selected box but do not belong to any of its sub-boxes.

Box

issue in boxLead(leader1, leader2, ...)

Returns all tasks from boxes led by the selected user(s). Such user(s) can be listed by:

  • <Name> <Surname>

  • login

  • email

  • JQL function: currentUser()

Box, parent

issue in allBoxParentTasks(BOX-ID, TASK-KEY)

Returns all parents of the selected task. Only parents from the selected box are listed.

Box, children

issue in allBoxDescendantTasks(BOX-ID, TASK-KEY,X)

Returns all children of the selected task, up to the X-th level in the task hierarchy.

The first level is the root task (the task included in the query). Only the children included in a selected box are listed.

Task color

issue in taskColor(RED, BLUE)

Returns all tasks of a selected color.

Objectives

issue in allObjectives(BOX-ID)

Returns all issues that serve as objectives for a selected box.

"Basic Objectives" are not returned.

Objectives

issue in mainObjectives(BOX-ID)

Returns all the issues that serve as Main Objectives in the selected box.

"Basic Objectives" are not returned.

Objectives

issue in teamObjectives(BOX-ID, TEAM-ID)

Returns all issues that serve as Team Objectives in the selected box and team.

"Basic Objectives" are not returned.

Links

issue in allDependencies(TASK-KEY)

Returns all issues linked to the selected task, regardless of the type of a dependency.

Links

issue in hardDependencies(TASK-KEY)

Returns all the issues linked to the selected task with a strong dependency.

Links

issue in softDependencies(TASK-KEY)

Returns all the issues linked with the selected task with soft links.

Links

issue in

inwardDependencies(SOURCE-TASK-KEY)

Returns all the issues that are inward linked with the selected task.

Links

issue in

outwardDependencies(TARGET-TASK-KEY)

Returns all the issues that are outward linked with the selected task.

Critical path

key in boxTasksOnCriticalPath(BOX-ID)

Returns all tasks on the critical path in the selected box.

Risks

issue in boxRisks(BOX-ID...)

Returns all the issues that serve as risks in the scope of the selected box.

Related content