The Page Properties Report macro presents a tabulated summary of metadata that has been embedded, using the Page Properties macro,  on any page or blog post in the current Confluence space. The Page Properties Report macro collects metadata from only those pages or blog posts that have a specific label.

The left-hand column of the report shows the name of the page that contains the metadata. Each page name is presented on a single row with a link to the page.

The other columns in the report represent the fields (keys) defined in the Page Properties macros. You can sort the table by choosing the column headers.

This macro was previously known as the Details Summary macro.

On this page:

Related pages:

Basic usage of Page Properties and Page Properties Report macros

The Page Properties macro is used in conjunction with the Page Properties Report macro.  

To use the macros:

  1. Add the Page Properties macro to your page and specify a label (for example, Status).

  2. Add a two column table in the body of the macro placeholder for your metadata keys and values.

  3. Repeat this process to add the Page Properties macro to other pages.
  4. Create a new page to contain your report (for example, Status Report).
  5. Add the Page Properties Report macro and specify the same label (for example, Status). 
  6. View your new status report page. The data contained in your Page Properties macros display in the report.

    Screenshot: example 'Status' report 

     
  7. Choose a column heading to sort the report. 

When you insert the Page Properties macro on a page Confluence automatically adds the label to the page. The Page Properties Report macro will only display information from one Page Properties macro per page.

Using the Page Properties Report macro

  1. Add the Page Properties Report macro to the page:

    1. In the Confluence editor, choose Insert > Other Macros.
    2. Find and select the required macro.

    Speeding up macro entry with autocomplete:

    Type { and the beginning of the macro name, to see a list of suggested macros. Details are in Using Autocomplete.

    To edit an existing macro: Click the macro placeholder and choose Edit. A macro dialog window will open, where you can edit the parameters of the macro.

     

  2. Add a label to the macro, using the macro parameters.
    In the macro browser, specify a Label. For example, 'Status'.
    Screenshot: Page Properties Report macro with label specified

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.

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 headingTitleThe 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 display30Number of items to display in the table before displaying pagination options for additional items.
Sort byLast 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 CountNoDisplays the number of comments for each page in the table.
Show Likes CountNoDisplays the number of likes for each page in the table.

Examples

The following examples outline how you can use the Page Properties and Page Properties Report macros together. 

The following examples outline how you can use the Page Properties and Page Properties Report macros together to create a Status Report or a Risk Report. 

In this example we wish to create a Status Report page that displays project status metadata from a number of pages.

The label in this example is 'status'

The keys in this example are:

  • Deadline
  • Project Status
  • Team.

The values for each key are:

  • Deadline: 1 June, 15 November and so on.
  • Project status:  Not started, In progress, Complete.
  • Team: Purple Monkeys, Green Parrots.

The Page Properties macro on each page looks like this:

Screenshot: two examples of the Page Properties macro from different pages showing values for each key.

   

The label keys are the same on each page. The values are different.

The Page Properties Report macro on the Status Report page looks like this:

Screenshot: Page Properties Report macro with the label 'Status'

The final Status Report page looks like this, with a row for each page: 

Screenshot: Example of the Page Properties Report macro showing data

You could also use the Status Macro within the Page Properties macro, to provide a visual indication of status.

Want to see this example in action? The following pages were created in this documentation space to create this example.

In this example we wish to create a Risk Report page that displays project risk metadata from a number of pages.

The label in this example is 'risk'

The keys in this example are:

  • Impact
  • Risk Level.

The values for each key are:

  • Impact: critical, high, medium, low
  • Risk Level:  major, minor, trivial.

The Page Properties macro on each page looks like this:

Screenshot: example of the Page Properties macro from one page.

The Page Properties Report macro on the Risk Report page looks like this:

Screenshot: Page Properties Report macro with the label 'Risk'

The final Risk Report page looks like this, with a row for each page: 

Screenshot: Example of the Page Properties Report macro showing data

Want to see this example in action? The following pages were created in this documentation space to create this example.

Code examples

See:

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.