Versions Compared

Key

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

...

Setting

Default

Notes

Labelnone

Should the report be filtered by content label(s)?

  • leave empty to include all content
  • list one label name to filter to specific label
  • list multiple label names, separated by commas, to filter to content with any of those labels

If using a list of labels, you can prefix the list with  &  (ampersand) to require that content has all the labels. Otherwise, it will report pages containing any of the listed labels.

Parent pageblank (current space home page)

Report limited to child pages only of the space home page or specified page.

  • leave empty to include all content in the space (does not include the home page as this is the default parent)
  • use @self to  report on the child pages of the current page
  • specify a page title to include only its child pages

(warning) If specifying a parent page you cannot list multiple space keys. The report will default to the child pages of the added parent page.

In spaceblank (current space)

The comma-separated list of space keys to filter.

If multiple spaces are specified, the table will count all content


States(s)blank (all states)

A comma-separated list of states to be displayed. The count for all the content in the states in the scope of the macro editor settings are displayed.

  • leave empty to include all content in all states
  • limit report by listing one or more state names in a comma-separated list

The report will include the state count for content where the workflow has been removed but the workflow history has been retained

Workflow(s)blank (all workflow states)

A comma-separated list of workflows to be displayed.

  • leave empty to include all content in all states in all workflows
  • limit report by listing one or more workflow titles in a comma-separated list

If left empty then the report will include the state count for content where the workflow has been removed but the workflow history has been retained

...

The document-stats-report macro can be added to the Confluence chart macro to display the report information.

The Confluence chart Chart macro display is based on the document-stats-report macro filters



Info

The Chart macro assumes the first column, 0, is a series name, but the Document Stats Report macro uses it for the first state.

To ensure that the information for the first state from the Document States Report macro is displayed in the chart

  • in the Chart macro Columns setting add the number 0 (zero)
  • then enter a comma-separated list of the states you want to display (the Document Stats Report column headings)

For example, to display the following four workflow states Editing, Approved, Published, In Progress, in the macro editor for the Confluence Chart macro add the following to Columns dialog box

  • "0, Editing, Approved, Published,  In Progress"

This will display a total of 4 columns or 4 pie segments.


Why are old states shown?

If the table shows states from old Comalatech workflows that are no longer used, purging the space trash should solve the problem (deleted pages in the trash retain their workflow information).