Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
maxLevel2
minLevel2
absoluteUrltrue
excludeSee also
typeflat
separatorpipe

Overview

The Document Stats Report is used to display macro displays a count of the content currently in each workflow state.

...

by default, the workflow information in the reporting columns will by default include report columns includes all the workflow states in the current space (except for the space homepage).

One or more filters can be added to the document-stats-report macro, for example, to filter the display to specific states or the states in one or more workflows.

Once added to a page, the report macro will dynamically update updates the count of the statesfor each state.

Permissions

Anyone can see this report.

View-only users will only  only see results for content that has reached a Published (final=true) state, even if there are subsequent draft state edits to that content. Content that has pager or blog post. Pages and blog posts that have not yet been published, or content under a that have an applied workflow that does not define a published state, will are not be shown.

Admins can make all results available to everyone by changing the Workflow Activity and Drafts Visibilitysettingsettings globally for the instance or in each space.

Adding the report

To add the report to a page choose the Document Stats Report macro.

...

  • choose Insert  → Other Macros → Reporting → Document Stats Report

  • or type {document stats ...  on the page and select Document Stats Report

    Image Removed

...

  • choose  Edit the report macro

    Image Removed

...

In the macro editor

  • choose report filters and display column settings

    Image RemovedImage AddedImage Added
      Image Removed
      • if necessary, scroll down the macro editor to add/edit report filter options

    ...

    • choose Save to update the macro on the draft page

    • choose Update to add the report to the published page


    Here's how the report looks on your page.

    ...

    If multiple labels are added the report will display displays the state information for content with each label. If you wish to display information for content that must have all the specified labels, add the & (and ampersand) operator in front of the first label in the list

    The macro can be also be customized for

    • one or more states

    • one or workflows

    ...

    The filters are listed alphabetically in the macro editor.

    Setting

    Default

    Notes

    Label

    none

    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 page

    blank (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

    If specifying a parent page you cannot list multiple space keys. The report

    will default

    defaults to the child pages of the added parent page.

    In space

    blank (current space)

    The comma-separated list of space keys to filter.

    If multiple spaces are specified, the table

    will count

    counts all content states.

    States(s)

    blank (all states)

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

    • leave empty to include all content in all states

    • limit report by listing one or more state names in a comma-separated list

    • states displayed in the report are listed in the order added to the macro (only from v6.16.4+)

    The report

    will include

    includes 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

    (info) If

    If left empty the report

    will display

    displays all a report for states in both space and page workflows in the scope of the report. However, you can only specify space workflow names. There is no option to

    specify

    use a page workflow name.

    If left empty then the report

    will include

    includes the state count for content where the workflow has been removed but the workflow history has been retained

    Reporting columns
    Anchor
    docstatesmacroreportcolumns
    docstatesmacroreportcolumns

    The on the page, the column display order on the page is defined by the order of entry of the state name column in the macro editor.

    ...

    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 Stats Report macro is displayed in the chart

    • in the Chart macro Columns setting add the number 0 (zero)

    Next

    • 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 EditingApprovedPublished, In Progress, in the macro editor for the Confluence Chart macro add the following to the Columns dialog box

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

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

    ...

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

    ...