Page Approval
Description
Add the page approval functionality to a page.
Parameters
Name | Required | Migratable to Cloud? | Default Value | Description |
---|---|---|---|---|
Users |
|
| none | A list of users who will be added as approvers. Start typing a name in the this box to search for a user. |
Approval Group(s) |
|
| none | A comma separated list of user groups. The users of the specified group(s) will be added to the list of users who are registered to approve the page. Users can not remove themselves from the list. Note that notifications are NOT generated immediately when users are added or removed from a group. |
Acknowledgers |
|
| none | A list of users who will be added as acknowledgers. This is a comma separated list of case-sensitive user names. For more information about acknowledgments refer to this section in the admin guide. |
Acknowledgement Group(s) |
|
| The users of the specified group(s) will be added to the list of users who are registered to acknowledge the page. Users can not remove themselves from the list. Note that notifications are NOT generated immediately when users are added or removed from a group. For more information about acknowledgments refer to this section in the admin guide. | |
Quorum |
|
| Number of approvers required before approval achieved. | |
Notified Users |
|
| none |
Options are |
Notified Actions |
|
| none |
Options are |
Notify Approvals |
|
| false | Notify on approval events. |
Notify Acknowledgements |
|
| false | Notify on acknowledgement events. |
Chain |
|
| no | Enforces an ordered list of approvals. The approvals are done in the order of the users that are defined by the users option. Options are |
Allow Acknowledgers |
|
| none | Creates an option such that users can acknowledge a page. Users who acknowledge a page are added to an acknowledgement list. Options not required. For more information about acknowledgments refer to this section in the admin guide. |
Show Role |
|
| Shows a comment box where users can enter their role in the approval process. Note that if the showrole parameter has been configured to be true by default, then the hiderole parameter can be used to turn off comments. | |
Show Comment |
|
| Shows a comment box where users can make comments about why they approved or unapproved a page. Note that if the showcomment parameter has been configured to be true by default, then the hidecomment parameter can be used to turn off comments. | |
Acknowledgers Visible |
|
| true | Sets whether the acknowledgers section will be visible when the page is loaded. |
Expire After |
|
| none | Specifies a time period, after the page is approved, when the approval will expire. The usage example shows a page that will have it's approve expired 2 months after the page is approved. Options are a number and time word, such as '72 hours', '1 day', '6 months' or '1 year'. Time periods allowed are year, month, day, hour. |
Expiry Month |
|
| none | Specifies a fixed, recurring month when the page will expire. Can be used in conjunction with Options are a number (1-12). The month when the approval of this page will expire. |
Expiry Day |
|
| none | Specifies a fixed, recurring day of the month when the page will expire. Can be used in conjunction with expirymonth to define a particular day in a year. Note that the behavior of days 29, 30 and 31 is undefined, so please don't use them. Options are a number (1-31). The day when the approval of this page will expire. |