Document state macro
On this page:
Overview
When added to a Confluence page, the Document State macro displays information about the page’s current workflow state.
You can configure the macro to show one or more of the following:
The current workflow state
The date when the state was last changed
The state’s expiry date (if applicable)
Dates are shown in Confluence UTC format for both the state change date and the expiry date.
When no workflow is applied to the page, the document state macro displays the following message when editing the page and on the published page.
Add the macro
To add the document state macro,
Open your Confluence page and type /document state to display the document state macro option.
Select Document State to add the macro to the draft page.
Now, click the Edit icon on the macro to open the macro editor.
To configure the macro, check the boxes for one or more of the following options:
Show State – Displays the current workflow state.
Show Changed Date – Shows the date when the page transitioned to the current state.
Show Expiry Date – Displays the state’s expiry date, if one is set.
The selected options will be previewed in the macro on the draft page.
Publish the page to view the document state macro displayed in the page subtitle on the content.
Use the document state macro with other Confluence macros
The document state macro is compatible with the Confluence Page Properties macro and the Page Properties Report macro.
To use the macro,
Open a draft page and add the document state macro as a table value in the page properties macro.
The macro on the published page is rendered in a table.
The page properties report macro can be added to a page to report the value of the example page property we created - Comala Management App - State details.
Here’s a demo video that shows how to use the document state macro.
Exporting pages to PDF and Word
The Document State macro on-page information will be included when exporting the page to PDF or Word formats.
Page status (migration compatibility) macro
The page status macro displays the current workflow state.
The macro is added to a document migrated to the cloud, where the source server content includes the Comala Document Management for Server page status macro.
The page status macro is unavailable in the macro browser in a cloud site.
We recommend replacing the page status macro with the document state macro in your cloud content.
Need support? Create a request with our support team.