Skip to main content
Skip table of contents

Smart Issue Panels for Jira

What is an "Issue Panel"?

The Issue Panel is an additional panel in the issue view screen. The panel contains a list of issues based on a dynamic search.

An Issue Panel can be created by Jira Administrators and can be configured by Jira Administrators

On this page

For all the following procedures,

  • Smart Panels for Jira app must be installed on your Jira Cloud with a license or trial license (see our Installation Guide for detailed instructions).

  • You must be logged in as a user with the Jira Administrators global permission.

Creating a new Issue Panel

An Issue Panel is specific to a single project or multi projects or global. If you want to reuse the configuration of an existing Issue Panel, go to step Copying an Issue Panel on this page.

  1. Choose :cog_icon: > Apps

  2. Navigate to Smart Panels for Jira Cloud

  3. Click Create Issue Panel.

  4. Use the form to configure the following attributes and conditions of your panel (See the table below)

  5. Click Save and you will be redirected to the Manage Panels page.

Section

Parameter

Description

Additional Information

Required

Details

Name

Enter the name for the panel.

Use a self-explanatory panel name so users can understand the purpose of your panel.

Maximum 255 characters

yes

Description

Add a description of the panel.

Maximum 4096 characters

no

Scope

Select the scope where the panel will be displayed

Global: Apply for all Projects
Projects: Apply for specific project/s

yes

Project

To configure the field Project, the Scope “Projects” must be selected

Select the project where the panel will be displayed.

Multi Select Field

yes

Issue Type

The Issue Types where the panel will be display, or All Issue Types if this field is empty.

Multi-Select Field
Default: “All Issue Types”

no

Content

JQL

For detailed documentation see Constructing the JQL Query

Use JQL (Jira Query Language) to search for issues.

Auto-complete function to suggest writing correct JQL.
The validation of the JQL query is performed when displaying the panel to the user.

Incorrect JQL semantics will result in an error message in the panel view.

yes

Additional Functions

Paste value() with the selected field as a placeholder to the JQL field.

Allows to perform a dynamic search on issue specific values.

For detailed documentation see Constructing the JQL Query

no

Shared Filters

Paste JQL from suggested pre-defined filters to the JQL field.

Suggests all filters which are shared with the current user and selected project.

no

Columns

Select the metadata of the issue to be displayed. Optionally customize the header.

  • To add a new column, select a field from Add field input.

  • By default, field name will be used as the table header if the custom header is empty.

  • Use Restore default to restore the list of 4 pre-defined columns: Key, Summary, Status, Assignee

  • Use Reset previous (only when editing a panel) to undo every changes in the Columns list, and revert to the original columns before editing

  • Drag and drop a column to set the order of columns in panel view

  • To delete a column, click on the delete icon

yes

Permissions

Viewers

Grant permission to view the panel to certain groups, project roles, etc…

  • Private: Only viewed by the creator

  • User: Grant the view permission for specific users

  • My Organization: Any logged in user on the site

  • Group: Grant the view permission for specific groups

  • Project: Select project, project roles for viewing

yes

Supported issue field to show in Smart Issue Panel

List of all supported issue fields to show in the Smart Issue Panel.

System Fields

Custom Field Types

  • Affects versions

  • Assignee

  • Attachment

  • Comment

  • Components

  • Created

  • Creator

  • Description

  • Due date

  • Environment

  • Fix versions

  • Images

  • Issue Type

  • Key

  • Labels

  • Last Viewed

  • Linked issues

  • Original estimate

  • Parents

  • Priority

  • Progress

  • Project

  • Remaining Estimate

  • Reporter

  • Resolution

  • Resolved

  • Status

  • Status Category

  • Status Category Changed

  • Sub-tasks

  • Summary

  • Time Spent

  • Updated

  • Votes

  • Watches

  • Work Ratio

  • Σ Original Estimate

  • Σ Progress

  • Σ Remaining Estimate

  • Σ Time Spent

  • Checkboxes

  • Date Picker

  • Date Time Picker

  • Group Picker (multiple groups)

  • Group Picker (single group)

  • Labels

  • Number Field

  • Paragraph (supports rich text)

  • Project Picker (single project)

  • Radio buttons

  • Select List (cascading)

  • Select List (multiple choices)

  • Select List (single choice)

  • Short text (plain text only)

  • Text Field (read only)

  • URL Field

  • User Picker (multiple users)

  • User Picker (single user)

  • Version Picker (multiple versions)

  • Version Picker (single version)

Constructing the JQL Query

In the section Content, we use JQL to construct the search query. The result of this search query is a list of issues that will be displayed in the Smart Issue Panel.

  • Define your JQL in the JQL field. Advanced JQL features like auto-completion, operators, etc. are available.

  • The Shared Filters allocates all filters which are shared with the current user and selected project.
    Selecting a filter will paste the respective JQL query to the JQL field. You can further edit the query in the JQL field after it has been pasted.

  • An additional JQL function of type value() was added to perform a dynamic search on issue-specific values. Select any allocated field in the Additional Functions drop-down and a respective value() function will be generated and added to the JQL field automatically. (See more parse “Smart JQL” to “JQL” )

Examples for using the Additional JQL function value()

To construct a search based on any of the issues system fields, select the respective system field.

  • To perform a search based on current reporter issues, select “Reporter“.
    The following query will return all issues that are assigned to the current reporter:

CODE
assignee = value("Reporter_[reporter]") 
  • Whereas the following query will return all issues which have a component in the current issues component list:

CODE
component in value("Component/s_[components]")

To construct a search based on the current issue itself or a search that excludes the current issue, select the system field “Key”.

  • Get a list of all issues linked with the current issue and use it to create your own customized Issue Links panels such as e.g. “Related Bugs”. The following query will return all bugs that are linked to the current issue:

CODE
issue in linkedIssues(value("Key_[issuekey]")) AND issuetype = Bug
  • To exclude the current issue from the search result you can add the following to your JQL query:

CODE
key != value("Key_[issuekey]")

To construct a search based on any of the issue's custom fields, select the respective custom field.

  • To perform a search based on the value in the field “Customer“, select “Customer”.
    The following query will return all issues where the custom field “Client” has the same value as the current issues custom field “Customer”:

CODE
Client = value("Customer_[customfield_10021]")

For the following procedures, at least one Issue Panel must already exist.

For all the following Actions:

  1. Choose :cog_icon: > Apps.

  2. From section APPS, select Smart Panels for Jira Cloud.

The limitation of issues in the Smart Panels is 100 issues

Tip:

  • You can search your panels by Name or Scope.

Editing an Issue Panel

  1. Locate the desired Issue Panel and click :button_action: > Edit. / Or locate the desired Issue Panel → click on the name

  2. On the Edit Panel page, use the form to configure the attributes and conditions of the panel (see the above table).

  3. Click Save and you will be redirected back to the Dashboard page.

Copying an Issue Panel

  1. Locate the desired Issue Panel and click :button_action: > Copy.

  2. The new copy issue panel will be added to the list of issue panels. The copy panel has a name with the syntax: "[original_name] - Copy”

Enabling/Disabling an Issue Panel

  1. Locate the desired panel and click the toggle button Status

Removing an Issue Panel

  1. Locate the desired Issue Panel and click :button_action: > Delete.

  2. Confirm the deletion by clicking Delete.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.