The Page Properties macro enables you to embed data on a page and then display that data in tabular form on another page . You can put the Page Properties macro on as many pages as you like and use the Page Properties Report macro to display the collected data on one page. You can also choose to hide the metadata on the pages that contain the Page Properties macro.

This macro was previously known as the Metadata Details macro.

Basic usage of the 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. You can add more than one Page Properties macro to the page, but they will inherit the same label (e.g. you cannot have two Page Properties macros with different  labels on the same page). 

Using the Page Properties macro

  1. Add the Page Properties 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, add a Label. For example, "Status".
      
  3. Add metadata keys and values as rows in a table, in the body of the macro placeholder. 
    In the macro body add a two column table and remove the header row. In the left column specify the keys (these will be the column headings in your report. You cannot format this text). In the right column specify the values for each key.

    Screenshot: The macro placeholder in the Confluence editor

Parameters

Parameters are options that you can set to control the content or format of the macro output.

Parameter

Default

Description

Label

(None)

The label used to identify the metadata on this page. Confluence will add this label to the page. Any additional Page Properties macros will inherit this label.
HiddenFalseDetermines whether the data in the Page Properties macro will be displayed on the current page. This setting does not affect the display of the detail in the Page Properties Report macro.

Examples

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. 

Example 1 - Status 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.

Example 2 - Risk Report

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:

Notes

  • If you add a label to the parameter in the Page Properties macro, Confluence adds the label to the page.
    • If you remove the label from the Page Properties macro, the label remains on the page.
    • If you remove the label from the page but leave it in the Page Properties macro, Confluence puts the label back onto the page.  
  • You can add many Page Properties macros per page, however all Page Properties macros on the page will have the same labels applied to them.  For example, if you add two Page Properties macros on a page, one with the label "risk" and the other with the label "status", both sets of metadata will appear in the Page Properties Report macro for the "status" label and for the "risk: label. This is true even if you have specified just one label in each Page Properties macro. It is the labels on the page that matter, not the labels in the macros.
  • You cannot use text formatting or macros in the left column as the data in this column is used to populate the column headings in your Page Properties Report macro. 
  • If your table has a header row, this row will be ignored by the Page Properties Report macro. You should remove the header row.
  • It is not possible to reference the metadata using the metadata key from within the page, or anywhere else on a Confluence page.

Other metadata macros

There are other metadata macros, which are not supported or documented on this page but which are worth mentioning: