--- title: "Page Approval features" canonical: "https://support.appfire.com/space/PAFS/2213938564/Page%20Approval%20features" format: markdown --- > Macro (aura-html) # Overview **Page Approval** can be added to your documents in two ways: - [Page by page](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214953242): by inserting the **Page Approval macro** - [Across a space](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214920421): by enabling **Page Approval in Space Settings** You can configure Page Approval features in the **macro editor** (for individual pages) or in the [app space settings](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214854958) (for space-wide use). App [global settings](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214757481) can also be configured for the instance. # General features ## Approvals ![padc_onpage_unapproved_withregisteroption_abovepagecontent.png](media://fab451cc-e042-4947-893e-7c8246b59be1) Users can approve or unapprove pages, which sets a flag at the top of the page to indicate appropriately whether the page has been approved and by whom. If more than one user is registered, it is mandatory for all approvers to undertake the approval. ### Key features #### Anybody can register as an 'approver' of any page ![padc_onpage_unapproved_withregisteroption.png](media://ce39e39b-491b-4022-9c16-0682ac790c4c) - Assign yourself by clicking on **Register** ![padc_onpage_unapproved_current_user_registered.png](media://b083beee-930f-4f8c-bbbd-691529a9a4a2) > ✅ An important concept behind the macro is that users can define the approval process by simply adding themselves as an approver. #### Pages are approved when all the registered approvers mark the page as approved ![padc_onpage_approved_oneuser.png](media://7a1f4729-7bb9-4c2d-8c0e-aae1d01bf30e) - A page is marked as '**unapproved**' until all the people on the approval list have approved it #### Pages with registered approvers display the list of people who have registered as approvers ![padc_onpage_extract_notapproved_twoapprovers_onedecision.png](media://16b2f594-9d15-4a98-9716-a10774176f97) - The current user approval decision status is displayed #### Viewing the last approved version ![padc_onpage_extract_notapproved_linktolastapprovedversion.png](media://e6f83f53-9f80-44d4-bae6-bbdafb8aaa0d) - Users who view a page that is not approved can easily navigate to the last approved version by clicking on the relevant link #### Approvers can unregister themselves without affecting the approval status of documents they approved in the past - However, this can affect the approval state of pages that are currently unapproved (i.e., if the user removes themselves from a page where they were the only person left to approve the page, then the page would be approved #### If a page is changed after it was approved, the approval (and acknowledged) status is reset to blank for all users - In general, if there is a new version of the page, the approval status is reset For example, the following scenarios lead to the approval status being reset: - The page attachments are changed - The approved page is moved to another space or reordered in the same space - The macro structure of the page is edited - A new macro is added to the page - The macro configuration is edited - An additional approver or approval is added to the page > 📝 #### The use of dynamic macros makes page approval impossible because the content of the dynamic data can change at any time > 📝 > 📝 - The page approval macro does not allow pages with unknown macros to be approved ## Acknowledgements > ℹī¸ Acknowledgements are a good way to ensure that particular users have indicated they have checked the page, even if they are not approvers. ![padc_onpage_unapproved_withregisteroption_approval_and_acknowledger.png](media://ec8ab686-6025-483d-b952-aab592993427) You can use the **Acknowledgers option**, for example, to add team members as acknowledgers so that the team leader knows a page has been read; however, only the team leader has the authority to approve the page. ### Key features A user can - Mark the page as **acknowledged** if the **showAcknowledgement** parameter is specified in the macro parameters or in the space or global level settings - Register themselves as acknowledgers in the same manner as approvers, by choosing the **Register** button under the **Acknowledgers** table The **Acknowledgers** table can be hidden if it is taking up too much room by clicking on the **Hide Acknowledgers** link > 📝 When the acknowledgers are hidden, this link becomes **Show Acknowledgers** to show this table again. > 📝 > 📝 This setting is not remembered but can be set as a parameter - see the **acknowledgersVisible** parameter on the [Page Approval](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2213905904) page. ## Other Features - An administrator can **Unregister** any user as an approver or an acknowledger - **Notifications** can be set up such that users are notified (by email) of changes in the approval state of a page ![padc_macroeditor_extract_notifications.png](media://51e521e6-1844-4040-9d69-985c77c833dc) - **Expiry** can be set as an expiry period or as a recurring expiry on a month or day ![padc_macroeditor_extract_recurring_expirysetting_30Decemeber.png](media://c2a42a2d-6221-48de-a241-a59c0edb49b1) ## More Page Approval Settings Please also consult the following pages. - [https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214757481](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214757481) - [https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214854958](https://appfire.atlassian.net/wiki/spaces/PAFS/pages/2214854958) ### Setting up notifications You can add the macro to a page as Confluence wiki markup. The following sets up notifications for the macro on a page: - For all registered users to be notified of all changes ``` {pageapproval:notifiedusers=all|notifyapprovals=true|notifyacknowledgements=true|notifiedactions=change} ``` - To all registered users to be notified if a page has been approved or unapproved, but not on acknowledgement actions ``` {pageapproval:notifiedusers=all|notifyapprovals=true|notifyacknowledgements=false|notifiedactions=change} ``` - To only those users who have approved a page if the page is unapproved ``` {pageapproval:notifiedusers=approved|notifyapprovals=true|notifiedactions=unapproval} ```