...
Changes to external property values will then be saved.
...
...
If you are using a saved matrix as a template report, that you’ll be able to reuse on different pages, but showing information from different requirements, it is possible to replace the saved query by something else.
In the example below, see that the query is
key ~ 'BR%'
we’ll replaceBR
byFN
, giving you a report based on this query:key ~ 'FN%'
.
...
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 dollar sign, curly braces and a 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}
). Moreover, if a text looks like a variable but should not be treated as one, you can escape it using a backslash (e.g. \${variableName}
).
Examples:
${prefix}
: A variable namedprefix
with no default value.${prefix:BR}
: A variable namedprefix
with a default value ofBR
.\${prefix}
: Literal text${prefix}
that should not be treated as a variable.
You can also use system variable allowing you to have dynamic reports.
You can use three kinds of system variables :
SYSTEM_PAGE_ID
: will be replaced by the page where the report is inserted in
e.g.key ~ ‘BR%' 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_NAME
andSYSTEM_VARIANT_ID
:
e.g.key ~ ‘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_KEY
e.g.key ~ ‘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.
Use template variables in the “Traceability” tab
Navigate to the
Traceability
tab.Use template variables in the search query.
When the search query contains variables, a
Variables
dropdown is displayed in the search bar.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.Once you’re happy with your search query, you can save the traceability matrix.
...
Use template variables in the report macro editor
Edit a Confluence page.
Start inserting a report macro.
Select the traceability matrix containing template variables.
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).
Insert the report macro.
The report macro will be rendered using the provided values.
...
Export your reports in PDF
...