...
Scenario
This recipe allows you to create a report for monitoring a project's progress.
In this project, there are tasks with different statuses and it would be useful to immediately monitor the statuses of the tasks in one place.
By creating this recipe, you will be able to monitor the statuses of all tasks in the project on just one page.
Result
...
Recipe
Apps | Reporting for Confluence Server & Data Center |
---|---|
Level | Intermediate |
Estimated time | 15 minutes |
Macros | Local Reporter, Report Body, Report Column, Report Empty, Report Table, Text Filter, Text Sort |
Suppliers | Page Supplier, Scaffold Data Supplier |
Storage format
You can copy and paste this code into the Confluence Source Editor:
Code Block |
---|
<ac:structured-macro ac:macro-id="42e08bda-db2d-471e-9ada-d9febe3f644b" ac:name="report-table" ac:schema-version="1"> <ac:rich-text-body> <ac:structured-macro ac:macro-id="19fd8bf5-b9b6-48bc-86de-f84b4c850f06" ac:name="content-reporter" ac:schema-version="1"> <ac:parameter ac:name="types">page</ac:parameter> <ac:rich-text-body> <p> <ac:structured-macro ac:macro-id="1940e394-d76c-42c2-ac94-03fabfe389f7" ac:name="text-filter" ac:schema-version="1"> <ac:parameter ac:name="required">true</ac:parameter> <ac:parameter ac:name="">data:project</ac:parameter> </ac:structured-macro> </p> <p> <ac:structured-macro ac:macro-id="2f9dfdba-8711-4f87-86a7-773c01910e83" ac:name="text-sort" ac:schema-version="1"> <ac:parameter ac:name="">page:title</ac:parameter> </ac:structured-macro> </p> </ac:rich-text-body> </ac:structured-macro> <ac:structured-macro ac:macro-id="b2afb839-2862-4e96-82f2-28d4470b26c3" ac:name="report-column" ac:schema-version="1"> <ac:parameter ac:name="title">Project Name</ac:parameter> <ac:rich-text-body> <p> <ac:structured-macro ac:macro-id="64b445f0-27f0-4ea3-8d95-06977cde600b" ac:name="report-info" ac:schema-version="1"> <ac:parameter ac:name="link">true</ac:parameter> <ac:parameter ac:name="">page:title</ac:parameter> </ac:structured-macro> </p> </ac:rich-text-body> </ac:structured-macro> <ac:structured-macro ac:macro-id="e1ecb9dc-57c6-4a46-9e56-d49eb0c81866" ac:name="report-column" ac:schema-version="1"> <ac:parameter ac:name="title">Status</ac:parameter> <ac:rich-text-body> <ac:structured-macro ac:macro-id="3f189542-d813-4049-b97e-354019d5526e" ac:name="report-block" ac:schema-version="1"> <ac:parameter ac:name="maxResults">1</ac:parameter> <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter> <ac:rich-text-body> <ac:structured-macro ac:macro-id="437d671c-c82a-4948-a480-602ae80d60f0" ac:name="local-reporter" ac:schema-version="1"> <ac:parameter ac:name="">data:project</ac:parameter> <ac:rich-text-body> <p> <ac:structured-macro ac:macro-id="0a1ce5ca-d1dc-41f8-827e-d83b1fb12056" ac:name="text-filter" ac:schema-version="1"> <ac:parameter ac:name="value">In Progress</ac:parameter> <ac:parameter ac:name="">data:Status</ac:parameter> </ac:structured-macro> </p> </ac:rich-text-body> </ac:structured-macro> <ac:structured-macro ac:macro-id="4c7c90be-fc00-49e2-ba84-e27c48e7f9a6" ac:name="report-body" ac:schema-version="1"> <ac:rich-text-body> <ac:structured-macro ac:macro-id="2d9669df-3b7a-4136-a63f-87ab61035a24" ac:name="status" ac:schema-version="1"> <ac:parameter ac:name="colour">Yellow</ac:parameter> <ac:parameter ac:name="title">In Progress</ac:parameter> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> <ac:structured-macro ac:macro-id="3e6472f5-e876-43ee-891f-80ab4d6078dd" ac:name="report-empty" ac:schema-version="1"> <ac:rich-text-body> <ac:structured-macro ac:macro-id="8917c415-4d5c-4f34-855c-7405afb818da" ac:name="report-block" ac:schema-version="1"> <ac:parameter ac:name="maxResults">1</ac:parameter> <ac:parameter ac:name="atlassian-macro-output-type">INLINE</ac:parameter> <ac:rich-text-body> <ac:structured-macro ac:macro-id="26fa1d4b-1bba-4fe6-ae37-19f6745a0d6c" ac:name="local-reporter" ac:schema-version="1"> <ac:parameter ac:name="">data:project</ac:parameter> <ac:rich-text-body> <p> <ac:structured-macro ac:macro-id="763db717-30ca-464c-834e-1715e3bd0f76" ac:name="text-filter" ac:schema-version="1"> <ac:parameter ac:name="value">Done</ac:parameter> <ac:parameter ac:name="">data:Status</ac:parameter> </ac:structured-macro> </p> </ac:rich-text-body> </ac:structured-macro> <ac:structured-macro ac:macro-id="d4ee5fb9-f3fb-4268-8278-15e03f7e3979" ac:name="report-body" ac:schema-version="1"> <ac:rich-text-body> <p> <ac:structured-macro ac:macro-id="04410691-b86c-4e4c-badd-9da1c6038763" ac:name="status" ac:schema-version="1"> <ac:parameter ac:name="colour">Green</ac:parameter> <ac:parameter ac:name="title">DONE</ac:parameter> </ac:structured-macro> </p> </ac:rich-text-body> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> </ac:rich-text-body> </ac:structured-macro> <p> <br/> </p> <p> <br/> </p> <p> <br/> </p> |
Macro structure
You can recreate the example in the editor view:
...
Steps
...
Create a Report Table macro.
Within the Report Table macro, create Content
...
Reporter macro, set types parameters to "page".
...
Within Content Reporter macro,
...
create Text Filter macro and set the following parameters:
Key:data:project
Required: checkedWithin Content
...
Reporter macro,
...
under Text Filter macro, create
...
a Text Sort macro and set the Key parameter to "
content:title
".
...
Within Report Table macro, under Content Reporter macro, create two Report
...
Column macros.
Set the first Report Column'
...
s Title
...
to "Project Name" and add
...
a Report Info macro within it.
...
Set the Report Info macro's Key to "content:title
"
...
Tick Link To Item.Set the second Report Column'
...
s Title
...
to "Status"
Within the second Report Column, create
...
a Report Block macro, set Maximum Result and First result parameters to "1".
Within the Report
...
Block macro, create a Local
...
Reporter macro and set the Key parameters to "
data:project
"
...
Within Local Reporter macro, create
...
a Text Filter macro with the following parameters:
Key:data:Status
Exact Value: In ProgressWithin Report Block macro, under Local Reporter, create
...
a Report Body macro and insert a "In Progress" status within it.
Within Report
...
Block macro, under
...
the Report Body macro, create a Report
...
Empty macro.
Within
...
the Report Empty macro, create
...
a Report Block macro, and set Maximum Result and First result parameters to "1".
Within
...
the Report Block macro, create
...
a Local Reporter macro and set the Key parameters to "
data:project
"Within Local Reporter macro, create
...
a Text Filter macro with the following parameters:
Key:data:Status
Exact Value: Done
...
Within Report Block macro, under Local Reporter, create
...
a Report Body macro and insert a "Done" status within it.
...
N/A
...