Create a report to monitor project status

Scenario

This recipe lets you create a report for monitoring project progress.

In this project, there are tasks with different statuses, and it can be useful to monitor their statuses in one place.

Result

Recipe

Apps	Reporting for Confluence 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:

<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 a Content Reporter macro with the Тypes parameter set to page.
Within the Content Reporter macro, create a Text Filter macro with the following parameters:
- Set the Key prameter to data:project.
- Select the Required checkbox.
Within the Content Reporter macro, under the Text Filter macro, create a Text Sort macro and set the Key parameter to content:title.
Within the Report Table macro, under the Content Reporter macro, create two Report Column macros with Title parameters set to Project Name and Status.
Within the Project Name Report Column macro, create a Report Info macro with the following parameter:
- Set the Key parameter to content:title.
- Select the Link To Item checkbox.
Within the Status Report Column macro, create a Report Block macro with the Maximum Result and First result parameters to 1.
Within the Report Block macro, create a Local Reporter macro and set the Key parameter to data:project.
Within the Local Reporter macro, create a Text Filter macro with the following parameters:
- Set the Key parameter to data:Status.
- Set the Exact Value parameter to In Progress.
Within Report Block macro, under the Local Reporter macro, create a Report Body macro.
Within the Report Body, insert a Status macro with Title set to In Progress and Color set to Yellow.
Within the Report Block macro, under the Report Body macro, create a Report Empty macro.
Within the Report Empty macro, create a Report Block macro with Maximum Result and First result parameters set to 1.
Within the Report Block macro, create a Local Reporter macro and set the Key parameter to data:project.
Within the Local Reporter macro, create a Text Filter macro with the following parameters:
- Set the Key parameter to data:Status.
- Set the Exact Value parameter to Done.
Within the Report Block macro, under the Local Reporter macro, create a Report Body macro.
Within the Report Body, insert a Status macro with Title set to Done and Color set to Green.