How to configure the "RY Reports" macro, notably the columns.
In Properties and RY Reports, we've introduced the ability to write reports. This page describes the report syntax.
First, insert the macro named "RY Report":
Then you can edit the properties:
Syntax
The first 3 parameters are are self-explanatory. The "Columns" field has a specific syntax:
Configuration for "Columns" | Result |
---|---|
key, description | 2 columns. |
key, description+properties+links | 2 columns. The second one contains the description, the properties and the links. |
key, @Prop1 | The value of the property "Prop1" for the requirement |
key, jira | The list of JIRA issues attached to the key. |
key, jira@resolves | The list of JIRA issues, filtered for the relationship named "resolves". |
key, description+properties, links+jira | 3 columns, the default layout, similar to the search screen. |
Field | Contents |
---|---|
key | The key of the requirement |
description | The main description of the requirement |
properties | The properties of the requirement |
jira | The JIRA issues linked to the requirement |
status | The status of the requirement |
links | The pages linked to the requirement |
to | Dependencies to this requirement |
from | Dependencies created by this requirement |
Options
A few formatting options are available:
Field definition | Result |
---|---|
to | Displays the "to" field (as above) |
to?format=short | Link to the key only, without a list, without the lozenge |
to?format=page | Link to the page only, without a list, without the lozenge |
to?format=page&li=false | Same a s above, without showing the bullet pionts of the list. |