Versions Compared

Key

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

...

In the Confluence page editor:

  • Type /req to access the RY macros, and select the RY Report macro

  • Select the desired saved matrix

  • You can notice the ‘Share' toggle: If your saved matrix is private, you’ll need to share it to be able to display it in the report. The permissions will now be set to ‘View’ only.

RY Report Macro - Choose your matrix.pngImage RemovedRY Report Macro - Choose your matrix.pngImage Added

By default, we display the title and description of the matrix. If you do not want to see them in the Confluence page, you can remove them with the toggle.

Insert your ry report.pngImage RemovedInsert your ry report.pngImage Added

Once the report is embedded and the page published, you can interact with the report like you would in the Traceability tab:

  • Move/Add/Remove columns, click on requirement keys to show their details, etc… Note that the changes you make in the visualisation of the report will not be saved, nor edit the actual saved matrix.

  • To make permanent changes to the report, go to the Saved queries tab, select the macro you wish to change, make your changes, and don’t forget to save.

Image RemovedImage Added

Advanced options

...

On macro creation, you can decide to allow users to edit the external properties directly in the Confluence page by checking “Enable the edition of external properties in the report macro”

Changes to external property values will then be saved.

Image RemovedImage Added

Use template variables

...

  • Navigate to the Traceability tab.

  • Use a template variables in the search query (e.g: ${prefix})

  • When the search query contains variables, a Variables dropdown is displayed in the search bar.

Screenshot from 2024-12-05 15-42-09.pngImage RemovedScreenshot from 2024-12-05 15-42-09.pngImage Added
  • The Variables dropdown allows you to test and preview the traceability matrix by dynamically setting variable values. The variable values defined here are not saved, they are for preview purposes only.

Screenshot from 2024-12-05 15-43-38.pngImage RemovedScreenshot from 2024-12-05 15-43-01.pngImage RemovedScreenshot from 2024-12-05 15-43-38.pngImage AddedScreenshot from 2024-12-05 15-43-01.pngImage Added
  • Once you’re satisfied with your search query, you can save the traceability matrix.

Screenshot from 2024-12-05 16-11-52.pngImage RemovedScreenshot from 2024-12-05 16-11-52.pngImage Added

How to use template variables in the report macro editor

  • Edit your Confluence page and insert a report macro. Select the traceability matrix containing template variables.

Screenshot from 2024-12-05 15-46-21.pngImage RemovedScreenshot from 2024-12-05 15-46-21.pngImage Added
  • When the search query of a traceability matrix contains template variables, the macro editor allows you to define a value for each variable. If a value is left blank, the default value of the variable is used (or an empty string if there is no default value).

Screenshot from 2024-12-05 15-46-47.pngImage RemovedScreenshot from 2024-12-05 15-46-47.pngImage Added

  • Insert the report macro.

Screenshot from 2024-12-05 15-46-53.pngImage RemovedScreenshot from 2024-12-05 15-46-53.pngImage Added

  • The report macro will be rendered using the provided values.

Screenshot from 2024-12-05 15-47-29.pngImage RemovedScreenshot from 2024-12-05 15-47-29.pngImage Added

Export your reports in PDF

...