There are two Jira JQL Snapshot Macros:
...
Jira jql snapshot:
Retrieves the results of a Jira JQL query.
The list of columns (fields) is configurable by the Macro
Jira jql traceability snapshot:
...
Retrieves a two level traceability report: for example the list of requirements, and the specifications which are implemented by each requirement.
...
Each of the levels is defined by a JQL query. The lower level query is dependent on the first level.
...
Adding the Jira Snapshots Macro to a Confluence Page
Navigate to the page and click the Edit icon, or just type E to open the editor. (Alternatively, you can create a new page.)
In the Confluence editor, click the '+' iconand choose View more from the drop down menu.
Find the item to be inserted and select it.
Click Insert.
Configure the macro and Save. Further down on this page you’ll find more information about configuration.
| Info |
|---|
You can also type '/' (forward slash symbol) while editing the page, to bring up the same list you'd see by in the View more menu. |
Publishing and Generating the First Snapshot
Once the macro is configured, continue editing the rest of of the page, and click Publish when finished.
After the page is published, click Update to generate the first snapshot.
| Info |
|---|
Need to configure a multi-level snapshot? Refer to How to Configure a Multi-Level Jira Snapshots Macro |
Parameters
Parameters are options that you can set to control the content or format of the macro output.
| Info |
|---|
JQL is ' Jira Query Language'. This is the native query language for Jira, and these macros use it directly when retrieving data from Jira. See here the complete JQL reference: https://confluence.atlassian.com/jirasoftwareserver/advanced-searching-939938733.html Its a good idea to check that the JQL is correct in Jira, before using it in the Jira jql snapshot Macros- this will help ensure that the macro actually displays the data you intend it to displayNew to JQL? We have put here Jira JQL cheat sheet some information to help you get started |
Parameter name | Required | Default | Parameter description and accepted values |
|---|---|---|---|
Level title | No | Empty | A title for this level will be displayed above the column titles. |
Search JQL | Yes | - | Refer to Jira Snapshots Filtering: Jira JQL extended with page properties and metadata |
Add fields to display | Yes | Key, Summary | The list of Jira fields to display. Use the widget just below the field to drag and reorganize the order of the columns in the level.
|
Key Features
Any legitimate JQL clause can be used to retrieve data from Jira.
...
The list of columns is configurable.
Retrieving fresh data from Jira into Confluence is done from
...
Page View mode, by clicking
...
Update.
Each time fresh data is imported,
...
a new Confluence
...
page version is generated. This can be seen in the Page History view.
...
The DIFF tool
...
enables you to compare
...
the current Jira data
...
with any
...
previous
...
snapshot.
...
A single Confluence page may include multiple instance of the snapshot macros, each retrieving another set of data.
Known Limitations
The snapshot macros cannot retrieve files (ie- images) from Jira. So, if a 'description' field contain a screenshot image, this image will not be included in the Confluence data. Note: You might still see this image ij Confluence if it is cached in your browser, but this is just a coincidence. The image will no longer display if you clear you browser cache.
Jira fields may have many different formats, and some Apps may even have their own custom field types with their special formats. This may lead to situations that some fields do not display correctly. Please contact RadBee if you run into this situation: and we'll try to adjust.
Using The Jira JQL Snapshot Macro
We assume you have a Confluence page, on which you want to add a table of Jira data.
EDIT the page and navigate to the location where you want the table to be.
Enter this Macro on the page: "Jira jql snapshot"
These are the parameters:
JQL: This is a legals JQL clause that retrieves the data you want to have in the table, for example: filter="PPD Breast Risks"
Fields: A semicolon separated list of fields.
For example: issue type;key;Components;Summary;Fix versions;Hazard;Harm;Probability;Impact;Risk level;Protective measures;Information for safety;Residual Probability;Residual Impact;Residual risk level;Residual risk impact;Residual risk acceptability
Macro id: put here any unique string (unique in the scope of this page). This parameter is only needed if you have more then a single Snapshot macro on the same Confluence page.
After configuring the parameters you can save the page.
Initially, no data will be presented.
Note: it is possible that you will be required to "authenticate to Jira": this is required to allow you to retrieve fresh data from Confluence.
Click the "CREATE CONTROLLED SNAPSHOT" button to initiate the retrieval of fresh data from Jira.
Using The Jira JQL Traceability Snapshot Macro
Using the "Jira JQL traceability snapshot" macro is identical to using the "Jira jql snapshot", except that the list of configuration parameters is longer and caters to the "two levels traceability".
Here is the list of parameters
...
Level 1 Title
...
Level 1 JQL: This is any legal JQL clause that retrieves the data you want to have in the table,
for example: project = PPD AND issuetype in ("Functional Requirement", "Non Functional Requirement") AND component = "Paige Breast Classification"
...
Level 1 Fields: A semicolon separated list of fields.
For example: Key;Summary;Description
...
Level 2 Title
...
Level 2 JQL: This is any legal JQL clause that retrieves the data you want to have in the table. In this JQL clause you can include reference to any of the columns of the first level, by refereing to it with a $ sign
For example: issuetype = Test AND issue in linkedissues($Key, "is tested by")
...
Level 2 Fields: A semicolon separated list of fields.
For example: Key;Summary;TestRunStatus - Current Version
...
The DIFF view could also be included in the PDF or WORD export of the page. To make the DIFF part of the export use the “Save Diff View for export” button. (Available from version 2.113.1 )
A single Confluence page may include multiple instance of snapshot macros, each retrieving a different set of data.