Page Approval Usage
View a printable version of the current page.

pageapproval macro

Parameter Required Default Options Description Example
users 0ptional none A comma separated list of names A list of users who will be added as approvers. This is a comma separated list of user names. {pageapproval:users=admin, msmith, bob brown}
acknowledgers 0ptional none A comma separated list of names A list of users who will be added as acknowledgers. This is a comma separated list of user names. {pageapproval:acknowledgers=admin, msmith, bob brown}
chain Optional (must have users defined)
no
yes/no
Enforces an ordered list of approvals. The approvals are done in the order of the users that are defined by the users option.
{pageapproval:chain=yes|users=bob, jane, frank}
notifiedusers Optional (must have notifiedactions defined)
none (or as per administration configuration) all,unapproved,approved
  •  all - Notify all users
  • unapproved  - Notify registered users who have not approved the page.
  • approved - notify users who have approve d the page
{pageapproval:notifiedusers=all|notifiedactions=change}
notifiedactions Optional(must have notifiedusers defined) none (or as per administration configuration) change,unapproval,approval
  •  change - Notify of any change
  • unapproval - Notify when the page is unapproved
  • approval - Notify when the page is approved
{pageapproval:notifiedusers-approved|notifiedactions=unapproval}
showAcknowledgement Optional no (configurable) none Creates an option such that users can acknowledge a page. Users who acknowlege a page are added to an acknowledgement list. {pageapproval:showAcknowledgment}
allowmacros Optional no a comma separated list of macro names 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. {pageapproval:allowmacros=rsvp,contentbylabel}
expireafter Optional none A number and time word, such as '72 hours', '1 day', '6 months' or '1 year'. Time periods allowed are year, month, day, hour. 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. {pageapproval:expireafter=2 months}
expirymonth Optional none A number (1-12). The month when the approval of this page will expire. Specifies a fixed, recuring month when the page will expire. Can be used in conjuction with expiryday {pageapproval:expirymonth=12|expiryday=30}- page approval expires every year on December 30th.{pageapproval:expirymonth=11}- page expires every year on the first day of November
expiryday Optional none A number (1-31). The day when the approval of this page will expire. Specifies a fixed, recuring day of the month when the page will expire. Can be used in conjuction with expirymonth to define a particular day in a year. Note that the behaviour of days 29, 30 and 31 is undefined, so please don't use them. {pageapproval:expiryday=2}- page approval expires every mont on the second day of the month

pageapproval-report macro

Parameter Required Default Options Description Example
show 0ptional user all - Show all pages or user - show only pages with the current user registered as an approver Shows a list of all the page in the current space that are using the {pageapproval} macro {pageapproval:show=all}
Added by James Matheson, last edited by James Matheson on May 05, 2008
Labels: 
(None)

DEMONSTRATION LICENSE - This Confluence site is for demonstration purposes only. Evaluate Confluence today.
Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.8 Build:#814 Oct 02, 2007) - Bug/feature request - Contact Administrators