In this page

What is a Confluence macro?

Macros are useful for generating dynamic content on Confluence pages and blog posts. Macros can extend Confluence capabilities in many ways, like generating content lists or embedding external content, for example.

This page details the Content Status List macro that integrates with the content lifecycle management functionality offered by the Better Content Archiving app.

The Content Status List macro

The Content Status List macro renders a list of the contents that match the passed CQL query parameter. Use it to generate content lists with the content status and other fields specific to the Better Content Archiving app. See the content list documentation for general usage.

The use cases for this macro are endless due to the flexibility of CQL. (Tip: you can build content status dashboard pages by adding multiple instances of this macro with different CQLs.)

Configuration

When adding a macro to a page or blog, do the following:

  1. Start editing a Confluence page.
  2. Click "Insert" in the toolbar, then "View more", enter "Content Status List" to the search box and insert the macro. (Or just type /Content Status List and select the macro.)
  3. Click "Edit" on the macro toolbar.
  4. Configure the macro options under CQL, Columns, and Settings as needed (see below).
  5. Save the changes.
CQL

Here, enter the CQL query to run when populating the content list. This query determines the set of contents that will be shown. The query only returns contents the current viewer is allowed to see.

Columns

Here, you can configure the columns you want to see in the macro's content list. This is identical to how you can set the visible columns in the content list in general.

Settings

These additional options drive the subtle behavior of the macro's content list. You have the following options:

  1. Open links in new browser tab: when checked, space and content links will open in a new tab.
  2. Show filter bar: when checked, the macro's content list can be filtered as other content lists.
  3. Show excluded contents: when checked, the macro also shows contents in excluded spaces.

Example

For example, to display the list of expired pages:

  1. Start editing a Confluence page.
  2. Click "Insert" in the toolbar, then "View more", enter "${macroName}" to the search box and insert the macro. (Or just type /Content Status List and select the macro.)
  3. Click "Edit" on the macro toolbar.
  4. Enter the CQL: 
    type = page and arch.status = "Expired"
  5. Save the changes.

Questions?

Ask us any time.