Document activity macro

Owned by Robert Alexander Marshall
Last updated: Jan 12, 2024
3 min read

Overview

A document activity macro can be added to a document (page or blog post) to display information for the document activity for the workflow on a page.

The document activity macro information for the lifecycle of the workflow events on the document is shown as a table with the following columns

  • User

  • Activity

  • State

  • Comments

  • Date

  • Version

The macro can be configured to show the number of document activity entries displayed.

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 approval macro option.

Choose Document Activity to add the macro to the draft page.

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.

The macro can be configured to display a maximum number of document activity entries for the document up to 100.

If there are more entries than the set number to display or the maximum limit of 100, the macro will display the defined limit of entries and display a link to the document activity report on the document.

Configuring the macro

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.

On the page or blog post, the document activity for the current document will be displayed.

  • if no workflow is currently applied or there is no document activity the following is displayed

“ Document does not have a workflow applied.”

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.

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