Skip to end of metadata
Go to start of metadata


    This documentation relates to an older version of the Reporting Plugin for Confluence (3.x and below)
    If you are using a later version of Confluence please refer to the documentation for the latest Reporting Plugin

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

    Details

    Overview

    Bugs & Feature Requests

    Bug reports and feature requests are available in JIRA.

    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.

    and-filter

    more info...

    boolean-filter

    more info...

    boolean-sort

    more info...

    collection-filter

    more info...

    combining-reporter

    more info...

    content-filter

    more info...

    content-reporter

    more info...

    date-filter

    more info...

    date-sort

    more info...

    expanding-reporter

    more info...

    grouping-reporter

    more info...

    grouping-stats

    more info...

    local-reporter

    more info...

    natural-sort

    more info...

    number-filter

    more info...

    number-sort

    more info...

    or-filter

    more info...

    repeat-filter

    more info...

    report-block

    more info...

    report-body

    more info...

    report-column

    more info...

    report-empty

    more info...

    report-eval

    more info...

    more info...

    report-header

    more info...

    report-image

    more info...

    report-info

    more info...

    more info...

    report-list

    more info...

    report-on

    more info...

    report-table

    more info...

    report-variable

    more info...

    space-reporter

    more info...

    text-filter

    more info...

    text-sort

    more info...

    user-filter

    more info...

    user-group-reporter

    more info...

    user-reporter

    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.

    Space list recipe

    more info...

    Note: By downloading the product below, you agree to CustomWare's product license agreement.

    For information on installing the plugins once you've downloaded them, see these [instructions|Installing Commercial Confluence Plugins]. For plugins compatible with pre-Confluence 4.x see these [instructions|Installation Instructions].

    Confluence 4.0+

    Confluence 4.0

    Confluence 3.1+

    Confluence 3.1-3.2

    Confluence 3.0+

    Confluence 2.8+

    Confluence 2.7

    Confluence 2.3-2.5

    Confluence 2.2