...
You can now share your traceability matrices more easily with your coworkers, by inserting them in your Confluence pages.
...
How to embed your report
In the Confluence page editor:
|
...
 |
|
...
|  |
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. |
⚠️ Permissions on the matrices
Matrices need to be shared to the whole space to be displayed in the Report macro. If you have not made them public before hand, you can edit the permissions directly when selecting a matrix (c.f : Step 2.)
The regular way to edit the permissions of your matrices is in the Saved Matrices tab → Edit → And select either the “With view only permissions” or “With view and edit permissions” radio button.
...
🎉 Tada
...
Sharing permissions
Note that you can share your traceability matrices either :
to allow other users to update it using the “With view and edit permissions”
to allow others to only see the result of your matrices without being able to update your template using “With view only permissions”. However other will be able to clone your matrices if they went to use yours as template.
To go further
Use the report
 |
Once the report is embedded and the page published, you can interact with the report like you would in the Traceability tab:
|
...
|
...
|  |
Advanced options
Edit external properties in the Report
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. |
...
 |
Use template variables
The report macro supports template variables in the search query to make traceability matrices modular and reusable.
Template variables allow you to save traceability matrices with a dynamic search query that can be adjusted when used in a report macro, without modifying the original traceability matrix.
This is particularly useful when embedding the same traceability matrix across multiple Confluence pages with only slight modifications to the search query.
Syntax for template variables
Template variables are defined using a :
A dollar sign
$,
...
Curly braces
{ }And a given name (e.g.
${variableName}).You can also provide a default value by appending a colon
:, followed by the default value (e.g.${variableName:Default value}).
...
ℹ️ If you have description, text or property that looks like a variable but should is not be treated as one, you can escape it the characters using a backslash (e.g. \${variableName}).Examples
Example:
${prefix}: A variable namedprefixwith no default value.${prefix:BR}: A variable namedprefixwith a default value ofBR.\${prefix}: Literal text${prefix}that should not be treated as a variable.
System variables
You can also use system variable allowing you to have dynamic reports .
You can use three kinds of system variables based on your current page or variant. The use is the same as template variables, however the variable name here are fixed:
SYSTEM_PAGE_ID: will be replaced by the page where the report is inserted ine.g.
key ~ ‘BR%'BR%' AND and page = ${SYSTEM_PAGE_ID}will show all the requirements having a key starting by “BR” and being defined in the page where the report is inserted in.
SYSTEM_VARIANT_NAMEandSYSTEM_VARIANT_ID:e.g.
key ~ ‘BR%'BR%' AND variant = '${SYSTEM_VARIANT_NAME}’'will show all the requirements having a key starting by “BR” and being in the variant of the current page where the report is inserted in.
Status colour Blue title IN DEVELOPMENT SYSTEM_SPACE_KEYe.g.
key ~ ‘BR%'BR%' AND space = '${SYSTEM_SPACE_KEY}’'will show all the requirements having a key starting by “BR” and being in the space of the current page where the report is inserted in.
...
How to use template variables in the “Traceability” tab
|  |
|   |
|
...
|
...
 |
How to use template variables in the report macro editor
|
...
|
...
|
...
|  |
|  |
|  |
|
...
 |
Export your reports in PDF
You can now export your reports in PDF ! Simply click by clicking on the three dots at the top-right of the page and on export. The dynamic RY Report macro will be visible just like this:
...
Permissions cross spaces
You can insert macros that pull data from an other Confluence space. The report macro uses the permissions of the space where it was saved to display requirements.
...