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)

none

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

approvalGroup

 (error)

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)

none

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

notifiedusers

 (error)

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.

notifiedactions

 (error)

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.

notifyapprovals

 (error)

false

Notify on approval events.

notifyacknowledgements

 (error)

false

Notify on acknowledgement events.

chain

 (error)

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. 

showAcknowledgement

 (error)

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.

acknowledgersVisible

 (error)

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.

allowmacros

 (error)

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.

expireafter

 (error)

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.

expirymonth

 (error)

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.

expiryday

 (error)

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