Report Table

Owned by
Nirosan
Last updated: Jan 05, 2024 by
Elena Amandola (Deactivated)
2 min read

Description

There is a Confluence bug that does not allow you to sort columns when combining Report Table and Date Supplier. Check the Notes section for the workaround.

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

A report table must contain two things:

  1. A reporter macro (such as Content Reporter or User Reporter), which finds the list of items to report on.

AND

  1. One or more Report Column must be present to define what data is displayed.

It may also optionally include a Report Empty macro, which specifies what will be displayed if no items are returned from the reporter.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

Name

Required

Migratable to Cloud?

Default Value

Description

maxResults

 

  • (X)

 

 

  • NO

 

100

The maximum number of results to display.

firstResult

 

  • (X)

 

 

  • NO

 

1

(Since 2.0.0) Specify the number of the first result to start displaying in the report. The first item has a number of 1.

depth

 

  • (X)

 

 

  • NO

 

0

If the item has children, the depth do display its descendants. May be all for all descendants, or a whole number value above 0. (Since Reporting 1.3)

injected

 

  • (X)

 

 

  • NO

 

false

If set to true, the column bodies will have any '%prefix:keychain%' values injected with values from the current report item prior to being rendered.

 

  • It is a good practice to set the Injection to true at on {report header}, {report body}, {report footer}, or {report column}, instead on the highest level of the report.

class (CSS Class)

 

  • (X)

 

 

  • NO

 

 

The CSS class to render the table with.

displayTitles

 

  • (X)

 

 

  • NO

 

true

If set to false, the title header row will not be displayed. (Since Reporting 1.0.1)

Editor View

 

Notes

  • When using the Date Supplier, the [date format] key has to be formatted to not break the sorting functionality. Set the following:

    • content:modification date → content:modification date > date:"yy-MM-dd HH:mm:ss"

    • The formatting above excludes milliseconds that allow the sorting to work.

Tutorial Examples