Versions Compared

Old Version 6

changes.mady.by.user Rina Nir _RadBee

Saved on

compared with

New Version Current

changes.mady.by.user Rina Nir _RadBee

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

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

  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.

Info

Need to configure a multi-level snapshot? Refer to How to Configure a Multi-Level Jira Snapshots Macro

...

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.

New 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

-

In Level 1:

Any valid JQL, applicable for the Jira from which the snapshot data is retrieved.

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

(lightbulb) It's a good practice to test the JQL first in Jira.

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):

See explanation here: How to Configure a Multi-Level Jira Snapshots Macro

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.

(lightbulb) 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.


(lightbulb) 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 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.

...

  1. .