Reporting Plugin

Provides the ability for powerful and flexible reporting on data from Confluence, Scaffolding and other sources.

Details

This plugin contains macros which allow powerful and flexible reporting on Confluence content and content from other locations.

Overview

Bugs & Feature Requests

Bug reports and feature requests are available in JIRA.

Release History

You can view the full release history here.

This plugin doesn't create or save any data in and of itself - it is intended to display data collected elsewhere in a consistent and flexible manner.
All reports consist of two basic components:

1. The data being reported on (Confluence content, users, etc.)
2. The report format being generated (table, list or ad-hoc)

The basic structure is the same with all reports. You will have a report generator macro which contains a reporter macro, as well as other macros which define how the report will look. A generic structure is below:

{report-xxx}

{xxx-reporter}
  {xxx-sort}
  {xxx-filter}
{xxx-reporter}

{report-header}Displayed once, before individual results{report-header}

{xxx-filter}
{yyy-filter}
{report-body/column}Content for each item goes here, typically using {report-info} or other macros which will be executed on the current page. Use 'body' for {report-list} and {report-block} and multiple 'column's for {report-table}.{report-body/column}

{report-footer}Displayed once, after all reported items.{report-footer}

{report-empty}Displayed once if the report contains no items.{report-empty}

{report-xxx}

Some more concrete examples are listed in the Recipes tab.

To view the macro's documentation, click on its name below.

{boolean-filter}

This filter will ensure that the specified 'prefix:key' value matches the required true/false value. more info...

{boolean-sort}

This will sort the results by the specified boolean key value. more info...

{collection-filter}

Checks that any contained filter values exist on all/any/none of the items in the collection specified by the filter's "prefix:key" value. more info...

{combining-reporter}

This reporter combines the results of multiple sub-reporters into a single list. more info...

{content-filter}

This filter will ensure that the specified 'prefix:key' value matches the required Confluence content value. more info...

{content-reporter}

Reports on Confluence content (pages, news, comments, attachments, etc). more info...

{date-filter}

This filter will ensure that the specified 'prefix:key' value is a date, and that it matches the required criteria. more info...

{date-sort}

This will sort the results by the specified date key value. more info...

{expand-on}

This macro will tell the reporter to expand its list of items to include an item for each value in a sub-item, specified by the 'prefix:key' value. more info...

{expanding-reporter}

This is a reporter which can expand on a items returned from another, contained reporter. more info...

{grouping-reporter}

Allows results of another reporter to be grouped by any keychain value in each item. more info...

{grouping-stats}

Works with the grouping-reporter to generate basic statistics on grouped data. more info...

{local-reporter}

Allows reporting on the current page or reported item. more info...

{natural-sort}

Sorts based on the natural order of the specified key chain. more info...

{number-filter}

This filter will ensure that the specified 'prefix:key' value is a number, and that it matches the required criteria. more info...

{number-sort}

This will sort the results by the specified number key value. more info...

{repeat-filter}

This filter checks if the current value is different from the previous one in the report. more info...

{report-block}

This plugin will display the report results in a series of blocks. more info...

{report-body}

This macro contains the wiki code which will be executed for each item of the surrounding report. more info...

{report-column}

Displays a single column in a report-table. more info...

{report-empty}

This macro contains the wiki code which will be displayed if the surrounding report has no items. more info...

{report-footer}

This macro contains the wiki code which will be displayed after a non-empty report. more info...

{report-header}

This macro contains the wiki code which will be displayed before a non-empty report. more info...

{report-image}

Displays the specified key chain value for the current item as an image. more info...

{report-info}

This macro outputs specific information about an item being reported on. more info...

{report-link}

Displays the specified key value as a link. more info...

{report-list}

Displays the each of the items from a reporter as a list item. more info...

{report-on}

Sets the report item context to the item/key value specified. more info...

{report-table}

Displays the each of the items from a reporter in a table. more info...

{report-variable}

Defines a temporary variable that can hold data in the current report context. more info...

{space-reporter}

Reports on Confluence Spaces. more info...

{text-filter}

This filter will ensure that the specified 'prefix:key' value matches the required text value. more info...

{text-sort}

This will sort the results by the specified text key value. more info...

{user-filter}

Filters out results based on a user property. more info...

{user-group-reporter}

Reports on the available user groups in Confluence. more info...

{user-reporter}

Reports on Confluence users matching the specified criteria. more info...

Note Suppliers provide information which can be used by the Reporting Plugin and Linking Plugin, among others. Below is the list of suppliers provided by this plugin. Other plugins may also provide their own Suppliers - see the complete list for details.

Attachment Supplier

Supplies information about attachments in Confluence. more info...

Boolean Supplier

Allows some simple post-processing on boolean values. more info...

Class Supplier

Provides information about object classes. more info...

Collection Supplier

Provides information about collections of items. more info...

Comment Supplier

Supplies information about comments attached to Pages or News Items in Confluence. more info...

Content Supplier

Supplies information about Confluence content, such as pages, news items, attachments and comments. more info...

Date Supplier

Provides information about dates. more info...

Debug Supplier

Provides access to various objects useful for debugging. more info...

Email Supplier

Supplies information about email addresses. more info...

Expanded Supplier

This provides access to the 'expanded' object created by the expand-on and expanding-reporter macros. more info...

Global Supplier

This supplier can be used from any context, and provides information about global values, such as the current user, the date/time, etc. more info...

Grouped Supplier

Provides access to the results of the {grouping-reporter}. more info...

Label Supplier

Provides information about Confluence content labels. more info...

Link Supplier

Provides information about links coming from Confluence content. more info...

Mail Supplier

Supplies information about archived email files stored in Confluence. more info...

Map Entry Supplier

Provides access to the key and value of a specific map entry. more info...

Map Supplier

Provides information about 'Map' collections, which are collections of information with a key/value relationship. more info...

Match Supplier

This provides access to match values using regular expressions. more info...

News Supplier

Supplies information about news items (a.k.a blog posts) in Confluence. more info...

Number Supplier

Provides information about numbers. more info...

Object Supplier

Provides general information about any object. more info...

Page Supplier

Supplies information about Confluence pages. more info...

Report Supplier

Provides access to information about the current report. more info...

Request Supplier

Provides access to the headers and parameters passed in the HTTP request for the current context. more info...

Session Supplier

Provides access to the HTTP Session context. more info...

Space Supplier

This supplier provides key values for Confluence Spaces. more info...

Stats On Supplier

Performs basic statistical analysis on values in a Collection of items. more info...

Stats Supplier

Provides access to calculated statistics on a set of data. more info...

Text Supplier

Provides information about text values. more info...

User Group Supplier

Provides information about user groups. more info...

User Supplier

Provides information about Confluence Users. more info...

Value Supplier

Finds or creates specific values for use with keychains. more info...

Variable Supplier

Retrieves variables set with the report-variable macro in the current context. more info...

Below are listed some recipes which make use of this plugin. They are often good examples of how it can be used in real-world situations.

Aggregate news report recipe

Display news items from across multiple spaces. more info...

Attachment List Recipe

A custom table of the attachments on a page. more info...

Redirecting Page List

This recipe generates a list of pages which redirect to other pages, and provides a non-redirecting link to that page, as well as direct links to edit or delete the page. more info...

Space Labels Recipe

Display a list of all labels in each space, and the content with each label. more info...

Space list recipe

Display a list of spaces available in a custom format using the Reporting Plugin. more info...

User contact cards

Display user contact details using a contact card-style layout. more info...

Validate External Links For A Space

This recipe generates a list of outgoing links in all pages and news within a given space, using the link validator plugin to check if each link is valid. more info...