Query Parameters
The following parameters can be used to fine-tune the queries of a template.
Content control
Required?
Value type
Default value
Used for
Example
query.{name}.name
Y
string
Used for referencing the query. It must match the {name} referenced in the merge field as well.
<<query.epic.name>> = epic
query.{name}.description
N
string
Helps understand the purpose of the query but not displayed anywhere.
query.{name}.cbql
Y
string
understand
query.{name}.dependson
N
string
the purpose
<<query.userStory.dependson>> = epic
query.{name}.incomingReferences
N
checkbox
N
of the query
query.{name}.outgoingReferences
N
checkbox
N
Marks if this query should be connected to the dependson query by upstream reference. It is False by default.
query.{name}.incomingAssociations
N
checkbox
N
Marks if this query should be connected to the dependson query by downstream association. It is False by default.
query.{name}.outgoingAssociations
N
checkbox
N
Marks if this query should be connected to the dependson query by upstream association. It is False by default.
query.{name}.history
N
checkbox
N
Marks if the history entries of the result set should also be queried. Required for being able to reference the related entries in the template.
query.{name}.reviewHub
N
checkbox
N
Marks if the Review Hub entries of the result set should also be queried. Required for being able to reference the related entries in the template.
query.{name}.workflowReview
N
checkbox
N
Marks if the workflow based review entries of the result set should also be queried. Required for being able to reference the related entries in the template.
query.{name}.testCaseRuns
N
checkbox
N
Marks if the related test case runs of the result set (along with their results) should also be queried. Required for being able to reference the related entries in the template.
See default test run template:template-test-runs.docx<<item.testCaseRuns.*>>
query.{name}.testRunStatistics
N
checkbox
N
Marks if statistics of queried top level test runs should also be queried. Required for being able to reference the related entries in the template.
See default test run template:template-test-runs.docx <<item.testRunStat.*>>
query.{name}.foldersAndInformation
N
checkbox
N
Marks if the result of the query should contain the folder and information type items too. false by default.
Was this helpful?