Smart Wiki Panels for Jira
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 Wiki Panel
An Wiki Panel is specific to a single project or multi projects or global. If you want to reuse the configuration of an existing Wiki Panel, go to step Copying an Wiki Panel on this page.
Choose :cog_icon: > Apps
Navigate to Smart Panels for Jira Cloud
Click Create Wiki Panel.
Use the form to configure the following attributes and conditions of your panel (See the table below)
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 | 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 | no | |
Content | Filter By | Select filter by CQL or BUILDER | Select type for wiki panel search | yes |
CQL Available when Filter By is set to CQL | Use CQL (Confluence Query Language) to search for issues. | CQL also support the Smart Value for configuration | ||
BUILDER Available when Filter By is set to CQL | Use CQL Builder UI to search for issues. | |||
Max Contents | The maximum number of page/blog.. shown in the panel | Set -1 to indicate an unlimited number of contents | yes | |
Results per pag | The maximum number of contents shown in the panel for each page | Min: 1 | yes | |
Columns | Select the metadata of the issue to be displayed. Optionally customize the header. |
| yes | |
Permissions | Viewers | Grant permission to view the panel to certain groups, project roles, etc…
| yes |
Supported issue field to show in Smart Wiki Panel
List of all supported issue fields to show in the Smart Wiki Panel.
Support Fields |
|---|
|
Constructing the CQL Query
In the section Content, we use CQL to construct the search query. The result of this search query is a list of issues that will be displayed in the Smart Wiki Panel.
Define your CQL in the CQL fields
Smart Values are supported when writing CQL. They enable dynamic searches based on issue-specific values. Learn more: Smart Values in Smart Panels
Builder
Use the link Add a filter to see all available filters. From the drop-down menu, select the relevant filter. The additional filter field can be removed via the cross button.
Parameter | Description | CQL parse |
|---|---|---|
Text | Text field to search by text | text ~ “<input>“ |
In Space | Multi-select to search by Space | spaces IN (<input>) |
With title | Text field to search by title | title~"<input>" |
Label | Multi-select to search by Label | label IN (<input>) |
Type | Multi-select to search by Type | type IN (<input>) |
Creator | Multi-select users to search by Creator | creator IN (<input>) |
Contributor | Multi-select users to search by Contributor | contributor IN (<input>) |
Mentioning user | Multi-select uses to search by Mentioning | mention IN (<input>) |
Created | Single select to search by created | createded >= <input> ,… |
Last Updated | Single select to search by lasted updated | lastmodified >= <input>,…. |
For the following procedures, at least one Wiki Panel must already exist.
For all the following Actions:
Choose :cog_icon: > Apps.
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 a Wiki Panel
Locate the desired Wiki Panel and click :button_action: > Edit. / Or locate the desired Wiki Panel → click on the name
On the Edit Panel page, use the form to configure the attributes and conditions of the panel (see the above table).
Click Save and you will be redirected back to the Dashboard page.
Copying a Wiki Panel
Locate the desired Wiki Panel and click :button_action: > Copy.
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 a Wiki Panel
Locate the desired panel and click the toggle button Status
Removing a Wiki Panel
Locate the desired Wiki Panel and click :button_action: > Delete.
Confirm the deletion by clicking Delete.