attachments-report macro

Overview

The attachments-report macro generates a report of all the attachments on a single page.

Parameters

Parameter

Required

Default

Notes

Version

Parameter

Required

Default

Notes

Version

value-name



The list of fields (columns) as a comma-separated list to be included in the report. This can include added metadata and internal metadata.



sort





Specifies which column in the report should be sorted by. You can include sort method such as

  • value-name desc

  • value-name desc

You can also specify how to treat the values:

  • as date (for internal date field) metadata only

  • as number

  • as string (makes sort case insensitive)



maxResults



500

Specifies the number of results to be returned.

 

Usage

To retrieve the metadata from matching attachments on the current page, choose the Page Attachments Report using the Confluence macro browser:

The macro requires the metadata for the report to be entered to the macro editor.

There are no additional options to add to the macro in the macro placeholder.

The macro displays the metadata values for the attachments on the current page in a tabular format.

The number of results (default 500) can be added to the macro editor. If required, the display of the results can be sorted on a selected column.

Reference Markup

{attachments-report:Title,Author(s),Comments,Time Created|sort=Title desc|maxResults=5}