Versions Compared

Old Version 1

changes.mady.by.user Rina Nir _RadBee

Saved on

compared with

New Version 2

changes.mady.by.user Rina Nir _RadBee

Saved on

Key

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

If you are working on a regulated industry, you need to issue up to date release documents before the go live.

You manage the specifications and tests in Jira, and it is frustrating to run into these limitations:

  1. Because of the dynamic nature of Jira macros in Confluence- you cannot use them for the release documents- because its impossible to trust that the Jira data will not change.

  2. Its' difficult to create proper traceability documents.

Overcoming these limitation requires using different hacks, workarounds, or various Apps and scripts.

With Jira Snapshots creating release documents directly in Confluence is secure and quickThis is a followup use case to Release documentation 1: The bliss of full control combined with ease .

For a quick recap, Jira Snapshots dramatically reduces the time you need to spend on release documentation:

  1. Jira data on Confluence page is static and time stamped. Whatever happens in Jira- the Confluence page will not change…until you want it to change.

  2. Two, three and more traceability matrices are easy to set up.

  3. And there is this extra bonus: you You can compare between different versions of the data - stakeholders just love this feature because there is good visibility of what changed since the previous release.

  4. In Confluences' page history: each new snapshot creates a new page version. When you view previous versions of the page, the page include the correct historic snapshot.

  5. Snapshots are included Confluence exports (Word and PDF)

Now, release documents can be ready as soon as the product release is ready. No delays and waste of everyones time. Here, we’ll show how to include Xray test management in the Snapshot.

(lightbulb) To setup the integration with Xray checkout Integration: Configuring a Link with Xray Test Management

(lightbulb) For details of what is supported by this integration checkout Integration with Xray Test Management for Jira

Info

Use case by Rina Nir _RadBee . RadBee’s CEO “We cannot remove the burden of regulatory compliance, but we surely can rid teams from the waste of time”

Tip

Tips

  1. If your traceability items are managed you use Xray Test Management in Jira, then Jira Snapshots is the only way to create controlled specification documents directly in Confluence.Use multiple Jira Snapshot macros on the same page to display different sets of issues. Like one to display the user requirements and a second for the traceability from user requirements to functional specificationsuse Jira Snapshots for test and traceability reports.

  2. JQL:

    1. Level 1 of the traceability selects the user requirements functional specifications applicable for our release: 

      1. Code Block
        project = GAL AND issuetype = "UserFunctional requirementspecifications" AND fixVersion = V1.0 order by 'Requirement type' ASC

    2. Level 2 of the traceability selects the functional specifications tests traced down from each user requirement: 

      1. Code Block
        issue in linkedissueslinkedIssues($key,"Tracesis downtested toby") AND fixVersion = V1.0 order by key ASC

Here is how to do it

  1. Login to Confluence and create a new page. Add to it all the “regular text” sections, like ‘Pupose’, 'Scope':

  2. In the top editor toolbar, click the “+” icon and type “jira s” in the search bar.  Then, select the “Jira snapshots” macro.

  3. In the “Edit Jira Snapshots Macro” overlay:

    1. Enter a title in the “Level title” field to represent the first level or “list” of Jira issues.

    2. Enter a query in the “Search JQL” field to limit the scope of issues, like:

      1. Code Block
        project = GAL AND issuetype = "User requirement" AND fixVersion = V1.0 order by 'Requirement type' ASC

    3. In the “Add fields to display” field, select the desired columns.

    4. When configuring the traceability report, you’ll need to select: “+ Add new level”

    5. Enter a title for the 2nd level

    6. Enter a query in the “Search JQL” field. This time it needs to link with Level 1, like:

      1. Code Block
        issue in linkedissues($key,"Traces down to") order by key ASC

    7. In the “Add fields to display” field, select the desired columns.

    8. Click the “Insert” button at the bottom right to complete the macro’s configuration.

  4. Click the “Publish” button at the top right of the page.

  5. Finally, click the “Create controlled snapshot” button to generate a static list of issues.

Here’s the finished result.

Need to change the issue list or display different information?  Simply edit the macro details and click the “Update” button, on the Confluence page, to take a new snapshot.