Page Comparison

Adding the Jira Snapshots Macro to a Confluence Page

1. Navigate to the page and click the Edit icon, or just type E to open the editor. (Alternatively, you can create a new page.)

2. In the Confluence editor, click the '+' iconand choose View more from the drop down menu.

3. Find the item to be inserted and select it.

4. Click Insert.

5. Configure the macro and Save. Further down on this page you’ll find more information about configuration.

Publishing and Generating the First Snapshot

1. Once the macro is configured, continue editing the rest of of the page, and click Publish when finished.

2. After the page is published, click Update to generate the first snapshot.

What are Levels?

By default, each Jira snapshot report includes a “Level 1.” This is a list of Jira issues retrieved using a JQL clause.

Sometimes you’ll need to include other issues, which are dependent or related to the issues in Level 1. These will be retrieved by adding a Level 2 to the report.

Examples of Level 1 - Level 2 issues:

• Epics and their stories

• Issues and their subtasks

• Stories and their related bugs

• Issues and their “blocker” issues

Jira Snapshots supports additional levels; you could go as far as three or four levels, if needed.

...

Parameters

Parameters are options that you can set to control the content or format of the macro output.

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	-

In Level 1:

Any valid JQL, applicable for the Jira from which the snapshot data is retrieved. It's a good practice to test the JQL first in Jira.

This may include any JQL extensions by apps, as long as they are valid inside that Jira instance.

Refer to

the Jira manual for more information: https://support.atlassian.com/jira-software-cloud/docs/what-is-advanced-searching-in-jira-cloud/

In Level 2 (or higher):

The JQL clause for Level 2 needs to include a reference to Level 1, in order to achieve the dependency/cascading effect.

Therefore, the search clause must reference fields in the previous level.

For example:

parent=$key : will retrieve subtasks of issues in the previous level

issue in linkedIssues($key) : will retrieve issues linked to the issue in the previous level

issuetype = Test AND issue in linkedissues($Key, "is tested by") : will retrieve test issues that are linked with this link type, to the issue in the first level.

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. The list of available fields is specific to the Jira instance the snapshot is connected to. The list includes custom fields configured for this instance. If integration with 3rd party apps is configured, such as Xray Test Management, then the list of fields here will also include fields available via the integration.

Key Features

1. Any legitimate JQL clause can be used to retrieve data from Jira.

2. The list of columns is configurable.

3. Retrieving fresh data from Jira into Confluence is done from Page View mode, by clicking Update.

4. Each time fresh data is imported, a new Confluence page version is generated. This can be seen in the Page History view. 

5. The DIFF tool enables you to compare the current Jira data with any previous snapshot. 

   1. 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 )

6. A single Confluence page may include multiple instance of snapshot macros, each retrieving a different set of

...

Known Limitations

...

1. data

...

1. .