Use JQL (Jira Query Language) to choose which Jira work items a Vansah reporting gadget includes. Instead of selecting each work item individually, save a query that finds the work items matching your conditions when the report is loaded.
Before you begin
You need permission to edit the Jira dashboard and configure its gadgets.
You need access to the Jira work items and Vansah testing data you want to report on.
Use a gadget with a Work Item(s) selection control. The available configuration options depend on the gadget.
Add a JQL query to a gadget
Open the Jira dashboard containing the Vansah gadget.
From the gadget’s more options menu, select Configure. Enable dashboard editing first if your Jira layout requires it.
Select the Jira space or spaces offered by the gadget. If it offers a reporting type, choose Work Item/Test Folder.
Under Work Item(s) selection, select JQL.
Select the query field to open Search Issues (JQL). Enter a query, then select Search.
Review the matching work items. If Jira reports an error, correct the query and search again.
Select Save in the search dialog to apply the query to the gadget configuration.
Review the other gadget settings, then select the gadget’s Save button.
The screenshot shows where to select JQL. The appearance of the search dialog can vary by version; use Search to check the query and review the returned work items before saving.
JQL examples
Replace DEMO with your Jira space key. JQL retains the field name project for the Jira space. Use work item type and status names that exist in your Jira site.
All work items in one Jira space
project = DEMO ORDER BY key ASC
Stories in one Jira space
project = DEMO AND issuetype = Story ORDER BY key ASC
Work items assigned to the signed-in user
project = DEMO AND assignee = currentUser() ORDER BY updated DESC
Work items from two Jira spaces
project IN (DEMO, SHOP) ORDER BY key ASC
Use a query across multiple spaces only when the gadget supports the required spaces and you can access their data. A broader JQL search does not change the gadget’s configured reporting scope.
See Atlassian’s JQL search guide and JQL field reference for more supported conditions.
Understand what the gadget includes
Setting | What it controls |
JQL query | Which Jira work items match your search conditions. |
Jira space selection | The testing data and choices available to the gadget. |
Test Folders | Additional folder selections; review these if the report includes more testing data than expected. |
Include Child Work items | Where offered, includes child work items related to the selected work items. Clear it when you want to report only on the direct selections. |
Other gadget filters | Further restrictions such as Test Case type, assignee, environment, or release, where supported. |
JQL searches Jira work items. It does not directly search Vansah Test Case headlines or replace the gadget’s Test Case filters. Matching Jira work items may have no linked testing data to display.
The saved query can match a different set of work items over time. Refresh or reload the gadget to retrieve updated results; saving a query does not promise an instant live update.
Troubleshoot query results
Issue | What to check |
The query has an error | Use exact JQL field names. For a work item type, use issuetype = Story rather than Work item type = Story. Put names containing spaces in double quotation marks. |
No work items are found | Try project = DEMO first, using your own space key. Add conditions one at a time and check your Jira access. |
Search finds work items but the gadget is empty | Check the gadget’s selected Jira spaces, linked Test Cases, Test Folders, and additional filters. |
The report contains unexpected work items | Review the query, selected Test Folders, and Include Child Work items option. |
The query did not persist | Save in the JQL dialog, then save the gadget configuration. Reopen Configure to check the saved query. |
For the other reporting controls, see How to Use Filters in Reporting Gadgets.