Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Live template
templateMacro Reference Live Template v2
typetemplate

Tutorial Examples

...

All page states within a space

...

All pages with the 'Approved' state in the last month

...

Building a Forum in Confluence with Reporting

...

Calculating Elapsed Time

...

Calculating Work Hours in a Day

...

Chaining Keys with Keychains

...

Create customized links with Scaffolding's Content Options macro

...

Creating an IF ELSE statement with Reporting

...

Customizing a Report with Image Attachments

...

Displaying a List of Children for a Page with Customized Details

...

Displaying a list of images attached to the current page

...

Displaying a List of Only Grandchildren Pages

...

Extract values from page titles using regex

...

Extract values from page titles using Reporting Text Supplier

...

Extracting Scaffolding Data from Children Pages

...

Extracting Scaffolding Data from children pages and modifying values using Reporting macro

...

Filter page results based on user

...

Generating a List of Groups for the Current User

...

Generating a List of Pages with No Label

...

Description

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

When used in a report, it will report on the current item. When used outside a report, it will report on the current page by default, or the content referred to by the source parameter.

It can handle regular text, dates, numbers, booleans (true/false), and lists, as well as any other object which has a default value specified in a Supplier.

Parameters

Name

Required

Migratable to Cloud?

Default Value

Description

key/[default]

  • Status
    title(/)

  • Status
    titleNO

The key chain to retrieve for the item.

A key chain is a list of prefix:key values separated by ">" characters.

e.g.:content:creator > user:name See the Suppliers for Reporting page for more details on what options are available. 

link

  • Status
    title(X)

  • Status
    titleNO

false

If set to true and the current item/key has a URL link, the text generated will be linked to that URL.

source

  • Status
    title(X)

  • Status
    titleNO

The source to retrieve information for.

By default, this will be the current report item if in a report, or the current page if not in a report.

May be "@self" (the current page) or a link to other content (e.g.: "SPACEKEY:Page Name", "PageName^attachment.ext").

format

  • Status
    title(X)

  • Status
    titleNO

The date (eg. 'dd MMM, yyyy') or number (eg. '#,##0.00') format to display the item in.

This will only be used if the data is a date or a number, respectively. Otherwise, it will be ignored.

render

  • Status
    title(X)

  • Status
    titleNO

none

If set to wiki, the generated text will be rendered as wiki text. Otherwise, it will be output as written.

info (Hover Text)

  • Status
    title(X)

  • Status
    titleNO

(Since 3.4.0) The text which will be displayed when the user hovers their mouse over the link. 

separator

  • Status
    title(X)

  • Status
    titleNO

comma

The type of separator to display between each item, if the key value pointed to is a collection of other items. May be one of the following: 

  • bracket - Square brackets ('[', ']') surrounding each item.

  • brace - Braces ('{', '}') surrounding each item.

  • comma - A comma (',') between each item.

  • paren - Parentheses ('(', ')') surrounding each item.

  • pipe - A pipe ('|') between each item.

  • newline - A line break after each item.

  • "custom" - Any other character you wish, specified between quotes.

default

  • Status
    title(X)

  • Status
    titleNO

The contents of this parameter will be used if the item/key is empty. It will be rendered as wiki text.

Alternately, the body of the macro can also be used, if more complex wiki text is required.

Editor View

  • Not applicable.

Macro Edit View

  • Not applicable.

Notes

  • Not applicable.

Tutorial Examples

Filter by label (Content by label)
showLabelsfalse
showSpacefalse
excerptTypesimple
cqllabel = "report-info"