Versions Compared

Key

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

In development - release Q2 2023

Table of Contents
maxLevel2
minLevel2
absoluteUrltrue
typeflat
separatorpipe
Excerpt
hiddentrue
namerefinedpageimage
Image Added

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. <Add Screenshot>

...

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

...

Adding the macro to a page

Edit the page and type /doc and select the document approval macro option.<add macro select screenshot>

...

Choose Document Activity to add the macro to the draft page.<add draft page macro screenshotBy default the macro displays the current workflow state name and the approvals in the state.

Select the macro and choose the pencil icon to open the macro editor.

Configuring the macro

...

Default number of entries displayed by the macro is 25, the maximum is 100 entries.

Info

The macro can be configured to display a

...

maximum number of document activity entries for the document

...

<add screenshot>

...

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 a list of defined limit of entries and display a link to the document activity workflow events for report on the document.<add screenshot>

...

Add the number of document activity entries to be displayed using the macro editor

>macro editor screenshot>

...

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 if no workflow is currently applied or there is no document activity the following is displayed

(info) Document does not have a workflow applied.” <screenshot required>

  • If there are more entries than the maximum limit, the macro will display the defined limit of entries and display the following

(info) Showing most recent entries. There are more records in the Document Activity.” <screenshot required>

Use with other macros

Tip

The document activity macro is compatible with the Confluence Page Properties macro and the Page Properties Report macro.

On the draft page, add the document activity macro as a table value in the page properties macro.<page properties example screenshot>

...

Tip

Document activity macro can be added to more than one row for the report, each macro configured to display different document activity information

The page properties report macro can then be added to a page to report on the added values.<page properties example screenshot>

...

Exporting pages to pdf and Word

The document activity macro table of information is included when exporting to pdf or Word.<export to pdf example screenshot>

...

  • user avatars are not included in the pdf or Word export

  • links are included to the Confluence version related to each document activity entry

In the pdf and Word export the date is in UTC format.

...

.