Skip to end of metadata
Go to start of metadata

Description

Add the page approval functionality to a page.


Parameters

NameRequiredAvailable InDefault ValueDescription

Users

 (error)

Server

none

A list of users who will be added as approvers. This is a comma separated list of case-sensitive user names. 

Approval Group(s)

 (error)

Server

none

A list of user-groups who will be added as approvers. This is a comma separated list of case-sensitive user-group names.

Acknowledgers

 (error)

Server

none

A list of users who will be added as acknowledgers. This is a comma separated list of case-sensitive user names. 

Acknowledgement Group(s)

 (error)

Server


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.

Quorum

 (error)

Server


Number of approvers required before approval achieved.

Notified Users

 (error)

Server

none

  • all - Notify all users
  • unapproved - Notify registered users who have not approved the page.
  • approved - notify users who have approved the page

Options are all,unapproved,approved. Must have notifiedactions defined.

Notified Actions

 (error)

Server

none

  • change - Notify of any change
  • unapproval - Notify when the page is unapproved
  • approval - Notify when the page is approved

Options are change,unapproval,approval. Must have notifiedusers defined.

Notify Approvals

 (error)

Server

false

Notify on approval events.

Notify Acknowledgements

 (error)

Server

false

Notify on acknowledgement events.

Chain

 (error)

Server

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 yes/no. Must have users defined. 

Show Acknowledgement

 (error)

Server

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.

Show Role

 (error)

Server


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

 (error)

Server


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

 (error)

Server

true

If acknowledgers are active, this determines whether the acknowledgers table is shown or not by default.

Users will still be able to toggle this table on or off, however their setting will not be remembered.

Allow Macros

 (error)

Server

no

Specifies a list of one or more macros that will allowed for page approval.

Normally, dynamic macros will prevent the pageapproval macro from working, so this options gives users a way to work around them. A comma separated list of macro names.

Expire After

 (error)

Server

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

 (error)

Server

none

Specifies a fixed, recurring month when the page will expire. Can be used in conjunction with expiryday.

Options are a number (1-12). The month when the approval of this page will expire.

Expiry Day

 (error)

Server

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.

Tutorial Examples


There is no content with the specified labels

  • No labels