This site has moved to the integrated Appfire documentation and information site for our apps.
From February 2024 this site is no longer updated.
Take a look here! If you have any questions please email support@appfire.com
Document Stats Report Macro
- Robert Alexander Marshall
Overview
The Document Stats Report is used to display a count of the content currently in each workflow state.
This workflow information in the reporting columns will by default include 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 the count of the states.
Permissions
Anyone can see this report.
view-only users will only see results for content that has reached a Published (
final=true) state, even if there are subsequent draft state edits to that contentcontent that has not yet been published, or content under a workflow that does not define a published state, will not be shown
Adding the report
To add the report to a page choose the Document Stats Report macro.
On the draft page
choose Insert → Other Macros → Reporting → Document Stats Report
Or
type {doc stats ... on the page
select Document Stats Report (or open the macro browser to search)
select the macro
choose Edit
choose report filters and display column settings
if necessary, scroll down the macro editor to add/edit report filter options
by default, the report displays a count for all workflow states including those where no content is currently in the state
choose Save to update the macro on the draft page
choose Update to add the report to the page
Here's how the report looks on your page.
Customizing the report
Edit the Document Stats report macro to customize the report by
You can choose to filter the state count for the content by
label(s)
parent
space(s) using the space key
If multiple labels are added the report will display 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 column display order on the page is defined by the order of entry of the state name column in the macro editor.
Filter the report
In the macro editor select options to filter the report. These include options to filter by state, workflow, space key, label, parent page(see table below).
If a workflow has been removed from content that is in the scope of the report macro, but the history has been retained, the report will show the last state information for the content.
The filters are listed alphabetically in the macro editor.
Setting | Default | Notes |
|---|---|---|
Label | blank | Should the report be filtered by content label(s)?
If using a list of labels, you can prefix the list with |
Parent page | blank | Report limited to child pages of specified page.
|
Spaces | blank | Which space should be included in the report?
If a parent page is added you cannot specify more than one spacekey. |
State(s) | blank | The count for all the states in the scope of the macro editor settings are displayed.
The report will include the state count for content where the workflow has been removed but the workflow history has been retained |
Workflow | blank | A comma-separated list of workflows to be displayed.
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 |
Use with Confluence chart macro
The document stats report macro can be added to the Confluence chart macro to display the report information.
The Confluence chart macro display is based on the document-stats-report macro filters.