Page Properties Report Macro

The Page Properties and Page Properties Report macro work together to enable you to show summary information from one page on a another page. You can see examples of these two macros in action on the Decision and Product Requirements blueprints.  

This macro was previously known as the Details Summary macro. 

Adding the Page Properties Report macro to a page

To add the Page Properties Report macro to a page:

  1. In the editor, choose Insert > Other Macros > Page Properties Report.
  2. Enter the Label you want to report on - this is the label added to pages containing the Page Properties macro.
  3. Restrict the report by ID, space or specify column headings or sort order - see the Parameters table below for more details. 
  4. Choose Insert.

Note: If your report is empty, check:

  • You have specified the label correctly and the label appears on pages containing the Page Properties macros.
  • The Page Properties macros on each page are configured correctly. 

Screenshot: Page Properties Report

Reporting on specific Page Properties macros

You can add multiple Page Properties macros on a page, and choose whether to include all or only specific macros in the report.  The Page Properties macro includes an optional ID parameter that can be used to identify specific Page Properties macros.

To show the contents of: 

  • All Page Properties macros in the report - specify just the label for the page.
  • Selected Page Properties macros in the report - specify both the label for the page and the ID of the particular Page Properties macro. 

Note: The Page Properties Report macro can only accept one page label, and one ID.  

Parameters

Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Label

(None)

Identifies the label to be used in the Page Properties Report. The report will show data from all pages in the current space containing a Page Properties macro with the same label.

Page Properties ID (None)

If not specified, the report will show data from all Page Properties macros on a page, where there are multiple macros. Specify an ID to include only data from Page Properties macros with the same ID.

Restrict to spaces (None)

If not specified, the report will only show data from the current space. You can specify a comma separated list of space keys, or use @all to show data from all spaces.

Title column heading Title The heading to display on the first column in the report table. This column contains links to pages displayed by the report. The default column heading is 'Title'.
Columns to show (None)

If not specified, the report will show all columns. You can specify a comma separated list of columns to include.

If your column heading includes commas, use double quotes around the column name. If your column heading includes quotes, use double quotes. For example, A column, "My ""new"" column, yes", Third column

Number of items to display 30 Number of items to display in the table before displaying pagination options for additional items.
Sort by Last modified date

Sort the table by a specific column heading. Enter the column name, exactly as it appears in the corresponding Page Properties macro.

Select the Reverse Sort check box to sort the table in reverse order.

Show Comments Count No Displays the number of comments for each page in the table.
Show Likes Count No Displays the number of likes for each page in the table.

Code examples

The following examples are provided for advanced users who want to inspect or edit the underlying markup for a Confluence page. 

Macro name: detailssummary

Macro body: None.

Storage format example

  <ac:structured-macro ac:name="detailssummary">
    <ac:parameter ac:name="id">status-dev</ac:parameter>
    <ac:parameter ac:name="sortBy">Created</ac:parameter>
    <ac:parameter ac:name="label">status</ac:parameter>
  </ac:structured-macro>

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport