Introduction

...

Macros used in the "reporters" and the report body generally makes use of SUP Suppliers for Reporting to retrieve information.

Given a Key, a specified supplier will return an object. A supplier is referenced by its Prefix.

...

The report body will also use the suppliers to retrieve more detailed information. In the above example, the reporter has pulled in a list of Page objects into the report. These objects can now have their values accessed by either the Page or Content Suppliers in the body.

For example, the Content Supplier is used (with the Prefix content and title as the Key) to extract the title of the pages in the first screenshot.

...

Always keep note of the type of object your report is returning. This is of immense help when trying to understand which Suppliers to use both in your report and in your Key-value chains. There is a supplier for every return type, even text, and lists.

The Supplier documentation will provide you with the return type of every Key and the link to its supplier documentation.

The Content Supplier can be used with all Confluence data types e.g., pages, blog posts, attachments, and comments. It provides common information about any of these objects. To get more type-specific information you will need to use the specific supplier.

...

Keychains are linked chains of prefix:key values. They are linked using the character ">". For more information on how to use these, see Supplier Keychains.

Injection

Parameter injection is supported by some report body macros and allows you to "inject" values from a supplier as a parameter into a macro. For more information on how to use this feature, see Parameter Injection.

Other Reports

It is possible in certain contexts and with certain outcomes to create "shortcut" reports that don't require the full structure of a report. For example, Report Info could be used directly outside of a report to provide information on the current page.

...

Report On can also be used similarly to expand on an object available on the current page.

Using Reporting in Conjunction with Scaffolding

The Scaffolding add-on provides a Scaffold Supplier which allows the Reporting Plugin to access data from Scaffold fields. This combination of features has been used in many ways by users, not least in the following:

...