Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Provides access to information about the current report.

Info

Inside any report, this supplier

...

gives access to the content (page/news item/etc) and other information about the currently reported item.

Details

Name:

Report Supplier

Prefix:

report(required)

Supported Content:

No content required, but must be within a report.

Provided By:

Reporting

, from version 1

Status
colourBlue
titleFROM v1.3

Supported Keys

The following are the list List of keys which that this supplier will return returns a value for.

Key

Content Types

Return Type

Description

item

Anything

The item currently being reported on.

Info

Could be

anything

any data type or format, dependent on source.

item number

Number

The number of the current item in the set of items being reported on.

For example, the

Info

The first item in a report will have the number '1'.

item outline [X]

Text

Provides a numeric "outline" of nesting for the reported item using the provided separator parameter

which

that is “.” by default.

Info

If the current report is embedded within an outer report

, it will have

  • the pattern is "X.X" (

e.g.:
  • for example "1.2", "2.5", etc

.
  • )

.

current content

Content

The current content being reported on.

Info

If the item being reported on is not a page, news item or similar

(e.g.:

, for example, a user, a group or other object type), the content

will be

is inherited

  • from any parent reporters

,
  • or from the root content object if none are present

.

root content

Content

The content (page, news item, etc)

which

that contains the top-level report in this HTTP request.

parent

Report

The parent report object, if one exists.

query

Query

(Since 3.3.0) The

The query being executed in the current report.

Status
colourBlue
titleFrom v3.3.0

Examples

Auto-numbered Rows

Displays the row/item number of the report in a column.

...