Document activity macro
- Robert Alexander Marshall
Overview
A document activity macro can be added to a document (page or blog post) to display information for the document activity for the approval workflow on a page.
The document activity macro information for the lifecycle of the approval workflow events on the document is shown as a table with the following columns
User
Activity
State
Comments (added for workflow approval events)
Date
Version
The macro can be configured to show the number of document activity entries displayed.
If there is more document activity for the page than displayed, the report display is appended with a note and a link to the document activity report on the page.
The document activity macro is only displayed on the page if a workflow is applied.
Adding the macro to a page
Edit the page and type /doc and select the document activity macro option.
Choose Document Activity to add the macro to the draft page.
By default the macro displays the User, the workflow Action, the current workflow State, any added user Comment for the activity, Date and the Version for each document activity.
The macro can be configured to display a maximum number of document activity entries for the document.
The default number of document activity entries displayed in the report is 25
A link to the document activity on the page or blog post is added to the report if there are more document activity entries than configured for display by the macro.
Configuring the macro
Select the macro and choose the pencil icon to open the macro editor.
Default number of entries displayed by the macro is 25, the maximum is 100 entries
If there are more entries than the maximum limit of 100, the macro will display the defined limit of entries and display the following
Showing most recent entries. There are more records in the Document Activity.
The macro can be configured to display one or more of the following for each document activity entry
User
Activity
State
Comments
Date
Version
You can add one or more document activity page macros to a page, each with a different configuration.
Use with other macros
On the draft page, add the document activity macro as a table value in the page properties macro.
The page properties report macro can then be added to a page to report on the added values for each page.
Exporting pages to pdf and Word
The document activity macro table of information is included when exporting to pdf or Word.
user avatars are not included in the pdf or Word export
links are included to the Confluence version related to each document activity entry